Nous portons le projet Angular sur ESLint, avec Prettier, Husky et lint-staged

Prettier & ESLint

• Formatage - pour regrouper le code en une seule vue: longueurs de ligne, virgules, points-virgules, etc.
• Qualité du code - recherche de modèles de code problématiques: code inutile, erreurs.

eslint example.ts --fix

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

Configuration d'ESLint

Installation

• eslint - le linter lui-même,
• @ angular-eslint / builder  - Angular CLI Builder pour exécuter ESLint pour les applications angulaires à l'aide de la commande standard ng lint,
• @ angular-eslint / eslint-plugin  - un plugin contenant des règles pour le linting angulaire,
• @ angular-eslint / template-parser  est un analyseur qui avecangulaire/ le compilateur permet d'écrire des règles de doublage des modèles angulaires,
• @ angular-eslint / eslint-plugin-template  - un plugin qui, lorsqu'il est utilisé avec @ angular-eslint / template-parser, lance des règles pour aligner les modèles angulaires,
• @ typescript-eslint / parser - plugin pour analyser le code TypeScript,
• @ typescript-eslint / eslint-plugin - un plugin qui exécute les règles TypeScript pour le linting.

ng add @angular-eslint/schematics

Configuration de configuration

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',
    },
  ],
};

Les configurations peuvent être décrites dans différents formats: fichier JavaScript, JSON ou YAML. Vous pouvez laisser des commentaires en JavaScript.

Mise à jour de la commande 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/**"
    ]
  }
},

Installer des plugins supplémentaires

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',
    },
  }
],

Ajout de guides de guide de style

• AirBnB : le plus populaire et le plus strict des trois virgules et points-virgules de fin obligatoires.
• Google : similaire à AirBnB en termes de formatage, mais moins strict, commentaires JSDoc obligatoires.
• StandartJS : interdit l'utilisation de virgules et de points-virgules de fin.

Choisissez une implémentation du guide de style TypeScript car les règles JavaScript peuvent ne pas fonctionner correctement sur 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',
      },
    },
  ]
}

Règles de personnalisation

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,
          },
        ],
      },
    },
  ]
}

Configurer Prettier

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',
      ],
      ...,
    },
  ]
}

• comprend eslint-plugin-prettier,
• imprime les erreurs de règles plus jolies / plus jolies sur la console comme "erreur",
• Ajoute des règles de mise en forme prettier eslint-config-prettier.

Config pour Prettier:

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

prettier "--write ."

Configurer le code VS

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

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

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

Configuration des crochets Git

npm i husky lint-staged --save-dev

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

résultats

Références

• Dépôt monulaire Angular ESLint
• Monorepositaire TypeScript ESLint