Linter

Mit Linter für "saubere" States sorgen

Was sind Linter

Ein Linter ist ein Programm, das Code analysiert und potenzielle Fehler aufdeckt. Linter werden in der Softwareentwicklung eingesetzt, um die Qualität des Codes zu verbessern und Fehler zu vermeiden.

Hier sind ein paar Gründe, warum Sie Linter nutzen sollten:

• Linter finden Fehler, die Sie sonst übersehen würden.

• Linter helfen Ihnen, Ihren Code sauberer und lesbarer zu gestalten.

• Linter können Ihnen helfen, Ihren Code effizienter zu gestalten.

• Linter können Ihnen helfen, Ihren Code sicherer zu gestalten.

• Linter können Ihnen Zeit und Mühe sparen.

Yaml Lint

Der Basis-Linter, der Inkonsistenzen in Yaml-Dateien aufdeckt.

apt install yamllint

Yamllint in Aktion

Durch das Anlegen einer Konfigurationsdatei in /srv/salt/.yamllint können Sie die Regeln anpassen. Beispiel:

/srv/salt/.yamllint

---
extends: default

yaml-files:
  - '*.yaml'
  - '*.yml'
  - '.yamllint'
  - '*.sls'

rules:
  # 80 chars should be enough, but don't fail if a line is longer
  line-length:
    max: 160
    level: warning

  # don't bother me with this rule
  indentation: disable

Führen Sie das Kommando yamllint immer aus dem Verzeichnis /srv/salt aus, damit die Konfigurationsdatei berücksichtigt wird.

Alle Konfigurationsoption von Yamllint finden Sie in der offiziellen Dokumentation.

Salt-Lint

Folgen Sie den Best-Practices von Salt-Lint, damit all Ihre State-Files einen einheitlichen Stil habe.

apt install pip
pip3 install salt-lint --break-system-packages

Salt-Lint in Aktion