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

Lin*_*äck 6 node.js typescript

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

Lin*_*äck 22

从 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 可以import在 CommonJS 模块上使用。

  • "target": "ES2021"

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

  • "lib": ["ES2021"]

    这告诉 TypeScript 可以使用ES2021 或更早版本中引入的函数和属性。实际上,这意味着您可以使用 egPromise.anyString.prototype.replaceAll

因此,完整的配置将是:

{
  "compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "lib": ["ES2021"],
    "module": "ES2020",
    "moduleResolution": "node",
    "target": "ES2021"
  }
}
Run Code Online (Sandbox Code Playgroud)

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

{
  "type": "module"
}
Run Code Online (Sandbox Code Playgroud)

如果您来自早期版本的 Node.js,另一个变化是导入文件时的文件扩展名现在是必需的。这意味着您必须.js在本地导入的末尾写出。请注意,.js即使您正在导入实际具有文件扩展名的 TypeScript 文件,也是如此.ts。这似乎有点令人困惑,但来自一位 TS 贡献者的评论解释了为什么会这样

以下是一些如何编写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'
Run Code Online (Sandbox Code Playgroud)

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

{
  "compilerOptions": {
    "lib": ["ES2021"],
    "module": "CommonJS",
    "target": "ES2021"
  }
}
Run Code Online (Sandbox Code Playgroud)

如果您正在运行 Node.js 14,您可以在此处看到我对 Node.js 14 的类似回答

如果您正在运行 Node.js 12,您可以在此处看到我对 Node.js 12 的类似回答

如果您正在运行 Node.js 10,您可以在此处看到我对 Node.js 10 的类似回答

如果你正在运行 Node.js 8 你可以在这里看到我对 Node.js 8 的类似回答

  • @EddieR 询问,你们就会收到!/sf/answers/5066600591/ (3认同)