代码

提供编码风格标准、安全准则和无障碍要求的检查与修复,支持代码生成、调试和质量保障。

天轰穿

@thcjp

Install

$ openclaw skills install @thcjp/code-quality-2

核心功能: 本技能提供化工作流场景等能力。

Code Quality

专业版专属特性

能力免费版付费版
基础功能支持支持
深度漏洞扫描与CVE关联不支持支持
安全基线合规审计不支持支持
批量资产风险评分不支持支持
威胁情报实时订阅与告警不支持支持
零日漏洞检测与防护规则下发不支持支持

能力矩阵

  • Coding style standards, security guidelines, and accessibility requirements
  • Use when (1) Writing

快速上手

  1. 确认运行环境满足依赖说明中的要求
  2. 在AI Agent对话中调用本技能,提供必要的输入参数
  3. 检查输出结果,根据需要进行后续处理

详细的输入输出格式请参考下方章节说明。

应用场景

场景输入输出
编码执行需求描述与约束条件代码文件与测试结果
质量检查代码库与标准配置问题列表与修复建议
风格检查代码文件与风格规则违规列表与修正建议

不适用于:需要人工判断的复杂决策场景

使用指南

  1. 确认运行环境满足依赖说明中的要求
  2. 根据适用场景选择合适的使用方式
  3. 执行操作并检查输出结果
  4. 如遇错误,参考错误处理章节

参数说明

参数名类型必填说明
contentstring处理的内容输入
modestring处理模式, 可选值: json/text/markdown
stylestring输出风格, 参考 references/style.md

输出规范

{
  "success": true,
  "data": {
    "result": "处理结果",
    "status": "success",
    "metadata": {
    "metadata": {
      "template_used": "reviewer",
      "word_count": 0,
      "style": "专业"
    }
  },
  "error": null
}

输出模板参考: assets/output.json

异常恢复流程

错误场景原因处理方式
配置错误参数缺失或格式错误检查依赖说明中的配置要求
运行时错误运行环境不满足确认运行环境符合依赖说明
网络错误连接超时或不可达

前置条件

运行环境

  • Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
  • 操作系统: Windows / macOS / Linux

依赖说明(补充)

依赖项类型是否必需获取方式
LLM APIAPI必需由Agent内置LLM提供

API Key 配置

可用性分类

  • 分类: MD+execute()
  • 说明: 基于Markdown的AI Skill,

API Key配置方式:

export API_KEY="${API_KEY:?请设置环境变量}"

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

热门问题

Q1: 如何开始使用Code Quality?

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%

常见问题FAQ

Q1: 如何开始使用Code Quality?

Q2: Code Quality支持哪些编程语言?

A: Code Quality支持多种编程语言,包括但不限于Java、Python、C++、JavaScript等。

Q3: 如何配置Code Quality?

A: 请参考依赖说明章节中的配置要求,配置好运行环境后即可使用。

Q4: Code Quality如何处理代码风格问题?

A: Code Quality会自动检查代码风格,并提供修复建议,用户可以根据建议进行修改。

Q5: Code Quality如何处理代码安全漏洞?

A: Code Quality会自动扫描代码安全漏洞,并提供修复建议,用户可以根据建议进行修复。

诊断与修复

错误现象可能原因诊断步骤解决方案
无法启动Code Quality运行环境不满足要求检查运行环境是否符合依赖说明中的要求确保运行环境满足要求,重新启动Code Quality
代码格式化错误代码格式化规则配置错误检查代码格式化规则配置是否正确修改代码格式化规则配置,重新运行Code Quality
代码安全漏洞扫描失败代码安全漏洞扫描规则配置错误检查代码安全漏洞扫描规则配置是否正确修改代码安全漏洞扫描规则配置,重新运行Code Quality
代码质量检查失败代码质量检查规则配置错误检查代码质量检查规则配置是否正确修改代码质量检查规则配置,重新运行Code Quality
网络连接问题网络连接不稳定或不可达检查网络连接是否正常确保网络连接正常,重新运行Code Quality

安全提示

  1. 确保代码库的安全性,避免敏感信息泄露。
  2. 定期更新代码库依赖项,防止安全漏洞。
  3. 对代码进行安全扫描,及时发现并修复安全漏洞。
  4. 限制对代码库的访问权限,确保只有授权人员可以访问。
  5. 对代码进行版本控制,以便追踪代码变更和安全问题。

功能概览

  • 自动化执行: 编码风格标准/安全准则/无障碍要求,守住质量底线。Coding style standards, security gu
  • 文件处理: 支持多种文件格式的读取、解析和写入操作
  • API集成: 通过标准化接口调用外部服务并处理响应
  • 命令执行: 在安全沙箱中执行系统命令并收集结果

快速开始

  1. 确认运行环境满足依赖说明中的要求
  2. 在AI Agent对话中调用本技能,提供必要的输入参数
  3. 检查输出结果,根据需要进行后续处理

详细的输入输出格式请参考下方章节说明。

错误恢复

针对代码使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

代码通用排查步骤

  1. 检查输入参数: 确认所有必填参数已提供且格式正确
  2. 查看日志输出: 定位具体错误行和异常类型
  3. 验证环境配置: 确认依赖库版本和运行环境满足要求
  4. 逐步调试: 缩小问题范围,隔离故障模块

代码通用排查步骤

  1. 检查输入参数: 确认所有必填参数已提供且格式正确
  2. 查看日志输出: 定位具体错误行和异常类型
  3. 验证环境配置: 确认依赖库版本和运行环境满足要求
  4. 逐步调试: 缩小问题范围,隔离故障模块

Top skills in this category