Was macht shellcheck-configuration?
Beherrschen Sie die Konfiguration und Nutzung von ShellCheck für die statische Analyse von Shell-Skripten zur Steigerung der Codequalität. Verwenden Sie dies beim Einrichten der Linting-Infrastruktur, Beheben von Code-Problemen oder Sicherstellen der Skript-Portabilität.
Übersicht
ShellCheck ist ein Tool zur statischen Analyse von Shell-Skripten, das dazu beiträgt, häufige Fehler und unsichere Praktiken zu identifizieren. Diese Fähigkeit bietet eine umfassende Anleitung zur Konfiguration von ShellCheck für verschiedene Projektanforderungen.
Konfiguration
Grundlegende Einrichtung
- Installation: Stellen Sie sicher, dass ShellCheck in Ihrer Umgebung installiert ist.
- Konfigurationsdatei: Erstellen Sie eine
.shellcheckrc-Datei im Stammverzeichnis Ihres Projekts.
Beispiel .shellcheckrc
# Diese Direktiven aktivieren bestimmte Prüfungen und deaktivieren andere
enable=all
# Deaktivieren Sie bestimmte Warnungen, die für Ihr Projekt irrelevant sind
#disable=SC2154,SC1091
# Setzen Sie die Shell auf bash, um bash-spezifische Prüfungen zu aktivieren
shell=bash
# Deaktivieren Sie Quellcodedateien, die nicht von ShellCheck überprüft werden sollen
external-sources=true
Verwendung
In der Kommandozeile
shellcheck mein_skript.sh
Mit spezifischen Optionen
shellcheck -s bash -P SCRIPTDIR mein_skript.sh
-s bash: Legt die Ziel-Shell fest-P SCRIPTDIR: Fügt das Skriptverzeichnis zum Suchpfad für Quellcodedateien hinzu
Integration in CI/CD
Fügen Sie ShellCheck zu Ihrer CI/CD-Pipeline hinzu, um die Codequalität automatisch zu überprüfen.
Beispiel für GitHub Actions
- name: Führe ShellCheck aus
uses: ludeeus/action-shellcheck@master
with:
# Optional: Legen Sie das zu überprüfende Verzeichnis fest
scandir: './skripte'
# Optional: Legen Sie die zu verwendende Shell fest
shell: bash
Richtlinien für die Skriptentwicklung
- Verwenden Sie immer ShellCheck: Führen Sie ShellCheck bei allen Shell-Skripten aus, bevor Sie sie bereitstellen.
- Behandeln Sie Warnungen als Fehler: Konfigurieren Sie ShellCheck, um Warnungen in Ihrer Build-Pipeline als Fehler zu behandeln.
- Dokumentieren Sie Ausnahmen: Wenn Sie bestimmte Warnungen deaktivieren müssen, dokumentieren Sie den Grund in der Konfigurationsdatei.
- Aktualisieren Sie regelmäßig: Halten Sie ShellCheck auf dem neuesten Stand, um von neuen Prüfungen und Fehlerbehebungen zu profitieren.
Fehlerbehebung
Häufige Probleme
- ShellCheck wird nicht gefunden: Überprüfen Sie die Installation und stellen Sie sicher, dass der Binärpfad in
PATHenthalten ist. - Konfiguration wird ignoriert: Stellen Sie sicher, dass die
.shellcheckrc-Datei im korrekten Verzeichnis liegt und gültige Direktiven enthält. - Falsche Shell-Erkennung: Wenn das Shebang (
#!) fehlt oder mehrdeutig ist, geben Sie die Shell explizit mit der Option-san.