Dies ist ein Guide zur Einrichtung von ESLint mit dem Airbnb Style Guide.

ESLint installieren

Im aktuellen Workspace muss sich eine package.json befinden. Das benötigte Paket wird als Dev-Depencies eingefügt.

npm install eslint --save-dev

ESLint konfigurieren

Zum Konfigurieren von ESLint wird der Konfigurationsassistent aufgerufen. In diesem Zuge wird eine Konfigurationsdatei .eslintrc.js erstellt, welche die Konfigurationsdatei des Airbnb Styleguides einbindet.

npx eslint --init

Bitte die Fragen des Assistenten wie folgt beantworten:

? How would you like to use ESLint? …
  To check syntax only
  To check syntax and find problems
❯ To check syntax, find problems, and enforce code style

? What type of modules does your project use? …
  JavaScript modules (import/export)
  CommonJS (require/exports)
❯ None of these

? Which framework does your project use? …
  React
  Vue.js
❯ None of these

Does your project use TypeScript? › [No] / Yes

? Where does your code run?
✔ Browser
  Node

? How would you like to define a style for your project? …
❯ Use a popular style guide
  Answer questions about your style
  Inspect your JavaScript file(s)

? Which style guide do you want to follow? …
❯ Airbnb: https://github.com/airbnb/javascript
  Standard: https://github.com/standard/standard
  Google: https://github.com/google/eslint-config-google
  XO: https://github.com/xojs/eslint-config-xo

? What format do you want your config file to be in? …
❯ JavaScript
  YAML
  JSON

In der package.json sollten die Dependencies nun definiert sein. Um ESLint auszuführen wird der Befehl eslint benutzt. Dazu müssen die entsprechende Script-Befehle in der package-json eingefügt werden:

{
"scripts": {
    "js:lint": "eslint scripts/**/*.js",
    "js:lint:fix": "eslint scripts/**/*.js --fix",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
}

js:lint führt den Linter für alle Dateien mit der Endung js innerhalb des scripts Ordners und deren Unterordnern aus.

js:lint:fix hat die gleiche Funktion, versucht aber zudem Probleme die der Linter findet zu beheben.

ES Lint ausführen

Über das Terminal kann der Linter nun ausgeführt werden:

npm run js:lint

Oder Linten mit automatischen Fixen:

npm run js:lint:fix

Linting-Hinweise in VSCode

In VS Code können Linting Hinweise direkt angezeigt werden. Dazu muss folgendes Plugin installiert werden:

https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

Um Linter Fehler automatisch beim Speichern der Datei, welche man gerade editiert, zu beheben, bitte die Konfigurationsdatei des Editors um folgende Zeilen ergänzen.

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