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许可条款，该软件可作为开源。