totvsengpro/advpl-tlpp-code-analyzer

ADVPL/TLPP 代码分析器

镜像概述

ADVPL/TLPP代码分析器是一个用于分析.PRW和.PRX源代码的Docker容器项目，主要设计用于本地执行，尤其适用于集成到CI/CD管道中，帮助开发团队在代码提交和部署过程中自动进行代码质量检查。

核心功能和特性

• 支持分析ADVPL和TLPP语言的.PRW和.PRX源代码文件
• 可集成到本地开发环境和CI/CD流水线中
• 提供可配置的错误规则列表（包含错误代码的阻断和忽略功能）
• 支持将分析结果输出为JSON格式
• 可自定义错误处理行为（是否因错误中断流水线）
• 支持包含文件（Includes）的处理

使用场景和适用范围

• 开发人员本地代码质量检查
• CI/CD流水线中的自动化代码分析环节
• ADVPL/TLPP项目的代码质量门禁控制
• 大规模代码库的批量质量分析

使用方法和配置说明

基本使用方法

要开始执行代码分析，只需将包含待分析文件的目录挂载到容器的/tmp目录：

bash
docker run --rm -ti -v /本地文件路径:/tmp totvsengpro/advpl-tlpp-code-analyzer

Sonar规则列表

如需查阅分析返回的错误代码列表及文档，请访问：[***]

Includes文件处理

包含文件（Includes）需放置在/tmp/includes目录中。可通过在挂载的本地目录中创建includes子目录并放入相关文件来实现。

提取JSON结果（可选）

如需将分析结果以JSON格式导出，需将本地目录挂载到容器的/bin/output目录：

bash
docker run --rm -ti -v /本地文件路径:/tmp -v /本地输出路径:/bin/output totvsengpro/advpl-tlpp-code-analyzer

修改配置（可选）

如需自定义分析配置，可将包含config.json文件的目录挂载到容器的/bin/conf目录。配置文件需遵循以下默认模板：

config.json

json
{
    "breakList": [],
    "ignoreList": [],
    "breakOnError": true,
    "printSonarFullOutput": false,
    "printInternalWarnings": false
}

配置参数说明：

• breakList: 分析器需要报告的错误代码列表。若需报告所有错误，保持为空列表即可。
• ignoreList: 分析器需要忽略的错误代码列表。列入此列表的错误将不影响分析结果。
• breakOnError: 若设为true，分析器在发现错误时将返回错误退出码，可能中断流水线；设为false时，无论是否发现错误均返回成功退出码。
• printSonarFullOutput: 若设为true，除格式化结果外，还将在控制台打印执行输出的JSON。
• printInternalWarnings: 若设为true，将显示内部警告（主要是Java相关警告）。