microsoft / microsoft/TypeScript

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

Offen
#61,292 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bug Domain: Node ESM Help Wanted Needs Human Review Needs More Info
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

### 🔎 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_

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der bereitgestellten NodeNext-Konfiguration und dem Code, der createRequire(import.meta.url) verwendet, und reproduzieren Sie die Diagnosen, wobei resolveJsonModule weggelassen, aktiviert und deaktiviert wird. Vergleichen Sie diese Ergebnisse mit demselben Code, nachdem Sie die lokale require-Variable umbenannt haben; abgeschlossen ist die Aufgabe, wenn der Variablenname die Diagnosen für unbenutzte Variablen oder JSON-Module in einem ES-Modul nicht mehr verändert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.