@coderrob/eslint-plugin-零容忍

无魔法数 允许在命名常数中进行算术,例如 const SOMETHING = 10 * 100;。 。 。 .

行为安全合同 记录正负输入、参数边界、状态隔离和需要人工迁移的情况.

规则套房需要非空有效而无效的固定装置,命名为 should 病例、明确的诊断和混凝土自动固定输出。 所有83个规则也都与共享的TypeScript,JSX,可选访问,以及捷克链剖析固定装置相对抗. 见 贡献指南 用于验证要求.

严格,有意见的ESLint插件用于TypeScript,执行类型安全,代码质量,测试标准,以及可维护的模式——除零例外.

特征

• 83个定制ESLint规则 包括8个类别:类型安全、代码质量、测试、进口、错误处理、防虫、命名公约和文件
• 两个预设 —— 说 recommended 通常采用警告严重性来逐步收养,同时 strict 一般使用出错严重性;以下列出严格例外和选入例外
• ESLint 8.57+, 9.x,和 10.x ——平面布局和遗产 .eslintrc 两者均获得支持
• 99xx测试覆盖率 ——每条规则都通过有效案件和无效案件进行彻底检验
• 与 @typescript-eslint/utils 用于完整类型脚本 AST 支持

所需资源

• 节点.js
  • 18.1.8.0+ 当使用ESLint 8.5.7.0+或9.x时
  • 20.19.0+, 22.13.0+,或 24.0.0+ 当使用ESLint 10.x时
  • 经测试的LTS释放:18.20.8、20.20.2、22.23.4、24.22.2和26.13.0
• ESLint 8.57.0+, 9.x, 或 10.x
  • CI测试的主要释放:8.57.1、9.39.5和10.14.0
• @typescript-eslint/parser 8.x 电话
• 类型脚本 5.x

安装

npm install --save-dev @coderrob/eslint-plugin-zero-tolerance @typescript-eslint/parser

快速启动

ESLint 9+ (Flat Config) (中文(简体) )

// eslint.config.js
import zeroTolerance from '@coderrob/eslint-plugin-zero-tolerance';

export default [zeroTolerance.configs.recommended];

ESLint 8.x (法语:Legacy Config)

// .eslintrc.js
module.exports = {
  plugins: ['@coderrob/zero-tolerance'],
  extends: ['plugin:@coderrob/zero-tolerance/legacy-recommended'],
};

遗留 ESLint 通过 @coderrob/zero-tolerance 简称,所以 手动选择遗留规则 ID 使用 @coderrob/zero-tolerance/<rule-name>。平面配置继续 用于使用 zero-tolerance 以下显示名称空间 .

自定义规则选择

// eslint.config.js
import zeroTolerance from '@coderrob/eslint-plugin-zero-tolerance';

export default [
  {
    plugins: {
      'zero-tolerance': zeroTolerance,
    },
    rules: {
      'zero-tolerance/require-interface-prefix': 'error',
      'zero-tolerance/no-throw-literal': 'error',
      'zero-tolerance/max-function-lines': ['warn', { max: 40 }],
    },
  },
];

预设

预设断裂描述启用规则的默认值 . prefer-result-return 严格,而 require-bdd-spec, (中文(简体) ), require-jsdoc-anonymous-functions, (中文(简体) ), no-fetch-in-tests, (中文(简体) ), no-parent-internal-access,以及 no-restricted-imports-in-tests 继续选择两个预设。 见 完整规则文档 每个规则的预设状态.

规则

命名公约

文档

测试

类型安全

代码质量

处理错误

进口

no-parent-internal-access 仍然选择使用,并且只匹配在 .. 横行,例如 ../src/foo。 。 。 .

防止错误

文档

附有实例的完整规则文件,见:

https://coderrob.github.io/eslint-config-0-容忍主义/

选择检查

使用 规则参考 以选择检查和审查实例、选项和限制。 启用 需要 - 错误 - 因为 单独保留原有例外.

关于承诺处理、不安全类型、回调和分支限制,参见 额外编码质量检查。 。 。 .

许可证

Apache 2.0 (英语) 版权:罗伯特·林德利