dzz-openspec-shared-standards

满帮 OpenSpec 公共约束库，为 AI 编码助手提供公司统一的编码规范。

设计理念

规范内容只维护一份（rules/），安装时根据选择的 AI 工具分发到对应的原生规则目录：

| 工具 | 规则目录 | |------|---------| | Claude Code | .claude/rules/ | | Trae | .trae/rules/ |

文档导航

| 文档 | 说明 | |------|------| | 快速开始 | 安装与初始化指南 | | NPM 发布指南 | 版本发布流程（维护者） |

快速开始

cd your-project
npx dzz-openspec-shared-standards@latest init

前置条件：Node.js 12.0.0+

详细说明请参考 快速开始。

安装后的项目结构

以选择 Claude Code 为例：

your-project/
├── .claude/rules/              # 编码规范（由本包管理）
│   ├── architecture.md
│   ├── api.md
│   ├── code-style.md
│   ├── database.md
│   └── ...
└── openspec/                   # 工作流定义
    ├── config.yaml
    └── schemas/java-backend/

本项目源码结构

dzz-openspec-shared-standards/
├── package.json
├── rules/                          # 编码规范（单一数据源）
│   ├── architecture.md
│   ├── api.md
│   ├── code-style.md
│   └── ...
├── openspec/                       # OpenSpec 工作流
│   ├── config.yaml
│   └── schemas/java-backend/
│       ├── schema.yaml
│       └── templates/
├── lib/                           # CLI 和安装脚本
│   ├── cli.js                     # CLI 入口
│   ├── init.js                    # 安装主流程
│   ├── claude-code.js             # Claude Code 适配器
│   └── trae.js                    # Trae 适配器
└── docs/
    ├── getting-started.md
    └── npm-publish-guide.md

包含的规范

| 规范 | 说明 | |------|------| | _priority | 规范优先级原则（最高优先级） | | architecture | 分层架构、模块组织、工程拆分 | | api | REST/RPC 接口设计 | | code-style | 代码风格、命名、注释 | | database | 数据库设计、SQL 编写 | | error-handling | 异常处理 | | java-fundamentals | Java 基础编码规范 | | security | 安全规范 | | performance | 性能优化 | | concurrency | 并发与线程安全 | | distributed | 分布式与幂等 | | middleware | 中间件选型 | | model | 领域模型 | | logging | 日志规范 | | testing | 测试规范 | | lion | 配置中心 | | elasticsearch | ES 使用规范 | | git | 版本控制 | | job | 定时任务 |