TypeScript 在开发 Node.js 应用程序时非常有帮助。让我们看看如何配置它以获得无缝的开发体验。
设置 TypeScript
首先,我们需要安装 TypeScript。我们可以通过运行以下命令来做到这一点:
npm i-D 打字稿
接下来,我们需要在项目的根目录中创建一个 tsconfig.json 文件。该文件将包含我们项目的 TypeScript 配置。这是我从 Total TypeScript 中挑选的 tsconfig.json 文件的示例,并添加了更多内容(阅读代码并注意注释):
{
“编译器选项”:{
/* 基本选项: */
“esModuleInterop”:true,
“skipLibCheck”:正确,
“目标”:“es2022”,
“allowJs”:正确,
“resolveJsonModule”:true,
"moduleDetection": "强制",
“isolatedModules”:正确,
“verbatimModuleSyntax”:正确,
/* 设置 ~ 作为 src/ 目录的别名 */
"baseUrl": ".",
“路径”:{
"~/*": ["src/*"]
},
/* 严格 */
“严格”:真实,
“noUncheckedIndexedAccess”:true,
“noImplicitOverride”:正确,
/* 如果使用 TypeScript 进行转译: */
“模块”:“NodeNext”,
“outDir”:“距离”,
“源地图”:正确,
/* 并且如果你正在构建一个库: */
“声明”:真实,
/* 并且如果您正在 monorepo 中构建库:*/
“复合”:真实,
“声明映射”:正确,
/* 如果不使用 TypeScript 进行转译: */
“模块”:“保留”,
“noEmit”:正确,
/* 如果你的代码在 DOM 中运行: */
“lib”:[“es2022”,“dom”,“dom.iterable”],
/* 如果你的代码不在 DOM 中运行: */
“lib”:[“es2022”],
},
/* 我正在考虑你所有的代码都在 src/ */
“包括”:[“src / ** / *.ts”]
}
设置构建脚本
接下来,我们需要设置一个构建脚本,将 TypeScript 代码编译为 JavaScript。首先,安装 tsc-alias 来处理我们在 tsconfig.json 文件中定义的别名:
npm i -D tsc-别名
然后,您可以通过将以下脚本添加到我们的 package.json 文件中来添加构建脚本:
{
“脚本”:{
"build": "tsc && tsc 别名"
}
}
设置开发脚本
接下来,我们需要设置一个开发脚本来监视 TypeScript 文件中的更改并重新编译它们。就我个人而言,我喜欢使用 tsx,因为与内置的 TypeScript 观察器或 ts-node 相比,它提供了更快的开发体验。首先,安装 tsx:
npm i -D tsx
然后,您可以通过将以下脚本添加到 package.json 文件来添加 dev 脚本(以便以开发模式启动项目):
{
“脚本”:{
"build": "tsc && tsc 别名",
“dev”:“节点 --import=tsx --watch ./src/index.ts”
}
}
是的,在使用 tsx 开发时不会进行类型检查,但您可以为此运行 npm run build 或将新的类型检查脚本添加到 package.json,并在需要检查类型错误时运行它:
{
“脚本”:{
"build": "tsc && tsc 别名",
"dev": "node --import=tsx --watch ./src/index.ts",
“类型检查”:“tsc --noEmit”
}
}