https://github.com/fish-node/template-node-ts

  1. mkdir ts-api
  2. cd ts-api
  3. npm init -y
  4. tsc -init

修改tsconfig.json

设置include,exclude,outDir属性,做好最基本的配置。
文档: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html

  1. {
  2. "compilerOptions": {
  3. "target": "es3",
  4. "module": "commonjs",
  5. "outDir": "./target",
  6. "rootDir": "./src",
  7. "strict": true,
  8. "moduleResolution": "node",
  9. "esModuleInterop": true,
  10. "experimentalDecorators": true
  11. },
  12. "include": [
  13. "src/**/*"
  14. ],
  15. "exclude": [
  16. "node_modules",
  17. "**/*.spec.ts"
  18. ]
  19. }

安装TypeScript

  1. yarn add ts-node ts-node-dev tsconfig-paths typescript --dev

ESLint

  1. yarn add eslint typescript-eslint-parser eslint-plugin-typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin --dev

.eslintrc.json

  1. {
  2. "env": {
  3. "node": true
  4. },
  5. "extends": "eslint:recommended",
  6. "parser": "@typescript-eslint/parser",
  7. "plugins": ["@typescript-eslint"],
  8. "rules": {
  9. "no-alert": 0, //禁止使用alert confirm prompt
  10. "no-array-constructor": 2, //禁止使用数组构造器
  11. "no-bitwise": 0, //禁止使用按位运算符
  12. "no-caller": 1, //禁止使用arguments.caller或arguments.callee
  13. "no-catch-shadow": 2, //禁止catch子句参数与外部作用域变量同名
  14. "no-class-assign": 2, //禁止给类赋值
  15. "no-cond-assign": 2, //禁止在条件表达式中使用赋值语句
  16. "no-console": 2, //禁止使用console
  17. "no-const-assign": 2, //禁止修改const声明的变量
  18. "no-constant-condition": 2, //禁止在条件中使用常量表达式 if(true) if(1)
  19. "no-continue": 0, //禁止使用continue
  20. "no-control-regex": 2, //禁止在正则表达式中使用控制字符
  21. "no-debugger": 2, //禁止使用debugger
  22. "no-delete-var": 2, //不能对var声明的变量使用delete操作符
  23. "no-div-regex": 1, //不能使用看起来像除法的正则表达式/=foo/
  24. "no-dupe-keys": 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
  25. "no-dupe-args": 2, //函数参数不能重复
  26. "no-duplicate-case": 2, //switch中的case标签不能重复
  27. "no-else-return": 2, //如果if语句里面有return,后面不能跟else语句
  28. "no-empty": 2, //块语句中的内容不能为空
  29. "no-empty-character-class": 2, //正则表达式中的[]内容不能为空
  30. "no-empty-label": 2, //禁止使用空label
  31. "no-eq-null": 2, //禁止对null使用==或!=运算符
  32. "no-eval": 1, //禁止使用eval
  33. "no-ex-assign": 2, //禁止给catch语句中的异常参数赋值
  34. "no-extend-native": 2, //禁止扩展native对象
  35. "no-extra-bind": 2, //禁止不必要的函数绑定
  36. "no-extra-boolean-cast": 2, //禁止不必要的bool转换
  37. "no-extra-parens": 2, //禁止非必要的括号
  38. "no-extra-semi": 2, //禁止多余的冒号
  39. "no-fallthrough": 1, //禁止switch穿透
  40. "no-floating-decimal": 2, //禁止省略浮点数中的0 .5 3.
  41. "no-func-assign": 2, //禁止重复的函数声明
  42. "no-implicit-coercion": 1, //禁止隐式转换
  43. "no-implied-eval": 2, //禁止使用隐式eval
  44. "no-inline-comments": 0, //禁止行内备注
  45. "no-inner-declarations": [2, "functions"], //禁止在块语句中使用声明(变量或函数)
  46. "no-invalid-regexp": 2, //禁止无效的正则表达式
  47. "no-invalid-this": 2, //禁止无效的this,只能用在构造器,类,对象字面量
  48. "no-irregular-whitespace": 2, //不能有不规则的空格
  49. "no-iterator": 2, //禁止使用__iterator__ 属性
  50. "no-label-var": 2, //label名不能与var声明的变量名相同
  51. "no-labels": 2, //禁止标签声明
  52. "no-lone-blocks": 2, //禁止不必要的嵌套块
  53. "no-lonely-if": 2, //禁止else语句内只有if语句
  54. "no-loop-func": 1, //禁止在循环中使用函数(如果没有引用外部变量不形成闭包就可以)
  55. "no-mixed-requires": [0, false], //声明时不能混用声明类型
  56. "no-mixed-spaces-and-tabs": [2, false], //禁止混用tab和空格
  57. "linebreak-style": [0, "windows"], //换行风格
  58. "no-multi-spaces": 1, //不能用多余的空格
  59. "no-multi-str": 2, //字符串不能用\换行
  60. "no-multiple-empty-lines": [1, {
  61. "max": 2
  62. }], //空行最多不能超过2行
  63. "no-native-reassign": 2, //不能重写native对象
  64. "no-negated-in-lhs": 2, //in 操作符的左边不能有!
  65. "no-nested-ternary": 0, //禁止使用嵌套的三目运算
  66. "no-new": 1, //禁止在使用new构造一个实例后不赋值
  67. "no-new-func": 1, //禁止使用new Function
  68. "no-new-object": 2, //禁止使用new Object()
  69. "no-new-require": 2, //禁止使用new require
  70. "no-new-wrappers": 2, //禁止使用new创建包装实例,new String new Boolean new Number
  71. "no-obj-calls": 2, //不能调用内置的全局对象,比如Math() JSON()
  72. "no-octal": 2, //禁止使用八进制数字
  73. "no-octal-escape": 2, //禁止使用八进制转义序列
  74. "no-param-reassign": 2, //禁止给参数重新赋值
  75. "no-path-concat": 0, //node中不能使用__dirname或__filename做路径拼接
  76. "no-plusplus": 0, //禁止使用++,--
  77. "no-process-env": 0, //禁止使用process.env
  78. "no-process-exit": 0, //禁止使用process.exit()
  79. "no-proto": 2, //禁止使用__proto__属性
  80. "no-redeclare": 2, //禁止重复声明变量
  81. "no-regex-spaces": 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
  82. "no-restricted-modules": 0, //如果禁用了指定模块,使用就会报错
  83. "no-return-assign": 1, //return 语句中不能有赋值表达式
  84. "no-script-url": 0, //禁止使用javascript:void(0)
  85. "no-self-compare": 2, //不能比较自身
  86. "no-sequences": 0, //禁止使用逗号运算符
  87. "no-shadow": 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
  88. "no-shadow-restricted-names": 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
  89. "no-spaced-func": 2, //函数调用时 函数名与()之间不能有空格
  90. "no-sparse-arrays": 2, //禁止稀疏数组, [1,,2]
  91. "no-sync": 0, //nodejs 禁止同步方法
  92. "no-ternary": 0, //禁止使用三目运算符
  93. "no-trailing-spaces": 1, //一行结束后面不要有空格
  94. "no-this-before-super": 0, //在调用super()之前不能使用this或super
  95. "no-throw-literal": 2, //禁止抛出字面量错误 throw "error";
  96. "no-undef": 1, //不能有未定义的变量
  97. "no-undef-init": 2, //变量初始化时不能直接给它赋值为undefined
  98. "no-undefined": 2, //不能使用undefined
  99. "no-unexpected-multiline": 2, //避免多行表达式
  100. "no-underscore-dangle": 1, //标识符不能以_开头或结尾
  101. "no-unneeded-ternary": 2, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
  102. "no-unreachable": 2, //不能有无法执行的代码
  103. "no-unused-expressions": 2, //禁止无用的表达式
  104. "no-unused-vars": [2, {
  105. "vars": "all",
  106. "args": "after-used"
  107. }], //不能有声明后未被使用的变量或参数
  108. "no-use-before-define": 2, //未定义前不能使用
  109. "no-useless-call": 2, //禁止不必要的call和apply
  110. "no-void": 2, //禁用void操作符
  111. "no-var": 0, //禁用var,用let和const代替
  112. "no-warning-comments": [1, {
  113. "terms": ["todo", "fixme", "xxx"],
  114. "location": "start"
  115. }], //不能有警告备注
  116. "no-with": 2, //禁用with
  117. "array-bracket-spacing": [2, "never"], //是否允许非空数组里面有多余的空格
  118. "arrow-parens": 0, //箭头函数用小括号括起来
  119. "arrow-spacing": 0, //=>的前/后括号
  120. "accessor-pairs": 0, //在对象中使用getter/setter
  121. "block-scoped-var": 0, //块语句中使用var
  122. "brace-style": [1, "1tbs"], //大括号风格
  123. "callback-return": 1, //避免多次调用回调什么的
  124. "camelcase": 2, //强制驼峰法命名
  125. "comma-dangle": [2, "never"], //对象字面量项尾不能有逗号
  126. "comma-spacing": 0, //逗号前后的空格
  127. "comma-style": [2, "last"], //逗号风格,换行时在行首还是行尾
  128. "complexity": [0, 11], //循环复杂度
  129. "computed-property-spacing": [0, "never"], //是否允许计算后的键名什么的
  130. "consistent-return": 0, //return 后面是否允许省略
  131. "consistent-this": [2, "that"], //this别名
  132. "constructor-super": 0, //非派生类不能调用super,派生类必须调用super
  133. "curly": [2, "all"], //必须使用 if(){} 中的{}
  134. "default-case": 2, //switch语句最后必须有default
  135. "dot-location": 0, //对象访问符的位置,换行的时候在行首还是行尾
  136. "dot-notation": [0, {
  137. "allowKeywords": true
  138. }], //避免不必要的方括号
  139. "eol-last": 0, //文件以单一的换行符结束
  140. "eqeqeq": 2, //必须使用全等
  141. "func-names": 0, //函数表达式必须有名字
  142. "func-style": [0, "declaration"], //函数风格,规定只能使用函数声明/函数表达式
  143. "generator-star-spacing": 0, //生成器函数*的前后空格
  144. "guard-for-in": 0, //for in循环要用if语句过滤
  145. "handle-callback-err": 0, //nodejs 处理错误
  146. "id-length": 0, //变量名长度
  147. "indent": [2, 4], //缩进风格
  148. "init-declarations": 0, //声明时必须赋初值
  149. "key-spacing": [0, {
  150. "beforeColon": false,
  151. "afterColon": true
  152. }], //对象字面量中冒号的前后空格
  153. "lines-around-comment": 0, //行前/行后备注
  154. "max-depth": [0, 4], //嵌套块深度
  155. "max-len": [0, 80, 4], //字符串最大长度
  156. "max-nested-callbacks": [0, 2], //回调嵌套深度
  157. "max-params": [0, 3], //函数最多只能有3个参数
  158. "max-statements": [0, 10], //函数内最多有几个声明
  159. "new-cap": 2, //函数名首行大写必须使用new方式调用,首行小写必须用不带new方式调用
  160. "new-parens": 2, //new时必须加小括号
  161. "newline-after-var": 2, //变量声明后是否需要空一行
  162. "object-curly-spacing": [0, "never"], //大括号内是否允许不必要的空格
  163. "object-shorthand": 0, //强制对象字面量缩写语法
  164. "one-var": 1, //连续声明
  165. "operator-assignment": [0, "always"], //赋值运算符 += -=什么的
  166. "operator-linebreak": [2, "after"], //换行时运算符在行尾还是行首
  167. "padded-blocks": 0, //块语句内行首行尾是否要空行
  168. "prefer-const": 0, //首选const
  169. "prefer-spread": 0, //首选展开运算
  170. "prefer-reflect": 0, //首选Reflect的方法
  171. "quotes": [1, "single"], //引号类型 `` "" ''
  172. "quote-props": [2, "always"], //对象字面量中的属性名是否强制双引号
  173. "radix": 2, //parseInt必须指定第二个参数
  174. "id-match": 0, //命名检测
  175. "require-yield": 0, //生成器函数必须有yield
  176. "semi": [2, "always"], //语句强制分号结尾
  177. "semi-spacing": [0, {
  178. "before": false,
  179. "after": true
  180. }], //分号前后空格
  181. "sort-vars": 0, //变量声明时排序
  182. "space-after-keywords": [0, "always"], //关键字后面是否要空一格
  183. "space-before-blocks": [0, "always"], //不以新行开始的块{前面要不要有空格
  184. "space-before-function-paren": [0, "always"], //函数定义时括号前面要不要有空格
  185. "space-in-parens": [0, "never"], //小括号里面要不要有空格
  186. "space-infix-ops": 0, //中缀操作符周围要不要有空格
  187. "space-return-throw-case": 2, //return throw case后面要不要加空格
  188. "space-unary-ops": [0, {
  189. "words": true,
  190. "nonwords": false
  191. }], //一元运算符的前/后要不要加空格
  192. "spaced-comment": 0, //注释风格要不要有空格什么的
  193. "strict": 2, //使用严格模式
  194. "use-isnan": 2, //禁止比较时使用NaN,只能用isNaN()
  195. "valid-jsdoc": 0, //jsdoc规则
  196. "valid-typeof": 2, //必须使用合法的typeof的值
  197. "vars-on-top": 2, //var必须放在作用域顶部
  198. "wrap-iife": [2, "inside"], //立即执行函数表达式的小括号风格
  199. "wrap-regex": 0, //正则表达式字面量用小括号包起来
  200. "yoda": [2, "never"] //禁止尤达条件
  201. }
  202. }

Jest

  1. yarn add --dev @types/jest jest supertest ts-jest

安装node库

  1. yarn add @types/node --dev
  2. yarn add @types/express express --dev

app.ts

  1. import * as http from 'http';
  2. const serve = http.createServer((req, res) => {
  3. res.end('Hello Node');
  4. });
  5. serve.listen(3000, () => {
  6. console.log('服务已启动');
  7. });
文档更新时间: 2019-11-08 08:15