microsoft / microsoft/TypeScript

strange interaction with `resolveJsonModule`, `createRequire`, naming it `require`, and requiring JSON

Ouverte
#61,292 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Bug Domain: Node ESM Help Wanted Needs Human Review Needs More Info
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

### 🔎 Search Terms

esm resolveJsonModule

### 🕗 Version & Regression Information

This isn't reproducible in the playground because the TSConfig editor, unlike in reality, doesn't allow you to configure `resolveJsonModule` when module is NodeNext.

### ⏯ Playground Link

n/a

### 💻 Code

Here's my config:
```
{
"extends": "@ljharb/tsconfig", // this sets resolveJsonModule to true
"compilerOptions": {
"target": "ESNext",
"module": "NodeNext",
"moduleResolution": "NodeNext",
},
"exclude": [
"coverage",
],
}
```

`@ljharb/tsconfig` sets `resolveJsonModule` to `true`.

Here's my code:
```
import { createRequire } from 'module';

const require = createRequire(import.meta.url);

require('./package.json');
```

### 🙁 Actual behavior

When `resolveJsonModule` is locally omitted or set to `true`, I get `error TS6133: 'require' is declared but its value is never read.` on the `const require =` declaration.

When it's locally set to `false`, I get that error AND `error TS2732: Cannot find module '../package.json'. Consider using '--resolveJsonModule' to import module with '.json' extension.` on the `require()` call.

However, when I rename it from `require` to literally anything else, the errors disappear for all three config variations.

### 🙂 Expected behavior

I should be able to name a variable `require` in an ES Module without it having any implied semantics, since `require` only exists by default in CJS.

### Additional information about the issue

_No response_

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez avec la configuration NodeNext fournie et le code qui utilise createRequire(import.meta.url), puis reproduisez les diagnostics en omettant, en activant et en désactivant resolveJsonModule. Comparez ces résultats avec ceux du même code après avoir renommé la variable require locale ; le travail est terminé lorsque le nom de la variable ne modifie plus les diagnostics de variable inutilisée ou de module JSON dans un module ES.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.