Linting Regeln für Angular und Serverless

In diesem Projekt werden die Standard-Linting Regeln für Angular und Serverless basierte Projekte definiert.

Einbindung

Die Einbindung ist denkbar einfach. Zuerst müssen alle Abhängigkeiten installiert werden und anschließend muss die .eslintrc.json angepasst werden.

1 Abhängigkeiten installieren

Zunächst müssen die Dependencies und alle peer Dependencies der Plugins installiert werden:

Angular Projekte

yarn add -D @angular-eslint/builder @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser @angular-eslint/template-parser @carano-uiux/eslint-config @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint eslint-plugin-prefer-arrow eslint-plugin-ban eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-deprecation

Serverless Projekte

yarn add -D @carano-uiux/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-plugin-ban eslint-plugin-deprecation eslint-plugin-import

2 Anpassung der .eslintrc.json

Anschließend wird alles aus der bestehenden .eslintrc.json gelöscht und je nach Projekt durch folgendes ersetzt:

Angular Projekte

{
    "extends": "@carano-uiux/eslint-config/angular"
}

Serverless Projekte

{
    "extends": "@carano-uiux/eslint-config/serverless", 
    "parser": "@typescript-eslint/parser"
}

3 Einbindung Testen

Um die eslint Einbindung zu testen kann nun der Linter gestartet werden:

yarn lint

Projektstruktur

├── angular
│   ├── .eslintrc.json          # Definition der eslint Regeln für Angular 
├── common
│   ├── .eslintrc.json          # Definition allgemeiner eslint Regeln
├── serverless
│   ├── .eslintrc.json          # Definition der eslint Regeln für Serverless
├── .gitignore
├── angular.js                  # exportiert eslint Regeln für Angular
├── bitbucket-pipelines.yml
├── LICENSE.md
├── package.json
├── README.md
├── serverless.js               # exportiert eslint Regeln für Serverless
└── yarn.lock

NPM Publish

Um Änderungen an den Konfigurationen auf NPM zu publishen, sind folgende Schritte nötig:

1 Anmelden mit NPM Account (falls noch nicht geschehen)

npm adduser

2 Hochzählen der Versionsnummer in package.json

3 Publishen der neuen Version

npm publish --access public

Lokales Testen

Um die Bibliothek lokal in einem Projekt einzubinden, muss in diesem Projekt folgender Befehl ausgeführt werden:

yarn link

In dem Projekt, in dem die Bibliothek eingebunden werden soll, muss danach folgender Befehl ausgeführt werden:

yarn link "@carano-uiux/eslint-config"

Um die lokale Einbindung wieder aufzuheben, muss in der Bibliothek zuerst folgender Befehl ausgeführt werden:

yarn unlink

Anschließend muss in dem Projekt, in dem die Bibliothek eingebunden war, folgender Befehl ausgeführt werden:

yarn unlink "@carano-uiux/eslint-config"