SuperAPI AI 工具集

coding-style

编程与开发

查看项目

更新于 10-15 21:09

技能介绍

用途:该技能记录 Kubb 仓库的编码约定、测试指南与 PR 检查清单,供贡献者与自动化流程在编写或评审代码时产出风格一致、质量稳定的改动。适用于提交或评审改动代码的 PR、向 monorepo 添加新包或功能、更新 CI/检查/格式化配置,以及新贡献者了解仓库约定。

主要能力:定义格式化、lint 与 TypeScript 约定;说明测试流程与 CI 预期;列出 PR 要求、changelog 更新与发布相关步骤;提供常见故障排查与恢复命令。

仓库事实:monorepo 由 pnpm workspaces 与 Turborepo 管理;仅 ESM(全仓库 type: "module");Node 版本 20;测试库为 Vitest;版本管理使用 Changesets;CI/CD 为 GitHub Actions。

编码约定:单引号、无分号(见 biome.json);偏好函数式写法;三元运算符只保留一层,嵌套条件改用 if/else 或抽成辅助函数。命名上文件与目录、变量与函数用 camelCase,类型与接口、React 组件用 PascalCase。TypeScript 模块解析为 "bundler",仅 ESM;禁止使用 any 或 as any,改用正确类型、泛型或 unknown/never;库用 .ts、React 组件用 .tsx、Vue 组件用 .vue;DTS 由 tsdown 管理;使用模块级 import 而非内联类型导入;通过 exports 映射与 typesVersions 保持公共 API 稳定;类型定义在文件根层级;对象方法用函数语法以支持 this。

测试:测试文件为 src 下的 *.test.ts 或 *.test.tsx;可用 pnpm test "<test name>" 运行指定测试;代码改动需新增或更新测试,必要时用 -u 更新快照;测试应聚焦、隔离、可重复、快速、清晰。移动文件或改导入后运行 pnpm lint && pnpm typecheck。

使用方式:提交或开 PR 前按顺序本地运行 pnpm run format、pnpm run lint、pnpm test、pnpm changeset、pnpm typecheck,即 format → lint → typecheck → test → changeset。PR 步骤:确保 pnpm format && pnpm lint、pnpm typecheck、pnpm test 本地通过;提交信息标题格式为 [<plugin-name>] <Title>;推送分支并向 main 开 PR;完整填写 PR 模板;用 pnpm changeset 添加 changeset;请求相关维护者评审;处理反馈;通过 CI 后合并。

限制:资料未提供该技能的具体安装方式、收费与平台支持信息。