shell linter

殼襯裡

使用ShellCheck對Shell腳本進行靜態分析的GitHub動作。

用法

Shell Linter可以以各種方式執行靜態分析。默認情況下，它在您的項目中掃描了所有ShellCheck支持的Shell腳本（SH/BASH/DASH/KSH）。但是，您可以使用path參數來掃描特定文件或文件夾，或使用exclude-paths參數將文件或文件夾排除在掃描中。使用Shell Linter，您還可以指定使用severity參數的最小錯誤嚴重性。特定用例以及示例如下：

對您的存儲庫中的所有受支持的Shell腳本運行靜態分析：

 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 " 

對文件夾中的所有Shell腳本運行靜態分析：

      - 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上的整個文件夾將被排除在覆蓋範圍之外。

對所有Shell腳本運行靜態分析，僅報告錯誤嚴重性的問題：

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

通過使用特定版本的Shell Linter運行分析：

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

輸入

path

選修的。執行棉絨檢查特定文件或文件夾。預設: .

exclude-paths

選修的。從ShellCheck掃描中排除文件和文件夾。

severity

選修的。指定要考慮[樣式，信息，警告，錯誤]的錯誤嚴重程度。默認值： style

執照

根據MIT許可條款，該軟件可作為開源。