代码检查规则

描述

本包包含了一组针对多种语言、库和框架的 ESLint 配置。目的是确保我的每个个人项目都有一套相同的规则以保持一致性。您也可以将其用于自己的项目。

配置

以下用例存在配置文件，如下简要总结。您可以根据需要混合和匹配这些配置，并且有几个配置会自动继承其他配置。

• javascript - 针对使用 JavaScript 的项目的推荐规则。
• typescript - 针对使用 TypeScript 的项目的推荐规则。
  • 包含并修改了 javascript 的规则，因为 TypeScript 是 JavaScript 的超集。
• angular - 针对使用 Angular 的项目的推荐规则。
  • 包含并修改了 typescript 和 rxjs 的规则，因为 Angular 默认使用 TypeScript 和 RxJS。
• angular-html - 针对使用 Angular 的项目的推荐模板（HTML）规则。
  • 与 @angular-eslint/template-parser 一起使用。
• rxjs - 针对使用 RxJS 库的项目的推荐规则。

安装

从项目的根目录开始，使用以下命令安装包

npm i @hendrickson-tyler/eslint-config --save-dev

Angular 支持

对于 Angular 17 及以上版本，版本号将与 Angular 版本号匹配。

使用方法

安装包后，将所需的配置添加到项目根目录下 eslintrc.json 文件的 "extends" 部分

{
    "root": true,
    "ignorePatterns": [
        "projects/**/*"
    ],
    "overrides": [
        {
            "files": [
                "*.ts"
            ],
            "parserOptions": {
                "project": [
                    "tsconfig.json"
                ],
                "createDefaultProgram": true
            },
            "extends": [
                "@hendrickson-tyler/eslint-config/angular"
            ],
            ...
        }
        ...
    ]
}

之后，您将能够运行所需的代码检查命令以使用新导入的代码检查规则。

注意：强烈建议保持本包的更新。确保您的 package.json 文件中的版本号在版本号前包含一个 ^ 符号，以便在执行 npm update 时更新到最新的次要版本。

示例

"devDependencies": {
    ...
    "@hendrickson-tyler/eslint-config": "^18.0.0",
    ...
}