`index.d.cts` makes CommonJS TypeScript projects using `module: node16` fail with TS1479

Offen
  • Stimmt etwas nicht?
#850 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
52/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
firebase, react, typescript
Bereich
backend-api-design, build-system

Rechercherichtung

Start by reading the build:types-cjs script and comparing dist/index.d.ts with dist/index.d.cts; the issue says the latter is copied from the former. Reproduce the TS1479 errors with module and moduleResolution set to node16 and skipLibCheck: false, then inspect the local declaration re-exports. Done means the CommonJS TypeScript project can type-check its reactfire import without those errors.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug

A CommonJS TypeScript project that uses module: node16 and skipLibCheck: false cannot type-check an import of reactfire. I found this while reviewing #838, and it is already true on main.

What happens
  • tsc reports TS1479 on every line of node_modules/reactfire/dist/index.d.cts that imports or re-exports a local file: "The current file is a CommonJS module whose imports will produce 'require' calls; however, the referenced file is an ECMAScript module and cannot be imported with 'require'."
  • I got 11 of these on main and 12 on #838's head, where the extra one is the new ./utils.js re-export.
  • With skipLibCheck: true the errors go away and the imported types still resolve correctly, so projects with that setting are not affected.
  • attw reports all four resolution modes green, so the CI "Verify package" job does not catch it.
Steps to reproduce
  • Create a project with no "type" field in its package.json and a tsconfig.json with module and moduleResolution set to node16, skipLibCheck: false.
  • Install reactfire (I used a tarball packed from main at eb3376a), firebase 13.1.0 and React 19.
  • Import useUser from reactfire in a .ts file and run tsc.
Cause, as far as I can tell
  • The build:types-cjs script copies dist/index.d.ts to dist/index.d.cts, so the two files are identical.
  • The .d.cts file is treated as CommonJS, but it re-exports from ./auth.js and the other per-module declarations, which sit in a "type": "module" package and are therefore ESM.

I have not tried a fix. If emitting real CommonJS declarations is more than this is worth, documenting skipLibCheck: true for CommonJS projects may be enough.

Vorherrschende Sprache
TypeScript
Sterne
3.6k
Forks
402
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
26

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus FirebaseExtended/reactfire

Alle Issues in FirebaseExtended/reactfire

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

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