clean-code
代码质量诊断与重构指南。当被要求做 clean code、提升代码质量、重构函数/模块、降低复杂度、消除嵌套、精简参数、拆分过长函数,或讨论圈复杂度、认知复杂度、卫语句、配置对象、状态机、查表等 clean code 子话题时应用。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
代码质量诊断与重构指南。当被要求做 clean code、提升代码质量、重构函数/模块、降低复杂度、消除嵌套、精简参数、拆分过长函数,或讨论圈复杂度、认知复杂度、卫语句、配置对象、状态机、查表等 clean code 子话题时应用。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
组件库测试用例编写指南。当被要求为组件加测试用例、调试测试失败、补响应式/SSR/视觉断言、理解项目测试约定、判断某个维度应该放哪个文件测、或讨论 vitest browser mode / vitest-browser-vue / 测试方法论时应用。涵盖:静态契约、动态契约、视觉 wiring、响应式断点、SSR 水合、暴露方法、插槽、子配置等维度。
组件文档与注释规范指南。涉及 types.ts JSDoc 注释、@since/@deprecated/@experimental 标签、行内标签语法 ^[]()``、@en-US 翻译补译、运行时废弃警告、provide/inject 注入键导出评估、__case__ Demo 编写、Usage playground、<docs lang="md"> 中英分区、文档页面编写、CSS 变量表维护、gen:api 流程时触发。只要在写组件注释、添加新 prop、写 demo case、编辑 index.md 文档、使用行内标签、运行 gen:api,都应主动使用此 skill。
Release Note 生成指南。当被要求写 release note、生成版本日志、更新 changelog、总结版本变更、确认版本号、归类 feat/fix/breaking change/style 变更、处理 sp 版本、发布 scripts 包版本日志时应用。
| name | clean-code |
| description | 代码质量诊断与重构指南。当被要求做 clean code、提升代码质量、重构函数/模块、降低复杂度、消除嵌套、精简参数、拆分过长函数,或讨论圈复杂度、认知复杂度、卫语句、配置对象、状态机、查表等 clean code 子话题时应用。 |
| metadata | {"version":"1.1.0"} |
触发场景: clean code / 代码质量 / 重构函数或模块 / 降低复杂度 / 消除嵌套 / 参数过多 / 函数体过长 / 圈复杂度 / 认知复杂度 / 卫语句 / 查表 / 状态机 / 拆分 composable
关联 skill: 涉及组件
types.tsJSDoc 注释质量(中文注释完整性、参数说明规范)时,参见component-docsskill 的annotations.md。clean-code 侧重代码结构质量,component-docs 侧重 API 文档注释规范——两者互为补充。
所有问题必须由 ESLint 报告,禁止用模型阅读代码后自行估算。 模型心算容易漏计分支、误判运算符,结论不可信。
在做任何分析或重构之前,先跑:
pnpm exec eslint --config packages/skills/clean-code/eslint.diagnose.ts <目标文件路径>
输出不含格式/类型等无关警告,便于直接阅读。根据 warning 的规则名查找对应参考文档:
| 规则名 | 含义 | 参考文档 |
|---|---|---|
local/cumulative-complexity | 函数累计圈复杂度(含嵌套闭包)超限 | reduce-complexity.md |
max-depth | 嵌套层数过深 | guard-clause.md |
max-lines-per-function | 函数体行数过长 | split-composable.md |
max-params | 参数超过 3 个 | config-object.md |
只有出现在 ESLint 输出中的问题才是重构目标,其余不处理。
认知复杂度无 ESLint 规则检测,需人工判断。当代码存在嵌套条件难读、复杂布尔表达式、嵌套三元、Promise 链嵌套、多层循环等问题时,直接参考 reduce-complexity.md 手法六~十。
1. pnpm exec eslint --config packages/skills/clean-code/eslint.diagnose.ts <文件>
← 取得全部问题列表(唯一可信来源)
2. 按规则名查上方映射表,打开对应参考文档
3. 按参考文档选择手法重构
4. 重复步骤 1 ← 验证全部消除
5. 若仍有报告,回到步骤 3
不允许跳过步骤 1 直接进入步骤 3。 即使模型已读取文件,也必须先运行 ESLint,以实际输出为准决定重构范围。
重构完成后,再次运行诊断配置:
pnpm exec eslint --config packages/skills/clean-code/eslint.diagnose.ts <修改的文件路径>
读取结果的方式:
若仍存在报告,继续应用手法直到全部消除。