用途:这是一套给 AI 编码使用的务实编码规范(Clean Code),核心理念是简洁、直接、聚焦解决方案,要求 AI 写可用代码而非写教程。
主要能力与规范要点: 1)核心原则:单一职责(每个函数/类只做一件事)、DRY(抽取重复并复用)、KISS(用能跑通的最简方案)、YAGNI(不做用不到的功能)、Boy Scout(改代码时让它比原来更整洁)。 2)命名:变量体现意图(如 userCount 而非 n);函数用动词+名词(getUserById());布尔值用疑问式(isActive、hasPermission、canEdit);常量用 SCREAMING_SNAKE(MAX_RETRY_COUNT)。若需要注释解释命名,就重命名。 3)函数规则:小(最多 20 行,理想 5-10 行)、只做一件事、单一抽象层级、参数最多 3 个(优选 0-2)、不意外修改输入。 4)代码结构:用卫语句处理边界提前返回、避免超过 2 层嵌套、小函数组合、相关代码就近放置。 5)AI 编码风格:用户要功能就直接写;用户报 bug 就直接修不先解释;需求不清就问而非假设。 6)反模式:不逐行注释、不为一行代码建辅助函数、不为两个对象搞工厂、不把单函数放进 utils.ts、不写“首先我们导入……”式叙述、不用深度嵌套、不用魔法数字、不写上帝函数。 7)改文件前先想:谁导入了这个文件、它导入了什么、有哪些测试覆盖、是否为共享组件;要求在同一任务内修改该文件及其所有依赖文件,绝不留下断裂的导入。 8)完成前自检:目标是否达成、必要文件是否都改了、代码是否验证可用、lint 与 TypeScript 是否通过、是否漏掉边界情况;任一不通过就先修再交付。 9)验证脚本(强制性):各角色只运行本技能对应的脚本。例如前端:python ~/.claude/skills/frontend-design/scripts/ux_audit.py . 与 python ~/.claude/skills/frontend-design/scripts/accessibility_checker.py .;后端:python ~/.claude/skills/api-patterns/scripts/api_validator.py .;移动端:python ~/.claude/skills/mobile-design/scripts/mobile_audit.py .;数据库:python ~/.claude/skills/database-design/scripts/schema_validator.py .;安全:python ~/.claude/skills/vulnerability-scanner/scripts/security_scan.py .;SEO:python ~/.claude/skills/seo-fundamentals/scripts/seo_checker.py . 与 python ~/.claude/skills/geo-fundamentals/scripts/geo_checker.py .;性能:python ~/.claude/skills/performance-profiling/scripts/lighthouse_audit.py <url>;测试:python ~/.claude/skills/testing-patterns/scripts/test_runner.py . 与 python ~/.claude/skills/webapp-testing/scripts/playwright_runner.py <url>;任意角色:python ~/.claude/skills/lint-and-validate/scripts/lint_runner.py .、python ~/.claude/skills/lint-and-validate/scripts/type_coverage.py .、python ~/.claude/skills/i18n-localization/scripts/i18n_checker.py . 10)脚本输出处理:必须读取全部输出、解析错误/警告/通过项,按“错误—警告—通过”格式汇总,并询问用户是否修复;未确认前不得自动修复,修复后需重跑脚本确认。忽略输出或未经询问即自动修复均视为失败或违规。
适用场景:为 AI 编码工具或智能体提供统一编码规范与交付流程,适合需要代码整洁、改动可控的开发任务。
限制:资料未说明适用编程语言范围、安装方式、收费或价格、以及各脚本的具体参数与输出细节;脚本路径基于 ~/.claude 目录约定,实际可用性暂未提供。