Wir portieren das Angular-Projekt auf ESLint mit Prettier, Husky und Lint-Inszenierung

Schöner & ESLint

• Formatierung - um den Code in eine Ansicht zu bringen: Zeilenlängen, Kommas, Semikolons usw.
• Codequalität - Suche nach problematischen Codevorlagen: unnötiger Code, Fehler.

eslint example.ts --fix

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

ESLint-Setup

Installation

• Eslint - der Linter selbst,
• @ angle-eslint / builder  - Angular CLI Builder zum Ausführen von ESLint für Angular-Anwendungen mit dem Standardbefehl ng lint.
• @ angle-eslint / eslint-plugin  - ein Plugin mit Regeln für Angular-Flusen,
• @ angle-eslint / template-parser  ist ein Parser, der miteckig/ compiler ermöglicht das Schreiben von Regeln für das Auskleiden von Angular-Vorlagen.
• @ angle-eslint / eslint-plugin-template  - ein Plugin, das in Verbindung mit @ angle-eslint / template-parser Regeln für das Linguisieren von Angular-Vorlagen startet.
• @ typescript-eslint / parser - Plugin zum Parsen von TypeScript-Code,
• @ typescript-eslint / eslint-plugin - ein Plugin, das TypeScript-Regeln für Flusen ausführt .

ng add @angular-eslint/schematics

Konfigurationskonfiguration

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

Konfigurationen können in verschiedenen Formaten beschrieben werden: JavaScript-, JSON- oder YAML-Datei. Sie können Kommentare in JavaScript hinterlassen.

Ng Flusenbefehl Update

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

Installieren Sie zusätzliche Plugins

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

Hinzufügen von Style Guide-Handbüchern

• AirBnB : Das beliebteste und strengste der drei obligatorischen Nachkommas und Semikolons.
• Google : Ähnlich wie AirBnB in Bezug auf die Formatierung, jedoch weniger strenge, obligatorische JSDoc-Kommentare.
• StandartJS : Verbietet die Verwendung von Kommas und Semikolons.

Wählen Sie eine Implementierung des TypeScript-Styleguides aus, da JavaScript-Regeln unter TypeScript möglicherweise nicht ordnungsgemäß funktionieren.

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

Anpassungsregeln

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

Schöner konfigurieren

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

• beinhaltet eslint-plugin-prettier,
• druckt schönere / schönere Regelfehler als "Fehler" an die Konsole,
• Fügt hübschere eslint-config-hübschere Formatierungsregeln hinzu.

Konfiguration für hübscher:

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

prettier "--write ."

VS-Code konfigurieren

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

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

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

Git-Hooks einrichten

npm i husky lint-staged --save-dev

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

Ergebnisse

Verweise

• Monulares Repository Angular ESLint
• TypeScript ESLint Monorepository