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

未關閉
#850 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 2 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
52/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
firebase, react, typescript

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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.

主要語言
TypeScript
星號
3.6k
分支
402
平均合併
2 天 3 小時
30 天內合併 PR
26

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

FirebaseExtended/reactfire 的其他 Issue

查看 FirebaseExtended/reactfire 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。