SuperAPI AI 工具集

typescript-best-practices

编程与开发

查看项目

更新于 10-15 23:43

技能介绍

用途:为任何 .ts 或 .tsx 改动提供统一的 TypeScript 编写与重构基线,适用于编写、编辑、重构、审查 TypeScript/TSX 代码的场景。

主要能力:要求用 Zod 在边界一次性校验未类型化的 JSON,保持边界形状与内部领域形状分离;函数保持小而可组合,多参数时使用 params 对象,优先 function 声明;字符串、数字、URL、数组、字典、去重、过滤等基础逻辑应放入共享辅助文件并优先复用;用 null 表示稳定领域数据中的有意义缺失,undefined 仅用于可选输入和原始边界字段;优先显式边界错误而非防御性默认值;重构时保留最强既有类型,不因方便而放宽类型。

使用方式:做 TypeScript 改动前先阅读该技能;审查或审查并修复任务先读 references/review-and-fix-changes.md;项目自身约定优先于通用建议。重构后可用 jscpd 做重复代码冒烟测试,命令为:cd "$(git rev-parse --show-toplevel)" 后运行 bunx --yes jscpd --format typescript --pattern '**/*.ts' --gitignore --min-lines 12 --min-tokens 120 --max-lines 5000 --max-size 1mb --reporters console --exitCode 0 .;查找更小辅助逻辑重复时可将 --min-tokens 降至 60-80。

限制:除非用户明确要求,不新增或扩展代码注释,包括行注释、块注释、JSDoc、TODO 和注释掉的代码;现有注释若因改动过时,应删除而非改写。避免 JSON.parse(...) as Foo、Number(value) || 0、无产品理由的 trim().toLowerCase()、模糊的 sanitize*/normalize* 工具、跨文件重复的边界转换等。若代码似乎需要 as,应先寻找更安全的类型或校验方式。资料未提供具体收费、平台支持范围或效果数据。