kld-sdd 1.0.0

package/README.md

@@ -0,0 +1,178 @@
+# kld-sdd
+
+KLD SDD OpenSpec 项目初始化工具 - 内置标准模版，一键初始化
+
+## 功能特性
+
+- 🚀 自动检测并安装 `openspec`
+- 📄 内置 openSpec 四文档标准模版（propose/spec/design/task）
+- 🛠️ 自动配置多种 AI 编辑器 (Cursor, Claude Code)
+- 📁 创建团队配置目录结构
+- 🔄 自动应用团队共享配置
+- 📝 智能更新 `.gitignore`
+
+## 安装
+
+### 全局安装（推荐）
+
+```bash
+npm install -g kld-sdd
+```
+
+### 使用 npx（无需安装）
+
+```bash
+npx kld-sdd
+```
+
+## 使用方法
+
+### 基本用法
+
+```bash
+# 完整初始化流程（自动安装 openspec + 复制模版 + 配置编辑器）
+kld-sdd-init
+
+# 跳过 openspec init 步骤
+kld-sdd-init --skip-openspec
+
+# 跳过复制内置模版
+kld-sdd-init --skip-template
+
+# 仅配置指定编辑器
+kld-sdd-init --tool cursor
+
+# 显示帮助
+kld-sdd-init --help
+```
+
+### 在项目中使用
+
+```bash
+# 进入项目目录
+cd your-project
+
+# 运行初始化
+kld-sdd-init
+```
+
+## 项目结构
+
+初始化后会创建以下目录结构：
+
+```
+your-project/
+├── openspec-templates/              # ✅ 内置 openSpec 四文档模版
+│   ├── propose.md
+│   ├── spec.md
+│   ├── design.md
+│   └── task.md
+├── team-configs/                    # 团队共享配置
+│   ├── cursor-commands/             # Cursor 自定义命令
+│   ├── claude-commands/             # Claude Code 自定义命令
+│   └── README.md
+├── team-schemas/                    # 团队自定义 schemas
+├── .cursor/commands/                # Cursor 命令（自动配置）
+├── .claude/commands/openspec/       # Claude 命令（自动配置）
+└── .gitignore                       # 自动更新
+```
+
+## 内置模版
+
+kld-sdd 内置了符合 openSpec 标准的四文档模版：
+
+| 模版文件 | 定位 | 质量红线 |
+|---------|------|---------|
+| `propose.md` | 业务意图（Why）与上下文总览 | 逻辑链路闭环，模块影响明确 |
+| `spec.md` | 业务场景与技术契约的"唯一真理" | 严禁模糊描述；约束必须量化 |
+| `design.md` | 业务维度的具体技术实现方案 | 严禁全局中间件；支持任务拆解 |
+| `task.md` | AI编码引擎的极小执行单元 | 5分钟可实现；100%覆盖spec/design |
+
+## 团队配置 workflow
+
+1. **架构师/TL** 将团队规范放入 `team-configs/` 目录
+2. **新成员** 克隆项目后运行 `kld-sdd-init`
+3. **自动完成**：安装 openspec → 复制模版 → 应用团队配置
+
+## 支持的 AI 编辑器
+
+| 编辑器 | 配置目录 | 状态 |
+|-------|---------|------|
+| Cursor | `.cursor/commands/` | ✅ 支持 |
+| Claude Code | `.claude/commands/openspec/` | ✅ 支持 |
+
+## 配置说明
+
+### team-configs 目录
+
+将团队自定义命令文件放入对应目录：
+
+```
+team-configs/
+├── cursor-commands/
+│   ├── opsx-propose.md
+│   ├── opsx-spec-fill.md
+│   └── opsx-check.md
+└── claude-commands/
+    ├── opsx-propose.md
+    └── opsx-check.md
+```
+
+### .gitignore 配置
+
+工具会自动添加以下配置：
+
+```gitignore
+# KLD SDD 个人配置 (保留团队配置)
+.cursor/commands/personal-*
+.claude/commands/personal-*
+
+# 但保留团队配置的占位目录
+!.cursor/commands/team-*
+!.claude/commands/team-*
+```
+
+## 程序化 API
+
+```javascript
+const { main, detectTools, applyTeamConfig, getTemplatePath } = require('kld-sdd');
+
+// 检测已安装的编辑器
+const tools = detectTools();
+console.log(tools); // ['cursor', 'claude']
+
+// 应用指定工具的团队配置
+applyTeamConfig('cursor');
+
+// 获取内置模版路径
+const templatePath = getTemplatePath();
+
+// 运行完整初始化流程
+main();
+```
+
+## 与 npm scripts 集成
+
+在 `package.json` 中添加：
+
+```json
+{
+  "scripts": {
+    "setup": "kld-sdd-init",
+    "setup:quick": "kld-sdd-init --skip-openspec",
+    "postinstall": "kld-sdd-init --skip-openspec"
+  }
+}
+```
+
+## 最佳实践
+
+1. **将 team-configs 纳入版本控制**，确保团队配置同步
+2. **新成员 onboarding** 只需运行 `npm install && npm run setup`
+3. **配置变更后** 重新运行 `kld-sdd-init` 即可更新
+4. **个人配置** 使用 `personal-` 前缀，避免与团队配置冲突
+5. **参考模版** 在 `openspec-templates/` 中查看标准格式
+
+## License
+
+MIT

package/bin/kld-sdd-init.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+/**
+ * KLD SDD 项目初始化工具
+ * 一键配置团队标准化开发环境，内置 openSpec 模版
+ */
+
+const { main } = require('../lib/init');
+
+main().catch(error => {
+  console.error('❌ 初始化失败:', error.message);
+  process.exit(1);
+});

package/index.js

@@ -0,0 +1,13 @@
+/**
+ * SDD OpenSpec Init - 项目初始化工具
+ * 
+ * 提供程序化 API 接口
+ */
+
+const { main, detectTools, applyTeamConfig } = require('./lib/init');
+
+module.exports = {
+  main,
+  detectTools,
+  applyTeamConfig
+};