Portamos el proyecto Angular en ESLint, con Prettier, Husky y lint-staged

Más bonita y ESLint

• Formateo : para llevar el código a una vista: longitudes de línea, comas, punto y coma, etc.
• Calidad del código : búsqueda de plantillas de código problemáticas: código innecesario, errores.

eslint example.ts --fix

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

Configuración de ESLint

Instalación

• eslint - el linter mismo,
• @ angular-eslint / builder  - Angular CLI Builder para ejecutar ESLint para aplicaciones angulares utilizando el comando estándar ng lint,
• @ angular-eslint / eslint-plugin  : un complemento que contiene reglas para linting angular,
• @ angular-eslint / template-parser  es un analizador que conangular/ compiler hace posible escribir reglas para alinear plantillas angulares,
• @ angular-eslint / eslint-plugin-template  : un complemento que, cuando se usa junto con @ angular-eslint / template-parser, lanza reglas para linguotar plantillas angulares,
• @ typescript-eslint / parser : complemento para analizar el código TypeScript,
• @ typescript-eslint / eslint-plugin : un complemento que ejecuta las reglas de TypeScript para el linting.

ng add @angular-eslint/schematics

Configuración

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

Las configuraciones se pueden describir en diferentes formatos: JavaScript, JSON o archivo YAML. Puedes dejar comentarios en JavaScript.

Actualización del comando 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/**"
    ]
  }
},

Instalar complementos adicionales

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

Agregar guías de guía de estilo

• AirBnB : el más popular y estricto de los tres, comas y puntos y comas finales obligatorios.
• Google : similar a AirBnB en términos de formato, pero menos estrictos, comentarios obligatorios de JSDoc.
• StandartJS : prohíbe el uso de comas y punto y coma al final.

Elija una implementación de la guía de estilo TypeScript porque las reglas de JavaScript pueden no funcionar correctamente en 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',
      },
    },
  ]
}

Reglas de personalización

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

Configurar más bonito

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

• incluye eslint-plugin-prettier,
• imprime errores de regla más bonitos / más bonitos en la consola como "error",
• Agrega las reglas de formato Prettier eslint-config-prettier.

Configuración para Prettier:

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

prettier "--write ."

Configurar código VS

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

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

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

Configurar ganchos git

npm i husky lint-staged --save-dev

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

recomendaciones

Referencias

• Repositorio monular ESLint angular
• TypeScript ESLint Monorepository