关于 typescript-coding-standards
面向 TypeScript 编写、审查和重构的编码技能,适用于前端、后端、Worker 和共享库。它优先遵循仓库本地要求,并按任务查阅相关指南,不要求引入新工具。
主要功能
- 01检查仓库本地指引
- 02按任务提供编码指南
- 03覆盖前后端规范
- 04限制变更范围
适用场景
- 01编写或审查 TypeScript
- 02重构函数与类型
- 03调整依赖或模块
- 04验证代码和测试
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ berachain/ skills --skill typescript-coding-standards安装后在 Claude Code 中输入/typescript-coding-standards确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/comments.mddependencies.mdfile-naming-and-size.mdmodules.mdreact.mdruntime.mdtesting.mdtooling.mdtypescript.md详细介绍
TypeScript 编码规范
在前端应用、后端服务、工作进程和共享库中编写、审查或重构 TypeScript 时,请遵循这些约定。
首先阅读目标仓库的 AGENTS.md、包脚本以及 lint/test 配置。明确的本地要求优先于这些通用默认规范。将改动限制在请求范围内;现有违规不构成在整个仓库中进行无关迁移的理由。
指南
编辑前,请阅读与改动相关的指南。
| 指南 | 阅读时机 |
|---|---|
| TypeScript 契约 | 编写或审查函数、参数、类型或常量时。 |
| 文件命名与大小 | 创建、重命名或拆分文件时。 |
| 注释与 JSDoc | 为函数、类型或不明显的逻辑编写文档时。 |
| 模块与组织 | 选择导出内容、导入边界或代码归属位置时。 |
| 依赖项与目录 | 添加或更新依赖项、包清单、目录或锁文件时。 |
| 运行时行为 | 处理错误、外部数据、服务依赖项或后端导入边界时。 |
| React 与 Next.js | 更改组件、回调或 Hook 时;仅在 Next.js 应用中阅读 Next.js 部分。 |
| 测试 | 判断测试是否有用、添加覆盖或审查断言时。 |
| 工具与验证 | 选择工具或验证代码改动时。 |
对于仅涉及后端的工作,可跳过 React 指南。使用使用方现有的工具和运行时约定;本技能不要求采用其他仓库的框架、格式化工具或依赖项。
评论
支持 Markdown