SuperAPI AI 工具集

clean-code-javascript

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:审查和重构现代 JavaScript 与 TypeScript 代码,目标涵盖正确性、类型安全、清晰度、职责聚焦、受控副作用与健壮性。

主要能力:提供五份参考文档,按任务需要读取,不必默认全读;做全面审计时才读全五份。core-javascript.md 涉及运行时约束、命名、声明、函数、所有权、变更与副作用;typescript.md 涉及严格模式、运行时校验、类型收窄、状态建模、公开类型与受控的不安全逃逸;design-and-modules.md 涉及对象、封装、组合、类、务实的 SOLID、依赖、模块与复用;async-and-errors.md 涉及 Promise、并发、取消、异步迭代与错误模型;testing-and-refactoring.md 涉及行为测试、注释、自动化、死代码、增量验证与非机械式应用。

使用方式:先判断请求模式,纯审查请求不改文件,按严重程度报告问题并给出文件与行号证据,只运行有用的非破坏性校验。审查前了解运行时、package.json、模块系统、tsconfig、lint 与格式配置、测试设置、公开 API 约束和仓库约定;先通过测试、类型、调用点和可观察输入输出确定当前行为。审查顺序为:正确性与类型安全;命名、数据建模与控制流清晰度;仅在现有代码混合多种变更原因时拆分职责;收敛副作用并核对异步与错误语义;在重复概念稳定后再消除有害重复。选择能解决具体问题的最小重构,除非明确要求否则保持行为与兼容性;多种设计同样合理时沿用本地既有模式。运行项目已有的类型检查、lint、格式检查、测试和构建命令,报告被跳过或不可用的验证及剩余行为风险。

限制:把整洁代码原则当情境化启发式,而非打分规则;避免只为口号、减少行数或引入不受支持语法的重写;保留能让边界更安全或代码更清晰的合理例外。本技能是基于 Ryan McDermott 的 clean-code-javascript 的独立现代改编,原作品采用 MIT 许可,非其官方技能;上游完整 README 未随附,需通过来源链接阅读。