SuperAPI AI 工具集

advpl-code-review

编程与开发

查看项目

更新于 10-16 02:06

技能介绍

用途

该技能为已有的 ADVPL/TLPP 代码提供系统化的代码审查方法,面向 TOTVS Protheus 平台。当用户希望在合并或部署前检查代码质量、合规性、安全性或性能问题时启用,典型场景包括:合并前审查、部署前检查、入职审计,以及评估从 .prw 迁移到 .tlpp 的就绪度。

主要能力

审查覆盖四个类别:

  • 最佳实践(BP-* 规则):检查 RecLock/MsUnlock 配对、变量作用域、区域管理、错误处理、文档。
  • 性能(PERF-* 规则):检查嵌入式 SQL 效率、循环效率、字符串操作、索引使用。
  • 安全(SEC-* 规则):检查 SQL 注入、输入验证、凭据暴露、敏感数据日志记录。
  • 现代化(MOD-* 规则):检查 TLPP 迁移候选、命名空间使用、OOP 模式、现代 UI 框架。

每条发现均标注规则 ID、严重级别(CRITICAL/WARNING/INFO)、文件与行号、问题描述及修复建议。审查结果可映射到 TOTVS 官方 SonarQube 质量门禁(分组 G1-G5,CA/BG/CS 代码)。

使用方式

技能附带参考文件,按需读取:

  • reference.md:始终读取,包含审查类别、输出格式、严重级别、审查流程、规则 ID 前缀。
  • rules-best-practices.md:检查 RecLock/MsUnlock 配对、变量作用域、区域管理、错误处理、文档时读取(BP-* 规则)。
  • rules-performance.md:检查嵌入式 SQL 效率、循环效率、字符串操作、索引使用时读取(PERF-* 规则)。
  • rules-security.md:检查 SQL 注入、输入验证、凭据暴露、敏感数据日志记录时读取(SEC-* 规则)。
  • rules-modernization.md:检查 TLPP 迁移候选、命名空间使用、OOP 模式、现代 UI 框架时读取(MOD-* 规则)。
  • sonarqube-rules-catalog.md:将发现对齐到 TOTVS 官方 SonarQube 规则集时读取(分组 G1-G5,CA/BG/CS 代码)。

适用场景

适用于对已有代码进行质量、合规、安全或性能检查,例如合并前、部署前、入职审计,或评估 .prw 到 .tlpp 的迁移就绪度。

限制

该技能不覆盖以下内容:生成新代码(参见 advpl-code-generation)、诊断具体运行时或编译错误(参见 advpl-debugging)、在不新增功能的前提下重构代码(参见 advpl-refactoring)、执行实际的 .prw 到 .tlpp 转换(参见 advpl-to-tlpp-migration)。