lpenz/omnilint

omnilint

概览

omnilint 是一个基于容器的工具，提供统一接口对任何文件进行静态分析，自动使用相应的检查工具。它特别适用于与 Travis、Jenkins 等持续集成 (CI) 工具结合使用，简化代码质量检查流程。

TL;DR

在 .travis.yml 中添加以下配置，即可创建一个对仓库文件执行静态分析的任务：

yaml
jobs:
  include:
    - name: omnilint
      language: generic
      install: docker pull docker.xuanyuan.run/lpenz/omnilint
      script: docker run --rm -u "$UID" -v "$PWD:$PWD" -w "$PWD" lpenz/omnilint

或作为 GitHub Action 使用，创建如下 https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow 文件：

yaml
name: CI
on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: docker://lpenz/omnilint:latest

核心功能与特性

• 统一接口：为不同类型文件提供一致的静态分析体验，无需手动选择检查工具
• 多文件类型支持：自动匹配文件类型与对应检查工具，例如：
  • .c 文件使用 cppcheck
  • .sh 文件使用 shellcheck
  • .py 文件使用 pyflakes
• 灵活输出：支持类 gcc 格式输出和 JSON 格式输出
• 容器化设计：无需单独安装各检查工具，通过 Docker 即可快速使用

使用场景

• 集成到持续集成 (CI) 流程，在代码提交或 PR 时自动执行静态分析
• 本地开发环境中快速检查代码质量
• 项目质量门禁，确保代码符合基本静态检查标准

安装与使用

依赖要求

• Docker

安装方法

最简单的安装方式是从 https://hub.docker.com/r/lpenz/omnilint/ 拉取镜像：

bash
docker pull docker.xuanyuan.run/lpenz/omnilint

本地使用

运行容器时，需将待分析文件所在目录映射到容器中：

bash
docker run --rm -u "$UID" -v "$PWD:$PWD" -w "$PWD" docker.xuanyuan.run/lpenz/omnilint

也可直接调用仓库中提供的脚本 bin/omnilint-docker-run 执行。