shell linter

Shell linter

Une action GitHub qui effectue une analyse statique pour les scripts de coquille à l'aide de ShellCheck.

Usage

Shell Linter peut effectuer une analyse statique de diverses manières. Par défaut, il analyse tous les scripts de coquille soutenus par ShellCheck (SH / BASH / DASH / KSH) dans votre projet. Cependant, vous pouvez utiliser le paramètre path pour scanner un fichier ou un dossier spécifique ou utiliser le paramètre exclude-paths pour exclure des fichiers ou des dossiers de la numérisation. Avec Shell Linter, vous pouvez également spécifier la gravité minimale des erreurs pour envisager d'utiliser le paramètre severity . Des cas d'utilisation spécifiques ainsi que des exemples sont présentés ci-dessous:

Exécutez une analyse statique pour tous les scripts de shell pris en charge dans votre référentiel:

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

Exécutez une analyse statique pour un seul script shell:

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

Exécutez une analyse statique pour plusieurs scripts shell avec ou sans extension:

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

Exécutez une analyse statique pour tous les scripts de shell dans un dossier:

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

Exécutez une analyse statique à l'aide d'un chemin générique :

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

Exclure les fichiers et les dossiers de l'analyse statique:

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

Notez que exclude-paths accepte uniquement les chemins par rapport au répertoire racine de votre projet. Cependant, n'incluez pas ./ Au début des chemins.

Pour exclure un dossier et son contenu donne simplement le chemin du dossier sans a / à la fin. Dans l'exemple ci-dessus, l'ensemble du dossier des tests/unit_tests sera exclu de la liaison.

Exécutez une analyse statique pour tous les scripts de shell et seul le problème de rapport avec la gravité des erreurs:

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

Exécutez l'analyse en utilisant une version spécifique de Shell Linter:

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

Saisir

path

Facultatif. Exécutez la vérification des peluches sur un fichier ou un dossier spécifique. Défaut: .

exclude-paths

Facultatif. Exclure les fichiers et les dossiers de ShellCheck Scan.

severity

Facultatif. Spécifiez la gravité minimale des erreurs à considérer [style, info, avertissement, erreur]. Par défaut: style

Licence

Ce logiciel est disponible en open source en vertu des termes de la licence MIT.