ccaominh/intellij-inspect

IntelliJ Inspect

用于运行IntelliJ IDEA代码检查的Docker容器。若分析检测到代码违规，会打印人类可读的报告并返回退出码1；若未检测到违规，则返回退出码0。

核心功能

• 支持IntelliJ项目、Maven、Gradle等多种项目类型的代码检查
• 可指定检查的严重级别（如ERROR、WARNING）
• 支持限定检查的目录或IntelliJ范围
• 输出检查结果报告，可保存到指定路径

使用场景

• CI/CD流程中的自动化代码质量验证
• 本地项目代码合规性批量检查
• 团队统一代码规范的强制执行

配置说明

命令格式

[OPTIONS] PROJECT PROFILE

选项

• -d, --directory TEXT：项目内待检查目录的绝对路径
• -l, --levels TEXT：检查的严重级别（默认：ERROR,WARNING）
• -o, --output TEXT：结果输出的绝对路径（默认：inspection-results）
• -s, --scope TEXT：使用的IntelliJ范围名称
• -h, --help：显示帮助信息

参数

• PROJECT：待分析的项目目录、pom.xml或build.gradle等的绝对路径
• PROFILE：检查配置文件的绝对路径

注意：所有路径必须为绝对路径。

使用示例

以下示例假设工作目录为待分析项目根目录。

1. 检查IntelliJ IDEA项目：

bash
docker run --rm \
    -v $(pwd):/project \
    ccaominh/intellij-inspect:1.0.0 \
    /project \
    /project/.idea/inspectionProfiles/Project_Default.xml

2. 检查Maven项目（需先在主机执行mvn install）：

bash
docker run --rm \
    -v "$(pwd):/project" \
    -v ~/.m2:/home/inspect/.m2 \
    ccaominh/intellij-inspect:1.0.0 \
    /project/pom.xml \
    /project/intellij_inspection_profile.xml

3. 仅检查ERROR级别违规：

bash
docker run --rm \
    -v $(pwd):/project \
    ccaominh/intellij-inspect:1.0.0 \
    /project \
    /project/.idea/inspectionProfiles/Project_Default.xml \
    --levels ERROR

4. 检查项目内特定目录：

bash
docker run --rm \
    -v $(pwd):/project \
    ccaominh/intellij-inspect:1.0.0 \
    /project \
    /project/.idea/inspectionProfiles/Project_Default.xml \
    --directory /project/src/main/java

5. 输出结果到指定目录（供IntelliJ IDEA离线查看）：

bash
docker run --rm \
    -v $(pwd):/project \
    -v "$(pwd)/build/inspect:/inspect" \
    ccaominh/intellij-inspect:1.0.0 \
    /project \
    /project/.idea/inspectionProfiles/Project_Default.xml \
    --output /inspect