我们在Prettier，Husky和lint阶段将ESLint上的Angular项目移植

漂亮和ESLint

• 格式化 -将代码带入一个视图：行长，逗号，分号等。
• 代码质量 -搜索有问题的代码模板：不必要的代码，错误。

eslint example.ts --fix

output:
error    This line has a length of 97. Maximum allowed is 80

ESLint设置

安装

• eslint-短绒棉本身
• @ angular-eslint /  builder-使用标准ng lint命令为Angular应用程序运行ESLint的Angular CLI Builder，
• @ angular-eslint / eslint-plugin-  一个包含Angular linting规则的插件，
• @ angular-eslint / template-parser  是一个与角度的/编译器可以编写用于衬砌Angular模板的规则，
• @ angular-eslint / eslint-plugin-template-  一个插件，与@ angular-eslint / template-parser一起使用时，启动用于语言化Angular模板的规则，
• @ typescript-eslint / parser-用于解析TypeScript代码的插件，
• @ typescript-eslint / eslint-plugin-一个运行TypeScript规则以进行掉毛的插件。

ng add @angular-eslint/schematics

配置配置

module.exports = {
  extends: ['plugin:@angular-eslint/recommended'],
  rules: {
    '@angular-eslint/directive-selector': [
      'error',
      { type: 'attribute', prefix: 'app', style: 'camelCase' },
    ],
    '@angular-eslint/component-selector': [
      'error',
      { type: 'element', prefix: 'app', style: 'kebab-case' },
    ],
  },
  overrides: [
    //   ,       *.component.ts
    {
      files: ['*.component.ts'],
      parser: '@typescript-eslint/parser',
      parserOptions: {
        ecmaVersion: 2020,
        sourceType: 'module',
      },
      plugins: ['@angular-eslint/template'],
      processor: '@angular-eslint/template/extract-inline-html',
    },
  ],
};

可以用不同的格式描述配置：JavaScript，JSON或YAML文件。您可以在JavaScript中留下评论。

ng lint命令更新

"lint": {
  "builder": "@angular-eslint/builder:lint",
  "options": {
    "eslintConfig": ".eslintrc.js",
    "tsConfig": [
      "tsconfig.app.json",
      "tsconfig.spec.json",
      "e2e/tsconfig.json"
    ],
    "exclude": [
      "**/node_modules/**"
    ]
  }
},

安装其他插件

npm install eslint-plugin-jasmine --save-dev

overrides: [
  ...,
  {
    files: ['src/**/*.spec.ts', 'src/**/*.d.ts'],
    parserOptions: {
      project: './src/tsconfig.spec.json',
    },
    //   
    extends: ['plugin:jasmine/recommended'],
    //    
    plugins: ['jasmine'],
    env: { jasmine: true },
    //   'no-unused-vars'
    rules: {
      '@typescript-eslint/no-unused-vars': 'off',
    },
  }
],

添加样式指南指南

• AirBnB：强制尾随逗号和分号这三种中最受欢迎和最严格的。
• Google：在格式上类似于AirBnB，但不太严格，是强制性的JSDoc注释。
• StandartJS：禁止使用结尾的逗号和分号。

选择一种TypeScript样式指南的实现，因为JavaScript规则可能无法在TypeScript上正常工作。

npm install eslint-plugin-import eslint-config-airbnb-typescript --save-dev

module.exports = {
  ...,
  overrides: [
    ...,
    {
      files: ['*.ts'],
      extends: [
        'airbnb-typescript/base',
      ],
      parser: '@typescript-eslint/parser',
      parserOptions: {
        ecmaVersion: 2020,
        sourceType: 'module',
      },
    },
  ]
}

定制规则

module.exports = {
  ...,
  overrides: [
    ...,
    {
      files: ['*.ts'],
      extends: [
        'airbnb-typescript/base',
      ],
      parser: '@typescript-eslint/parser',
      parserOptions: {
        ecmaVersion: 2020,
        sourceType: 'module',
      },
      //  
      rules: {
        'import/no-unresolved': 'off',
        'import/prefer-default-export': 'off',
        'class-methods-use-this': 'off',
        'lines-between-class-members': 'off',
        '@typescript-eslint/unbound-method': [
          'error',
          {
            ignoreStatic: true,
          },
        ],
      },
    },
  ]
}

配置更漂亮

npm i prettier eslint-config-prettier eslint-plugin-prettier --save-dev

module.exports = {
  ...,
  overrides: [
    ...,
    {
      files: ['*.ts'],
      extends: [
        //   AirBnB
	'airbnb-typescript/base',
	//   Prettier
	'prettier/@typescript-eslint',
	'plugin:prettier/recommended',
      ],
      ...,
    },
  ]
}

• 包括eslint-plugin-prettier，
• 将更漂亮/更漂亮的规则错误打印为“错误”到控制台，
• 添加更漂亮的eslint-config-prettier格式设置规则。

配置更漂亮：

module.exports = {
  trailingComma: "all",
  tabWidth: 2,
  semi: true,
  singleQuote: true,
  bracketSpacing: true,
  printWidth: 100
};

prettier "--write ."

配置VS代码

  "eslint.validate": [ "javascript", "typescript", "html"],

  "eslint.options": {
    "extensions": [".js", ".ts", "html"]
  },

  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
  },

设置git钩子

npm i husky lint-staged --save-dev

"scripts": {
  ...
},
"husky": {
  "hooks": {
    "pre-commit": "lint-staged --relative"
  }
},
"lint-staged": {
  "*.{js,ts}": [
     "eslint --fix"
  ]
},

发现

参考文献

• Monular仓库Angular ESLint
• TypeScript ESLint单一存储库