shellcheck-sarif

此包提供了一个命令行工具，用于将 shellcheck 诊断输出转换为 SARIF。

最新文档可在此处找到：[链接](https://docs.rs/shellcheck_sarif)

shellcheck 是一个流行的 Shell 脚本代码检查器/静态分析工具。更多信息可以在官方仓库找到：[链接](https://github.com/koalaman/shellcheck)

SARIF 或静态分析结果交换格式是静态分析工具输出的一种行业标准格式。更多信息可以在官方网站找到：[链接](https://sarifweb.azurewebsites.net/)

安装

可以通过 cargo 安装 shellcheck-sarif

cargo install shellcheck-sarif

通过 cargo-binstall

cargo binstall shellcheck-sarif

或直接从 Github 发布版下载

# make sure to adjust the target and version (you may also want to pin to a specific version)
curl -sSL https://github.com/psastras/sarif-rs/releases/download/shellcheck-sarif-latest/shellcheck-sarif-x86_64-unknown-linux-gnu -o shellcheck-sarif

用法

对于大多数情况，只需运行带有 json 输出的 shellcheck 并将结果通过管道传递给 shellcheck-sarif 即可。

示例

shellcheck -f json shellscript.sh | shellcheck-sarif

如果您正在使用 Github Actions，SARIF 可以用于与 Github 高级安全 (GHAS) 集成，该功能可以在您的仓库的 "安全" 选项卡中显示代码警报。

将 shellcheck-sarif 输出上传到 Github 后，shellcheck 诊断将在 GHAS 中可用。

示例

on:
  workflow_run:
    workflows: ["main"]
    branches: [main]
    types: [completed]

name: sarif

jobs:
  upload-sarif:
    runs-on: ubuntu-latest
    if: ${{ github.ref == 'refs/heads/main' }}
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - uses: Swatinem/rust-cache@v1
      - run: cargo install shellcheck-sarif sarif-fmt
      - run: shellcheck -f json shellscript.sh | shellcheck-sarif | tee
          results.sarif | sarif-fmt
      - name: Upload SARIF file
        uses: github/codeql-action/upload-sarif@v1
        with:
          sarif_file: results.sarif

许可证：MIT