shell linter

Shell Linter

Eine GitHub -Aktion, die statische Analyse für Shell -Skripte mit Shellcheck durchführt.

Verwendung

Shell -Verluste kann eine statische Analyse auf verschiedene Weise durchführen. Standardmäßig scannt es alle von Shellcheck unterstützten Shell-Skripte (SH/Bash/Dash/KSH) in Ihrem Projekt. Sie können jedoch den path verwenden, um eine bestimmte Datei oder einen bestimmten Ordner zu scannen oder den Parameter exclude-paths zu verwenden, um Dateien oder Ordner aus dem Scan auszuschließen. Mit Shell -Linter können Sie auch die Mindestschweregie von Fehlern angeben, um den severity zu berücksichtigen. Spezifische Anwendungsfälle zusammen mit Beispielen sind unten angezeigt:

Führen Sie die statische Analyse für alle unterstützten Shell -Skripte in Ihrem Repository aus:

 jobs :
  lint :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v1
      - name : Run ShellCheck
        uses : azohra/shell-linter@latest 

Führen Sie die statische Analyse für ein einzelnes Shell -Skript aus:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup.sh " 

Führen Sie die statische Analyse für mehrere Shell -Skripte mit oder ohne Erweiterung aus:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup,deploy.sh " 

Führen Sie die statische Analyse für alle Shell -Skripte in einem Ordner aus:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src " 

Führen Sie die statische Analyse unter Verwendung eines Wildcard -Pfades aus:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh " 

Dateien und Ordner aus der statischen Analyse ausschließen:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          exclude-paths : " src/setup.sh,tests/unit_tests " 

Beachten Sie, dass exclude-paths die nur Pfade in Bezug auf das Root Directory Ihres Projekts akzeptieren. Geben Sie jedoch nicht zu Beginn der Pfade ein ./

Um einen Ordner auszuschließen, und es ist Inhalt rekursiv, liefern Sie einfach den Pfad des Ordners ohne A / am Ende. Im obigen Beispiel wird der gesamte Ordner an den tests/unit_tests vom Lining ausgeschlossen.

Führen Sie die statische Analyse für alle Shell -Skripte aus und melden Sie das Problem nur mit dem Schweregrad der Fehler:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh "
          severity : " error " 

Führen Sie die Analyse mit einer spezifischen Version von Shell Linter aus:

      - name : Run ShellCheck
        uses : azohra/[email protected]

Eingang

path

Optional. Führen Sie die Lint -Überprüfung einer bestimmten Datei oder eines bestimmten Ordners aus. Standard: .

exclude-paths

Optional. Dateien und Ordner aus dem Shellcheck -Scan ausschließen.

severity

Optional. Geben Sie die Mindestschweregie an Fehlern an [Stil, Info, Warnung, Fehler]. Standard: style

Lizenz

Diese Software ist unter den Bedingungen der MIT -Lizenz als Open Source verfügbar.