什么 TypeScript 配置产生最接近 Node.js 16 功能的输出？

Posted 2023-03-07

【中文标题】什么 TypeScript 配置产生最接近 Node.js 16 功能的输出？

【英文标题】：What TypeScript configuration produces output closest to Node.js 16 capabilities?

【发布时间】：2021-07-26 00:48:42

【问题描述】：

Node.js 16 最近发布，带来了对 ES2021 的更新支持和对 ES 模块的稳定支持，如何配置 TypeScript 以输出利用所有这些新功能的 javascript 代码？

【参考方案1】：

从 Node.js 16.0.0 开始，100% 支持 ES2021，并且对 ES Modules 的支持稳定！如果您知道您的目标是该版本或更高版本，则最佳配置如下所示：

"module": "ES2020" & "moduleResolution": "node"

Node.js 16 支持加载模块而不是旧的 CommonJS 格式，我们必须告诉 TypeScript 我们正在使用 Node.js 的规则来解析模块。

"allowSyntheticDefaultImports": true

为了提供向后兼容性，Node.js 允许您使用默认导入来导入 CommonJS 包。这个标志告诉 TypeScript 可以在 CommonJS 模块上使用 import。

"target": "ES2021"

这告诉 TypeScript 可以输出带有 ES2021 特性的 JavaScript 语法。在实践中，这意味着它将例如输出逻辑赋值运算符和 async/await 语法，而不是嵌入 polyfill。

"lib": ["ES2021"]

这告诉 TypeScript 可以使用 ES2021 或更早版本中引入的函数和属性。在实践中，这意味着您可以使用例如Promise.any 和 String.prototype.replaceAll。

完整的配置将是：

  "compilerOptions": 
    "allowSyntheticDefaultImports": true,
    "lib": ["ES2021"],
    "module": "ES2020",
    "moduleResolution": "node",
    "target": "ES2021"
  

除此之外，我们还需要告诉 Node.js 将此项目中的.js 文件视为 ES Modules。原因是 Node.js 必须保持与为旧 Node.js 版本编写的代码的向后兼容性。这可以通过将"type": "module" 添加到您的package.json 来完成：

  "type": "module"

如果您来自较早版本的 Node.js，另一个变化是 the file extensions when importing files are now mandatory。这意味着您必须在本地导入的末尾写出.js。请注意，这是 .js，即使您正在导入一个实际上具有文件扩展名 .ts 的 TypeScript 文件。这可能看起来有点令人困惑，但this comment from one of the TS contributors explains why that is。

以下是一些如何编写import 语句的示例：

// Built-in Node.js modules
import  readFileSync  from 'fs'

// CommonJS packages from Npm
import md5File from 'md5-file'

// The local file "a.ts"
import  a  from './a.js'

---

如果你现在想坚持使用 CommonJS，为了避免上面解释的警告，你可以使用以下配置：

  "compilerOptions": 
    "lib": ["ES2021"],
    "module": "CommonJS",
    "target": "ES2021"
  

---

如果你运行的是 Node.js 14，你可以看到我的similar answer for Node.js 14 here

如果你运行的是 Node.js 12，你可以看到我的similar answer for Node.js 12 here

如果你运行的是 Node.js 10，你可以看到我的similar answer for Node.js 10 here

如果你运行的是 Node.js 8，你可以看到我的similar answer for Node.js 8 here

【讨论】：

两个重要提示：如果您的构建文件与源文件位于不同的文件夹中，您可能需要在构建文件中包含package.json。此外，您可以使用experimental-specifier-resolution=node 来避免使用显式文件扩展名导入 (.js)