配置TS + node 的开发环境

直接配置ts的开发环境仍是挺麻烦的,这里我总结了一套开发模板,能够在用的时候能够考虑直接clone这个项目,
项目地址https://github.com/fish-node/...
以这个项目 为基础模板来开发就行。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代码,这无疑是很麻烦的。git

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

我这里就是把ts-node写到package.json,你们在npm install以后,就能够经过npm

$ npx ts-node src/index.ts

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

而后咱们知道node中有个nodemon,能够在开发时自动的重启咱们的node程序,而在ts-node中,对应的就是ts-node-dev浏览器

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

示例代码

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

  • 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这个选项,把咱们的测试文件排除在外。

相关文章
相关标签/搜索