SuperAPI AI 工具集

global-standards

编程与开发

查看项目

更新于 10-13 17:24

技能介绍

用途

global-standards 是一个项目级编码标准与约定技能,用于在整个代码库范围内提供统一的规范指导,不区分具体编程语言或框架。它适合在以下时机主动使用:编写代码、做出架构决策、新人入职了解约定、代码评审、重构,以及搭建新功能时保持一致性。

六大核心标准领域

1. 编码风格

适用于变量、函数、类、模块或文件的命名,代码结构与可读性,函数规模与单一职责,清理未使用代码与死导入,抽取可复用逻辑,统一格式与缩进,以及简化重构。 原则:名称清晰且表达意图;遵循 DRY(不要重复自己);遵循单一职责原则;通过结构实现自文档化;代码库格式一致。 适用文件类型:.py、.js、.ts、.jsx、.tsx、.vue、.rb、.go、.java、.rs、.cpp、.c、.swift、.kt。

2. 注释标准

适用于判断代码是否需要注释、说明复杂算法或不明显的业务逻辑、编写 docstring 或函数文档、审查已有注释的相关性、移除过时或误导性注释、解释非显而易见的决策或变通方案。 原则:注释保持最少且有用;解释“为什么”而非“做了什么”;通过清晰命名让代码自文档化;注释应说明复杂逻辑或业务规则;避免复述代码行为的注释;保持注释长期有效且相关。 适用:整个代码库中的所有代码文件。

3. 错误处理

适用于 try-catch/try-except 包裹、自定义异常或错误类、错误边界(如 React)、HTTP 错误处理、面向用户的错误提示、带指数退避的重试逻辑、finally 中资源清理、判断捕获还是传播错误、按严重级别记录日志、外部服务熔断、结构化校验错误响应。 原则:面向用户的友好错误信息;恰当的异常类型与层级;优雅降级;带上下文的完整日志;finally 中清理资源;合理的错误传播;对瞬时故障进行重试。 适用:所有可能抛出错误的代码,如 API 处理器、服务函数、数据处理、文件操作、外部集成、网络请求、数据库操作。

4. 输入校验

适用于前端表单校验、API 请求体/查询参数/请求头校验、服务端校验逻辑、创建校验 schema(Zod、Yup、Pydantic、Joi)、防止 XSS 与 SQL 注入的输入清洗、数据类型/格式/范围/必填校验、业务规则校验、校验错误提示、领域自定义校验器、文件上传校验。 原则:客户端与服务端双重校验;使用校验库保证一致性;清洗输入以防安全漏洞;提供清晰可执行的错误信息;在系统边界处校验;使用允许列表而非阻止列表。 适用:表单组件、API 处理器、请求校验器、输入清洗器、schema 定义、校验中间件、文件上传、webhook、外部 API 集成。

5. 技术栈一致性

适用于为新功能选择库或包、按框架特定模式实现功能、搭建新服务/集成/第三方 API、配置数据库连接/ORM/查询构建器、添加认证授权与安全功能、搭建测试框架与工具、配置部署/CI/CD/基础设施、评估是否引入新依赖、实现缓存/监控/日志/可观测性、在多种方案间做选择。 原则:与现有技术选型保持一致;遵循框架特定模式与惯用法;优先复用现有工具而非新增依赖;记录技术决策;保持架构一致性。 适用:前端、后端、数据库、基础设施、测试、部署、第三方集成。

6. 项目约定

适用于组织文件与目录结构、编写 git 提交信息或 PR 描述、管理环境变量/配置/密钥、新增或更新依赖、设置或修改 CI/CD 工作流、实现功能开关、更新 README 或项目文档、建立代码评审流程、维护 changelog 或发布说明、配置 linter/formatter/pre-commit 钩子、搭建开发环境、管理 monorepo 或多包结构。 原则:一致的文件与目录组织;约定式提交信息;清晰的文档;恰当的依赖管理;自动化质量检查;清晰的开发工作流。 适用:配置文件(.env、package.json、requirements.txt、pyproject.toml、Dockerfile、docker-compose.yml、Makefile)、目录(.github/、.gitlab-ci/、scripts/、docs/)、文档文件(README.md、CHANGELOG.md、CONTRIBUTING.md)。

参考文件

需要详细标准文档时可按需加载:references/coding-style.md(编码风格、命名、格式)、references/commenting.md(注释最佳实践、docstring 标准)、references/error-handling.md(错误处理模式、异常层级、日志策略)、references/validation.md(校验模式、schema 定义、安全考量)、references/tech-stack.md(技术栈参考、框架模式、依赖指南)、references/conventions.md(项目约定、文件结构、git 工作流、CI/CD 标准)。处理具体领域时加载对应参考文件即可。

最佳实践

一致性优先:遵循代码库现有模式;犹豫时匹配周边代码风格;在所有文件中保持一致。 渐进增强:从简单清晰的代码开始;仅在必要时增加复杂度;为清晰与可维护性重构。 文档:保持文档最新;记录决策与权衡;在文档中包含示例。 质量关卡:使用 linter 与 formatter;提交前运行测试;评审代码是否符合标准。

与其他技能的集成

code-review:评审代码是否符合标准时使用; dead-code-removal:清理代码时遵循编码风格; debugging:分析错误时应用错误处理标准; dependency-management:管理依赖时遵循技术栈标准。

限制

具体安装命令与价格信息暂未提供。