microsoft / microsoft/TypeScript

Option to use "moduleResolution": "NodeNext" with new "module" value that outputs ESM code

Offen
#56,779 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Needs More Info
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

🔍 Search Terms

esm, nodenext, module, moduleResolution

✅ Viability Checklist
⭐ Suggestion

Right now, when setting "moduleResolution" to "NodeNext", you have to set "module" to "NodeNext"
I wish to have a new module value that is valid with moduleResolution: "NodeNext" but forces TS to output ESM code (aka import/export not require), similar to the output of "module": "ES2020".

📃 Motivating Example

I believe that TS relies on a package.json as a tool, without a way to give him direct instructions (especially when using programmatic APIs), is a problematic design.
TSC as a tool should have a way to get instructions from the user, which are stronger than the pacakge.json values.
I want to have direct control on what I tell tsc to do instead of relying on side effects (package.json).
This was like this until NodeNext, but now it's changed.
Also the module resolution and module shouldn't be so strongly coupled to each other, as they are not really related to each other.

💻 Use Cases

Background:
I'm working on a big OSS tool named Bit.
When using bit, you don't usually have package.json files, as bit generates and manages them for you.
Bit also uses TS programmatically to compile files.
Once I'm setting tsconfig to have:

"compilerOptions": {
    "moduleResolution": "NodeNext",
    "module": "NodeNext"
  },

tsc is looking for a package.json and can't find one, so it will emit CJS output for .ts files.
I was able to overcome it by manipulating the filenameI gave to ts compiler when calling its API See calling to ts transpile module APi [here](https://bit.cloud/teambit/typescript/typescript-compiler/~code/typescript-compiler.ts#l108) And the manipulation of the filename [here](https://bit.cloud/teambit/typescript/typescript-compiler/~code/typescript-compiler.ts#l206) This works just fine when compiling the code. (I saw other tools using this method like thets-jest useESM` option. and others)

However, this introduces 2 issues:

  1. This is a very hacky way to do it, when I just want to "force" ts to compile to ESM (similar to "module": "ES2020") and not based on package.json.
  2. This works fine on compilation, but the IDE for example is not aware for this, which leads to errors such as
The 'import.meta' meta-property is not allowed in files which will build into CommonJS output.ts(1470)

The IDE thinks (correctly from his point of view), that the file will be compiled to CJS, but it's not true.
But I have no way to tell him that it will be compiled to ESM in action.

Right now, my other option is to set tsconfig to have:

"compilerOptions": {
    "moduleResolution": "Node",
    "module": "ES2020"
  },

But this leads to another issue with module resolution.
I believe this resolution issue, is a bug. I have an easy (for me) way to reproduce that resolution issue, but unfortunately, I don't know how to easily reproduce it for someone else, as it requires installing bit and doing some bit actions. it's somehow related to symlinks in the node_modules and so. (I would be glad to show this in a live session and instruct someone how to reproduce it on his machine if he is willing to install bit).

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

Beginne damit, die Verwendung der TypeScript-Compiler-API und die von Bit's typescript-compiler.ts verlinkte Dateinamenmanipulation zu lesen; verfolge anschließend, wie moduleResolution: "NodeNext" und module: "NodeNext" die Ausgabe bestimmen. Eine vollständige Lösung würde eine module-Option bereitstellen, die die NodeNext-Auflösung beibehält und gleichzeitig die ESM-Ausgabe erzwingt, wobei IDE und Compiler dieser Ausgabe zustimmen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
nodejs, typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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