什么是 tslint-config-flagwind
tslint-config-flagwind 是一个基于 tslint 规则的 TypeScript 编码规范的配置包。它是 Flagwind 团队提供的一套 TypeScript 代码规范配置，可以帮助开发者更有效率的开发。
安装
需求
- TypeScript
- tslint
安装
使用 npm 进行安装:
npm install tslint-config-flagwind --save-dev
使用
在项目根目录下创建 tslint.json 配置文件，并添加 tslint-config-flagwind 配置：
{
"extends": "tslint-config-flagwind",
"rules": {
// 可覆盖 tslint-config-flagwind 中的规则
}
}深度解析
配置规则
tslint-config-flagwind 中设置了一系列的 TypeScript 代码规范，包含如下规则。
- ban: 禁止使用特定的函数或全局函数。
- class-name: 类名使用 PascalCase.
- comment-format: 注释必须符合 JSDoc 注释规范。
- curly: 所有复合语句必须使用花括号包围。
- eofline: 文件必须以单个换行符结束。
- forin: for-in 循环必须使用 hasOwnProperty 限制。
- indent: 必须使用 4 个空格进行代码缩进。
- interface-name: 接口名使用 PascalCase。
- jsdoc-format: JSDoc 注释必须符合规定的格式。
- no-arg: 禁止使用 arguments.caller 和 arguments.callee。
- no-bitwise: 禁止使用位运算符。
- no-console: 禁止使用 console.log。
- no-construct: 禁止直接使用 Object 构造器。
- no-debugger: 禁止使用 debugger。
- no-duplicate-key: 禁止在对象字面量中覆盖重复属性。
- no-duplicate-variable: 禁止在同一作用域内声明重复变量。
- no-empty: 禁止空语句。
- no-eval: 禁止使用 eval 函数。
- no-string-literal: 禁止字面量中的字符串常量未经类型检查。
- no-trailing-whitespace: 禁止行尾空格。
- no-unsafe-finally: 禁止在 finally 中使用控制流语句。
- no-unused-expression: 禁止未使用的表达式。
- no-unused-variable: 禁止未使用的变量。
- no-use-before-declare: 禁止在声明之前使用变量。
- no-var-keyword: 必须使用 let 或者 const 关键字。
- one-variable-per-declaration: 变量声明必须只一次 var、let、const 等。
- prefer-const: 必须使用 const 关键字，如果变量的值被赋值变量，可使用 let 关键字。
- radix: parseInt 函数必须指定第二个参数。
学习意义
tslint-config-flagwind 包含了大量的 TypeScript 代码规范，对于开发者来说，它提供了非常好的代码风格和格式化的参照。使用这个包，可以使团队成员之间的代码风格更加统一，提高代码可读性和可维护性。
示例代码
-- -------------------- ---- -------
----- ------- -
------- -------- ------------- -------
------ ----------- -------
------------- -
----------------- - --------
--------------- - --------
-
------ -------------------- ------- ----- -------- ------- -
----- -------- - ---- - -----
----------------------
------ -----
-
------- ------------------- ------- -
------ ------
-
-
----- ----- - --- ----------
------------------------ ---------来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056ca881e8991b448e6121