SuperAPI AI 工具集

style-guide-adherence

通用与其它

查看项目

更新于 10-16 05:42

技能介绍

用途:在写代码时强制统一风格,减少个人偏好带来的差异,降低阅读与评审成本。文中核心理念是“代码被读的次数多于被写”,优先顺序为:项目专属风格指南、可用的 Google 风格指南、语言社区最佳实践。

主要能力:按语言给出命名与格式约定,覆盖 TypeScript/JavaScript、Python、Go,并给出各语言 Google 指南链接(tsguide、pyguide、go、javaguide、cppguide、shellguide、htmlcssguide)。通用原则包括一致性、清晰、简单、文档(说明 why 而非 what)。

使用方式:按项目规范写代码;用自动格式化与检查工具,如 TS/JS 用 Prettier、ESLint,Python 用 Black、Pylint、Ruff,Go 用 gofmt、golangci-lint,Rust 用 rustfmt、clippy;可配置 .eslintrc.js、.prettierrc、pyproject.toml、.pylintrc、ruff.toml、.golangci.yml 与 pre-commit 钩子。提交前运行 format、lint、lint:fix,并核对命名、导入顺序、行宽等。

适用场景:多人协作、代码评审、需要统一风格的项目。限制:若项目规范与 Google 不同,应以项目为主;缺失信息如具体安装命令、版本要求、完整配置示例暂未提供。该技能由 issue-driven-development 与 comprehensive-review 应用。