Install
openclaw skills install @thcjp/code-quality-2openclaw skills install @thcjp/code-quality-2核心功能: 本技能提供化工作流场景等能力。
| 能力 | 免费版 | 付费版 |
|---|---|---|
| 基础功能 | 支持 | 支持 |
| 深度漏洞扫描与CVE关联 | 不支持 | 支持 |
| 安全基线合规审计 | 不支持 | 支持 |
| 批量资产风险评分 | 不支持 | 支持 |
| 威胁情报实时订阅与告警 | 不支持 | 支持 |
| 零日漏洞检测与防护规则下发 | 不支持 | 支持 |
详细的输入输出格式请参考下方章节说明。
| 场景 | 输入 | 输出 |
|---|---|---|
| 编码执行 | 需求描述与约束条件 | 代码文件与测试结果 |
| 质量检查 | 代码库与标准配置 | 问题列表与修复建议 |
| 风格检查 | 代码文件与风格规则 | 违规列表与修正建议 |
不适用于:需要人工判断的复杂决策场景
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| content | string | 否 | 处理的内容输入 |
| mode | string | 否 | 处理模式, 可选值: json/text/markdown |
| style | string | 否 | 输出风格, 参考 references/style.md |
{
"success": true,
"data": {
"result": "处理结果",
"status": "success",
"metadata": {
"metadata": {
"template_used": "reviewer",
"word_count": 0,
"style": "专业"
}
},
"error": null
}
输出模板参考: assets/output.json
| 错误场景 | 原因 | 处理方式 |
|---|---|---|
| 配置错误 | 参数缺失或格式错误 | 检查依赖说明中的配置要求 |
| 运行时错误 | 运行环境不满足 | 确认运行环境符合依赖说明 |
| 网络错误 | 连接超时或不可达 |
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|---|---|---|---|
| LLM API | API | 必需 | 由Agent内置LLM提供 |
API Key配置方式:
export API_KEY="${API_KEY:?请设置环境变量}"
配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.
A: 请参考使用流程和依赖说明章节,确保运行环境满足要求后调用本技能。
| 操作步骤 | 手动耗时 | 自动化耗时 | 时间节约 | 准确率提升 |
|---|---|---|---|---|
| 代码格式化 | 30分钟/文件 | 5秒/文件 | 29分55秒 | 100% |
| 代码安全漏洞扫描 | 2小时/文件 | 10分钟/文件 | 1小时50分钟 | 95% |
| 代码风格检查 | 1小时/文件 | 3分钟/文件 | 58分钟 | 98% |
| 代码单元测试 | 4小时/文件 | 20分钟/文件 | 3小时40分钟 | 99% |
| 代码性能分析 | 8小时/文件 | 1小时/文件 | 7小时 | 100% |
| 对比维度 | 本技能 | 手动操作 | Python脚本 | 专业软件 |
|---|---|---|---|---|
| 操作便捷性 | 高 | 低 | 中 | 高 |
| 功能全面性 | 高 | 低 | 中 | 高 |
| 执行效率 | 高 | 低 | 中 | 高 |
| 学习成本 | 低 | 高 | 中 | 高 |
| 成本效益 | 高 | 低 | 中 | 高 |
| 痛点 | 描述 | 影响范围 | 解决方案 | 量化效果 |
|---|---|---|---|---|
| 代码风格不一致 | 代码风格不一致导致代码可读性差,维护困难 | 整个项目 | 提供统一的编码风格标准,自动检查和修复 | 减少代码维护时间20% |
| 代码安全漏洞 | 代码中存在安全漏洞可能导致数据泄露或系统崩溃 | 整个项目 | 自动扫描代码安全漏洞,提供修复建议 | 提高代码安全性,降低安全风险50% |
| 代码质量低 | 代码质量低导致系统性能差,维护成本高 | 整个项目 | 提供代码质量检查工具,自动识别和修复问题 | 提高代码质量,降低维护成本30% |
A: Code Quality支持多种编程语言,包括但不限于Java、Python、C++、JavaScript等。
A: 请参考依赖说明章节中的配置要求,配置好运行环境后即可使用。
A: Code Quality会自动检查代码风格,并提供修复建议,用户可以根据建议进行修改。
A: Code Quality会自动扫描代码安全漏洞,并提供修复建议,用户可以根据建议进行修复。
| 错误现象 | 可能原因 | 诊断步骤 | 解决方案 |
|---|---|---|---|
| 无法启动Code Quality | 运行环境不满足要求 | 检查运行环境是否符合依赖说明中的要求 | 确保运行环境满足要求,重新启动Code Quality |
| 代码格式化错误 | 代码格式化规则配置错误 | 检查代码格式化规则配置是否正确 | 修改代码格式化规则配置,重新运行Code Quality |
| 代码安全漏洞扫描失败 | 代码安全漏洞扫描规则配置错误 | 检查代码安全漏洞扫描规则配置是否正确 | 修改代码安全漏洞扫描规则配置,重新运行Code Quality |
| 代码质量检查失败 | 代码质量检查规则配置错误 | 检查代码质量检查规则配置是否正确 | 修改代码质量检查规则配置,重新运行Code Quality |
| 网络连接问题 | 网络连接不稳定或不可达 | 检查网络连接是否正常 | 确保网络连接正常,重新运行Code Quality |
详细的输入输出格式请参考下方章节说明。
针对代码使用中可能遇到的常见问题,提供以下排查方案:
| 错误类型 | 原因分析 | 解决方案 |
|---|---|---|
| API认证失败(401) | API密钥错误或过期 | 检查密钥配置,重新生成token |
| 接口限流(429) | 请求频率超出限制 | 降低调用频率,启用重试退避策略 |
| 响应超时(504) | 网络延迟或服务端负载过高 | 增加超时阈值,检查网络连接 |
| 文件不存在 | 路径错误或文件未创建 | 检查路径拼写,确认文件已生成 |
| 文件格式不支持 | 扩展名不在支持列表中 | 转换为支持的格式后重试 |
| 权限不足 | 当前用户无读写权限 | 检查文件权限,以管理员身份运行 |
| 命令执行失败 | 参数错误或环境依赖缺失 | 检查命令语法,确认依赖已安装 |
| 进程超时 | 命令执行时间过长 | 增加超时设置,优化命令参数 |
| 网络连接失败 | DNS解析失败或防火墙拦截 | 检查网络配置,确认代理设置 |