shell linter

シェルリナー

シェルチェックを使用してシェルスクリプトの静的分析を実行するGitHubアクション。

使用法

シェルリナーは、さまざまな方法で静的分析を実行できます。デフォルトでは、プロジェクト内のすべてのシェルチェックサポートシェルスクリプト（sh/bash/dash/ksh）をスキャンします。ただし、 pathパラメーターを使用して特定のファイルまたはフォルダーをスキャンするか、 exclude-pathsパラメーターを使用してスキャンからファイルまたはフォルダーを除外できます。 Shell Linterを使用すると、 severityパラメーターの使用を検討するために、エラーの最小重大度を指定することもできます。特定のユースケースと例を以下に示します。

リポジトリ内のすべてのサポートされているシェルスクリプトの静的分析を実行します。

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

単一のシェルスクリプトの静的分析を実行します。

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

拡張機能の有無にかかわらず複数のシェルスクリプトの静的分析を実行します。

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

フォルダー内のすべてのシェルスクリプトの静的分析を実行します。

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

ワイルドカードパスを使用して静的分析を実行します。

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

静的分析からファイルとフォルダーを除外します。

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

exclude-pathsプロジェクトのルートディレクトリに対するパスのみを受け入れることに注意してください。ただし、パスの先頭に./を含めないでください。

フォルダーを除外すると、コンテンツは再帰的に、最後にA /なしでフォルダーのパスを提供するだけです。上記の例では、パスtests/unit_testsのフォルダー全体が糸くずから除外されます。

すべてのシェルスクリプトに対して静的分析を実行し、エラーの重大度の問題のみを報告します。

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

Shell Linterの特定のバージョンを使用して分析を実行します。

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

入力

path

オプション。特定のファイルまたはフォルダーでLINTチェックを実行します。デフォルト： .

exclude-paths

オプション。シェルチェックスキャンからファイルとフォルダーを除外します。

severity

オプション。 [スタイル、情報、警告、エラー]を考慮するために、エラーの最小重大度を指定します。デフォルト： style

ライセンス

このソフトウェアは、MITライセンスの条件の下でオープンソースとして利用できます。