配置TS + node 的开发环境

2024年5月25日 172次阅读 来源: fishBugs

直接配置ts的开发环境还是挺麻烦的，这里我总结了一套开发模板，可以在用的时候可以考虑直接clone这个项目，
项目地址https://github.com/fish-node/…
以这个项目 为基础模板来开发就行。

$ tree
.
├── README.md
├── jest.config.js
├── package.json
├── src
│   ├── index.ts
│   ├── math.ts
│   └── server.ts
├── test
│   ├── math.test.ts
│   └── server.test.ts
├── tsconfig.json
└── tslint.json

ts-node

因为ts是建立在js的基础之上的，但是node又不能直接运行ts代码，实际使用是往往需要使用tsc将ts代码编译成js代码，这无疑是很麻烦的。

而ts-node则包装了node，它可以直接的运行ts代码，使用起来很方便，它的官方仓库在这里 https://github.com/TypeStrong… ,基本用法请自行查看它的readme。

我这里就是把ts-node写到package.json，大家在npm install之后，就可以通过

$ npx ts-node src/index.ts

这种方式来运行ts代码，很方便。

然后我们知道node中有个nodemon，可以在开发时自动的重启我们的node程序，而在ts-node中，对应的就是ts-node-dev

$ npx ts-node-dev src/index.ts

示例代码

在src目录下，我写了三个基本的ts代码

  • math.ts就是最基本的ts的用法
  • 然后server.js展示了如何使用ts编写一个http服务器
  • index.ts则展示了ts中的模块化的使用

测试框架

然后我使用Jest 作为测试框架，在test目录下展示了用Jest + Ts 编写我们的测试程序。
运行测试文件的话，可以使用

$ npm run test

@types

@types/node @types/jest 是ts中类型声明文件，它可以给js编写的模块赋予类型系统，让我们享受类型系统的好处。

配置文件

  • .editorconfig是我们配置IDE的阅读配置文件
  • tslint.json使我们的代码检查配置文件
    这个文件主要是继承了官方推荐的代码风格。不过为了调试方便，把’no-console’这个条件设置为false了

tsconfig.json

然后重点是我们的ts配置文件。

一般来说，json文件是不支持注释的，但是ts官方为了方便，对这个文件单独做了加强，使得我们可以使用注释，注释语法和js中的一样。

{
    "compilerOptions": {
        "target": "es2018",
        "module": "commonjs",
        "outDir": "./dist/",
        "rootDir": "./src/",
        "strict": true,
        "moduleResolution": "node",
        "esModuleInterop": true,
        "experimentalDecorators": true
    },
    "exclude": ["./test"]
}

其中的target就是编译后js代码的版本，因为我们是node环境，没必要考虑浏览器的兼容问题，所以大家还是尽量的使用更新的版本吧。

而module选项则是我们的模块管理机制，因为我们的ts-node目前还不指出es的模块管理机制，参考这个问题https://github.com/TypeStrong… ，所以我们还是继续使用commonjs规范。

然后rootDir就是我们的源代码目录，outDir就是我们的编译后代码的目录。同时我们设置了exclude这个选项，把我们的测试文件排除在外。

    原文作者：fishBugs
    原文地址: https://segmentfault.com/a/1190000019458509
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞