整洁代码规范指南 - 实用AI编码标准与最佳实践

clean-code by vudovn/antigravity-kit

147 周安装量

7,000 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/vudovn/antigravity-kit --skill clean-code

AI/机器学习开发代码规范

🇨🇳中文介绍

整洁代码 - 实用 AI 编码标准

关键技能 - 做到简洁、直接、以解决方案为中心。

核心原则

原则	规则
SRP	单一职责 - 每个函数/类只做一件事
DRY	不要重复自己 - 提取重复项，复用代码
KISS	保持简单 - 使用可行的最简单解决方案
YAGNI	你不需要它 - 不要构建未使用的功能
童子军规则	让代码比你发现时更整洁

命名规则

元素	约定
变量	揭示意图：用而不是

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

规则	描述
短小	最多 20 行，理想情况 5-10 行
一件事	做好一件事
一个层级	每个函数一个抽象层级
参数少	最多 3 个参数，最好 0-2 个
无副作用	不要意外地修改输入

模式	应用
卫语句	对边界情况使用提前返回
扁平优于嵌套	避免深度嵌套（最多 2 层）
组合	将小函数组合在一起
就近原则	将相关代码放在一起

情境	操作
用户请求功能	直接编写代码
用户报告错误	修复它，不要解释
需求不明确	询问，不要假设

反模式（禁止）

❌ 模式	✅ 修复
注释每一行	删除显而易见的注释
为单行代码写辅助函数	内联代码
为两个对象创建工厂	直接实例化
只有一个函数的 `utils.ts`	将代码放在使用的地方
"首先我们导入..."	直接写代码
深度嵌套	使用卫语句
魔法数字	使用命名常量
上帝函数	按职责拆分

🔴 编辑任何文件之前（先思考！）

在更改文件之前，问自己：

问题	原因
哪些文件导入了此文件？	它们可能会出错
此文件导入了哪些文件？	接口可能会改变
哪些测试覆盖了此文件？	测试可能会失败
这是一个共享组件吗？	多个地方会受影响

File to edit: UserService.ts
└── Who imports this? → UserController.ts, AuthController.ts
└── Do they need changes too? → Check function signatures

🔴 规则： 在同一个任务中编辑文件 + 所有依赖文件。 🔴 永远不要留下损坏的导入或缺失的更新。

要做	不要做
直接编写代码	编写教程
让代码自我说明	添加显而易见的注释
立即修复错误	先解释如何修复
内联小东西	创建不必要的文件
清晰地命名事物	使用缩写
保持函数短小	编写 100+ 行的函数

记住：用户想要的是可工作的代码，而不是编程课。

🔴 完成前自检（强制）

在说"任务完成"之前，验证：

检查项	问题
✅ 目标达到了吗？	我是否完全按照用户的要求做了？
✅ 文件编辑了吗？	我是否修改了所有必要的文件？
✅ 代码能工作吗？	我是否测试/验证了更改？
✅ 没有错误吗？	Lint 和 TypeScript 通过了吗？
✅ 没有遗漏吗？	有没有遗漏任何边界情况？

🔴 规则： 如果任何一项检查失败，请在完成前修复它。

验证脚本（强制）

🔴 关键： 每个智能体在完成工作后只运行自己技能的脚本。

智能体 → 脚本映射

智能体	脚本	命令
frontend-specialist	UX 审计	`python .agent/skills/frontend-design/scripts/ux_audit.py .`
frontend-specialist	A11y 检查	`python .agent/skills/frontend-design/scripts/accessibility_checker.py .`
backend-specialist	API 验证器	`python .agent/skills/api-patterns/scripts/api_validator.py .`
mobile-developer	移动端审计	`python .agent/skills/mobile-design/scripts/mobile_audit.py .`
database-architect	模式验证	`python .agent/skills/database-design/scripts/schema_validator.py .`
security-auditor	安全扫描	`python .agent/skills/vulnerability-scanner/scripts/security_scan.py .`
seo-specialist	SEO 检查	`python .agent/skills/seo-fundamentals/scripts/seo_checker.py .`
seo-specialist	GEO 检查	`python .agent/skills/geo-fundamentals/scripts/geo_checker.py .`
performance-optimizer	Lighthouse	`python .agent/skills/performance-profiling/scripts/lighthouse_audit.py <url>`
test-engineer	测试运行器	`python .agent/skills/testing-patterns/scripts/test_runner.py .`
test-engineer	Playwright	`python .agent/skills/webapp-testing/scripts/playwright_runner.py <url>`
Any agent	Lint 检查	`python .agent/skills/lint-and-validate/scripts/lint_runner.py .`
Any agent	类型覆盖率	`python .agent/skills/lint-and-validate/scripts/type_coverage.py .`
Any agent	i18n 检查	`python .agent/skills/i18n-localization/scripts/i18n_checker.py .`

❌ 错误： test-engineer 运行 ux_audit.py ✅ 正确： frontend-specialist 运行 ux_audit.py

🔴 脚本输出处理（读取 → 总结 → 询问）

运行验证脚本时，你必须：

运行脚本 并捕获所有输出
解析输出 - 识别错误、警告和通过项
向用户总结，格式如下：

## Script Results: [script_name.py]

### ❌ Errors Found (X items)
- [File:Line] Error description 1
- [File:Line] Error description 2

### ⚠️ Warnings (Y items)
- [File:Line] Warning description

### ✅ Passed (Z items)
- Check 1 passed
- Check 2 passed

**Should I fix the X errors?**

4. 等待用户确认 后再进行修复 5. 修复后 → 重新运行脚本以确认

🔴 违规： 运行脚本但忽略输出 = 任务失败。 🔴 违规： 未经询问自动修复 = 不允许。 🔴 规则： 始终遵循读取输出 → 总结 → 询问 → 然后修复。

🇺🇸English

Clean Code - Pragmatic AI Coding Standards

CRITICAL SKILL - Be concise, direct, and solution-focused.

Core Principles

Principle	Rule
SRP	Single Responsibility - each function/class does ONE thing
DRY	Don't Repeat Yourself - extract duplicates, reuse
KISS	Keep It Simple - simplest solution that works
YAGNI	You Aren't Gonna Need It - don't build unused features
Boy Scout	Leave code cleaner than you found it

Naming Rules

Element	Convention
Variables	Reveal intent: `userCount` not `n`
Functions	Verb + noun: `getUserById()` not `user()`
Booleans	Question form: `isActive`, `hasPermission`, `canEdit`
Constants	SCREAMING_SNAKE: `MAX_RETRY_COUNT`

Rule: If you need a comment to explain a name, rename it.

Function Rules

Rule	Description
Small	Max 20 lines, ideally 5-10
One Thing	Does one thing, does it well
One Level	One level of abstraction per function
Few Args	Max 3 arguments, prefer 0-2
No Side Effects	Don't mutate inputs unexpectedly

Code Structure

Pattern	Apply
Guard Clauses	Early returns for edge cases
Flat > Nested	Avoid deep nesting (max 2 levels)
Composition	Small functions composed together
Colocation	Keep related code close

AI Coding Style

Situation	Action
User asks for feature	Write it directly
User reports bug	Fix it, don't explain
No clear requirement	Ask, don't assume

Anti-Patterns (DON'T)

❌ Pattern	✅ Fix
Comment every line	Delete obvious comments
Helper for one-liner	Inline the code
Factory for 2 objects	Direct instantiation
utils.ts with 1 function	Put code where used
"First we import..."	Just write code
Deep nesting	Guard clauses
Magic numbers	Named constants
God functions	Split by responsibility

🔴 Before Editing ANY File (THINK FIRST!)

Before changing a file, ask yourself:

Question	Why
What imports this file?	They might break
What does this file import?	Interface changes
What tests cover this?	Tests might fail
Is this a shared component?	Multiple places affected

Quick Check:

File to edit: UserService.ts
└── Who imports this? → UserController.ts, AuthController.ts
└── Do they need changes too? → Check function signatures

🔴 Rule: Edit the file + all dependent files in the SAME task. 🔴 Never leave broken imports or missing updates.

Summary

Do	Don't
Write code directly	Write tutorials
Let code self-document	Add obvious comments
Fix bugs immediately	Explain the fix first
Inline small things	Create unnecessary files
Name things clearly	Use abbreviations
Keep functions small	Write 100+ line functions

Remember: The user wants working code, not a programming lesson.

🔴 Self-Check Before Completing (MANDATORY)

Before saying "task complete", verify:

Check	Question
✅ Goal met?	Did I do exactly what user asked?
✅ Files edited?	Did I modify all necessary files?
✅ Code works?	Did I test/verify the change?
✅ No errors?	Lint and TypeScript pass?
✅ Nothing forgotten?	Any edge cases missed?

🔴 Rule: If ANY check fails, fix it before completing.

Verification Scripts (MANDATORY)

🔴 CRITICAL: Each agent runs ONLY their own skill's scripts after completing work.

Agent → Script Mapping

Agent	Script	Command
frontend-specialist	UX Audit	`python .agent/skills/frontend-design/scripts/ux_audit.py .`
frontend-specialist	A11y Check	`python .agent/skills/frontend-design/scripts/accessibility_checker.py .`
backend-specialist	API Validator	`python .agent/skills/api-patterns/scripts/api_validator.py .`
mobile-developer	Mobile Audit	`python .agent/skills/mobile-design/scripts/mobile_audit.py .`

❌ WRONG: test-engineer running ux_audit.py ✅ CORRECT: frontend-specialist running ux_audit.py

🔴 Script Output Handling (READ → SUMMARIZE → ASK)

When running a validation script, you MUST:

Run the script and capture ALL output
Parse the output - identify errors, warnings, and passes
Summarize to user in this format:

## Script Results: [script_name.py]

### ❌ Errors Found (X items)
- [File:Line] Error description 1
- [File:Line] Error description 2

### ⚠️ Warnings (Y items)
- [File:Line] Warning description

### ✅ Passed (Z items)
- Check 1 passed
- Check 2 passed

**Should I fix the X errors?**

4. Wait for user confirmation before fixing 5. After fixing → Re-run script to confirm

🔴 VIOLATION: Running script and ignoring output = FAILED task. 🔴 VIOLATION: Auto-fixing without asking = Not allowed. 🔴 Rule: Always READ output → SUMMARIZE → ASK → then fix.

Weekly Installs

139

Repository

vudovn/antigravity-kit

GitHub Stars

6.6K

First Seen

Jan 21, 2026

Security Audits

Gen Agent Trust HubWarn SocketPass SnykWarn

Installed on

gemini-cli113

opencode105

codex103

cursor92

github-copilot91

antigravity88

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

122,000 周安装