用途:指导 AI 智能体编写和审查高质量 TypeScript 代码,覆盖类型安全、不可变数据、错误处理、代码组织与架构模式。适用生成新 TS 代码、审查类型安全问题、创建模块/服务/组件、JS 迁移 TS、回答 TS 类型与模式问题、设计 API 或接口。不适用于纯 JavaScript、运行时错误调试(应使用调试工具)以及框架专属模式(React、Vue 等)。
主要能力:提供核心原则(优先类型安全,用 unknown 替代 any 并收窄;默认不可变,使用 readonly 与 ReadonlyArray;用 Result 类型与自定义错误类做类型化错误处理;一文件一概念、显式导出)、Quick Reference 对照表、Common Anti-Patterns 表,以及 references/ 下的类型系统、模式、架构深入文档和 assets/ 下的模板与 tsconfig 预设。
使用方式:先说调用语,如“Use typescript-best-practices to review ./src for type-safety issues and suggest fixes.”。典型流程:1) 对目标路径运行分析脚本取基线;2) 应用核心原则与 Quick Reference 修正;3) 用脚手架脚本生成新模块并复跑分析器确认。脚本命令:analyze.ts 用 deno run --allow-read scripts/analyze.ts <path> [--strict|--json|--fix-hints];generate-types.ts 用 deno run --allow-read --allow-write scripts/generate-types.ts <input> [--name <name>|--output <path>|--readonly|--interface];scaffold-module.ts 用 deno run --allow-read --allow-write scripts/scaffold-module.ts [--name <name>|--path <path>|--type service|util|component|hook|--with-tests]。
限制:三个脚本依赖本机 Deno 运行时,未安装 Deno 时检查无法运行,应回退为对照 Quick Reference 与反模式表手工审查;analyze.ts 在发现严重问题、路径不存在或未找到 TS 文件时退出码为 1;generate-types.ts 在 JSON 无效或写入失败时退出 1;scaffold-module.ts 在目标目录已存在或 --type 无效时退出 1。脚本为只读辅助(scaffold/generate 输出除外),分析器通过不能替代人工审查。JS→TS 迁移应从 assets/tsconfig-presets/ 严格预设起步,而非改后缀后逐错硬修。具体收费与价格暂未提供。