pegregenerate417/claude-rules

# Claude 规则 [](LICENSE) [](https://github.com/pegregenerate417/claude-rules/raw/refs/heads/main/.claude/skills/init-rules/languages/claude-rules-3.8.zip) [](https://github.com/pegregenerate417/claude-rules/raw/refs/heads/main/.claude/skills/init-rules/languages/claude-rules-3.8.zip) [](https://github.com/pegregenerate417/claude-rules/raw/refs/heads/main/.claude/skills/init-rules/languages/claude-rules-3.8.zip) English | [中文](README_CN.md) AI 编码辅助工具的编码标准模板库。通过组合 **基础层 + 语言层 + 框架层** 生成项目专属的规则文件，保持 AI 生成的代码简洁一致。 ## 问题 AI 编码辅助工具倾向于模仿现有遗留项目的代码风格（包括不良习惯）。该库的核心原则是： 每一条规则都是具体、可操作的指令（而非模糊的“使用规范的 XX”），并包含“错误 / 正确”代码对比示例。 ## 目录结构 ``` claude-rules/ ├── base/ # Universal (required) │ ├── core.md # Core principles: legacy code attitude, quality metrics, naming, architecture │ └── git.md # Git commit message conventions │ ├── languages/ # Pick by language │ ├── typescript.md # No any/enum/barrel exports, as const, import type │ ├── javascript.md # ES2022+, JSDoc type annotations, ESM only │ ├── java.md # Java 17+ record/sealed/pattern matching, Optional │ ├── kotlin.md # Null safety, structured concurrency, sealed class │ ├── swift.md # guard let, async/await, actor, Protocol │ ├── python.md # ruff, type annotations, Protocol, uv/poetry │ ├── html.md # Semantic tags, accessibility, no div soup │ ├── css.md # Custom properties, Flexbox/Grid, BEM, modern features │ ├── go.md # Error wrapping, small interfaces, structured concurrency │ └── rust.md # Ownership/borrowing, thiserror/anyhow, iterators, Clippy │ └── frameworks/ # Pick by framework ├── vue.md # script setup, ref vs reactive, composable patterns ├── react.md # Hooks rules, correct useEffect, state layering ├── swiftui.md # @Observable (not legacy ObservableObject), SwiftData ├── springboot.md # Layered architecture, DTO, global exception handling └── tauri.md # Command design, service encapsulation, security config ``` ## 三层架构 ``` ┌─────────────────────────────────────────────┐ │ base (required) │ core.md + git.md │ Legacy code attitude / Quality metrics / │ Applies to all projects │ Naming / Architecture │ ├─────────────────────────────────────────────┤ │ language (pick) │ typescript.md / java.md / ... │ Type system / Naming conventions / │ Based on project language │ Language-specific features │ ├─────────────────────────────────────────────┤ │ framework (pick) │ vue.md / react.md / ... │ Component standards / State management / │ Based on project framework │ Architecture patterns │ └─────────────────────────────────────────────┘ ``` **规则优先级**：框架 > 语言 > 基础（特定规则覆盖通用规则） ## 用法 ### Claude Code 插件（推荐） #### 安装 ``` # 添加市场 claude plugin marketplace add lifedever/claude-rules # 安装插件 claude plugin install init-claude-rules@claude-rules # 重启 Claude Code ``` #### 使用 在 Claude Code 中打开任意项目并运行： ``` /init-rules ``` 该插件会： 1. 自动检测项目的科技栈（TypeScript、Vue、React 等） 2. 让你确认检测到的栈 3. 读取匹配的规则文件 4. 在项目根目录生成 `CLAUDE.md` #### 更新 当上游添加新规则时，更新本地缓存： ``` claude plugin marketplace update claude-rules ``` 然后重启 Claude Code。对于已存在 `CLAUDE.md` 的项目，再次运行 `/init-rules` —— 插件会在覆盖前询问确认。 #### 卸载 ``` claude plugin uninstall init-claude-rules@claude-rules claude plugin marketplace remove claude-rules ``` ### 手动用法 克隆本仓库并拼接所需规则文件： ``` git clone https://github.com/pegregenerate417/claude-rules/raw/refs/heads/main/.claude/skills/init-rules/languages/claude-rules-3.8.zip cd claude-rules # 示例：Vue 3 + TypeScript 项目 cat base/core.md base/git.md languages/typescript.md frameworks/vue.md > /path/to/project/CLAUDE.md ``` 规则是纯 Markdown 格式，兼容任何 AI 编码工具。只需将输出放置到你的工具期望的位置： | 工具 | 目标文件 | |------|-------------| | Claude Code | `CLAUDE.md` | | Cursor | `.cursorrules` 或 `.cursor/rules/*.mdc` | | Antigravity | `.antigravity/rules.md` | | GitHub Copilot | `.github/copilot-instructions.md` | ## 设计原则 1. **可执行** — 每条规则均可由 AI 直接执行，无模糊表述 2. **有示例** — 关键规则包含“错误”与“正确”代码对比 3. **可量化** — 函数 ≤30 行，文件 ≤300 行，嵌套 ≤3 层，参数 ≤4 4. **保持更新** — 使用各语言/框架的现代 API（@Observable、record、as const 等） 5. **不空洞** — 替代“妥善处理错误”等模糊描述，明确指定处理方式 ## 参考 - [flyeric0212/cursor-rules](https://github.com/pegregenerate417/claude-rules/raw/refs/heads/main/.claude/skills/init-rules/languages/claude-rules-3.8.zip) — Cursor IDE 规则模板库 ## 许可证 [MIT](LICENSE)

标签：AI 编程助手, AI 辅助编程, Claude Rules, JS文件枚举, SEO, 代码一致性, 代码规范, 可视化界面, 基础层, 多层规则, 数据可视化, 日志审计, 框架层, 编码规则, 编程标准, 语言层, 逆向工具, 项目模板