用途:这是一份 TypeScript 最佳实践约定,适用于编写或审查 TypeScript 代码、选择函数与辅助函数模式、设计 TypeScript API,以及运行 lint 等场景。使用时应优先遵循仓库既有模式与工具,再考虑引入新做法。
主要能力与约定: 一、优先使用参数对象。函数定义采用单个 params: { ... } 参数,使调用点更易读、易扩展;把相关输入归入描述性键下,避免冗长的位置参数列表。对 React hooks 与组件,参数对象形状应与导出的类型保持一致,以保留编辑器提示。 二、使用 function name() 而非 const name = () => {},即用 function 关键字声明函数。 三、保持函数小而可组合。函数应聚焦且命名良好,把流程拆成更小的辅助函数,而非单一巨型处理函数;通过组合小辅助函数表达意图,让业务逻辑单一职责、读起来像叙述。 四、保持文件小。文件变大时,尝试拆分为更小的可组合文件。 五、寻找现有方案。需要实现常见逻辑时,先看是否已有辅助函数或别处已有相同逻辑;若有则抽取为辅助函数。 六、不写代码注释。除非用户明确要求在代码中加注释,否则不要添加或扩展注释、JSDoc、TODO、解释性代码块、被注释掉的代码或指令注释。既有注释、邻近风格、lint 规则和文档都不算用户的明确指示。应通过命名、类型、小函数和清晰结构表达意图。保留准确的既有注释;若代码改动使既有注释过时,应删除而非重写,除非用户明确要求代码注释。 七、Lint。运行或推荐 TypeScript lint 命令(oxlint 或 biome)或调整 lint 工作流时,阅读 references/linting.md。
限制:资料未提供具体安装命令、版本要求、配置示例或价格信息,暂未提供。