@vincent119/go-copilot-rules 1.0.0

package/README.md

@@ -0,0 +1,176 @@
+# copilot-rules-kit
+
+集中維護的 **AI 助手產出規範套件**（for GitHub Copilot / VS Code Agent / 其他 LLM 協作工具）。
+目標：在多個專案之間 **統一生成規範、術語詞彙、與文件模板**，確保產出 **正確性、可維護性、與一致性**。
+
+> 適用情境：公司/團隊以 **git submodule** 或 **git subtree** 導入本套件至各個專案，並以 **tag 版本** 管理升級與回滾。
+
+- Repo：`https://github.com/vincent119/copilot-rules-kit`
+
+---
+
+## 🚀 快速開始（Go Copilot Skills）
+
+如果你只需要安裝 **Go 開發規範與 Skills**（`.agent_agy/` 目錄），請使用：
+
+```bash
+# NPX 一鍵安裝（推薦）
+npx @vincent119/go-copilot-rules
+
+# 或使用安裝腳本
+bash <(curl -s https://raw.githubusercontent.com/vincent119/copilot-rules-kit/main/scripts/quick-install.sh)
+```
+
+**支援的安裝選項**：
+- `--vscode` - 安裝到 VS Code Copilot 預設路徑（`.agent_agy/`）
+- `--cursor` - 安裝到 Cursor 預設路徑（`.cursor/skills/`）
+- `--skills "go-ddd,go-grpc"` - 只安裝特定 Skills
+- `--help` - 查看所有選項
+
+📖 **完整文件**：[.agent_agy/INSTALLATION.md](.agent_agy/INSTALLATION.md)
+
+---
+
+## 內容構成（中央規範倉庫）
+
+```text
+copilot-rules-kit/
+├── CHANGELOG.md
+├── LICENSE
+├── README.md
+├── copilot-chat-instructions.yaml
+├── copilot-instructions.md
+├── copilot-instructions.yaml
+├── instructions/
+│   ├── bash.instructions.md
+│   ├── go.instructions.md
+│   ├── helm.instructions.md
+│   ├── pulumi.instructions.md
+│   ├── python.instructions.md
+│   ├── ts.instructions.md
+│   └── yaml.instructions.md
+├── scripts/
+│   ├── merge_copilot_instructions.py
+│   ├── setup-copilot-submodule.sh
+│   ├── setup-copilot-subtree.sh
+│   ├── setup-pre-commit.sh
+│   └── vocabulary_scan.py
+└── standards/
+    ├── copilot-commit-message-instructions.md
+    ├── copilot-common.md
+    ├── copilot-instructions-extended.md
+    ├── copilot-pull-request-description-instructions.md
+    └── copilot-vocabulary.yaml
+```
+
+---
+
+## 消費端導入位置（推薦）
+
+> **建議導入位置：直接放在 `.github/` 目錄下**
+> 優點：Copilot 可直接讀取 `.github/copilot-instructions.md`；與 GitHub 生態一致。
+
+### A. 以 Git Submodule 導入（推薦：清楚版本邊界、易回滾）
+
+```bash
+# 於消費端專案根目錄執行，直接導入到 .github/
+git submodule add https://github.com/vincent119/copilot-rules-kit.git .github
+git submodule update --init --recursive
+
+#（可選）鎖定到特定版本 tag（例：v1.0.3）
+cd .github && git fetch --tags && git checkout v1.0.3 && cd -
+git add .gitmodules .github
+git commit -m "chore: add copilot-rules-kit@v1.0.3 as submodule"
+```
+
+**升版到新 tag：**
+
+```bash
+cd .github
+git fetch --tags
+git checkout v1.0.4
+cd -
+git add .github
+git commit -m "chore: upgrade copilot-rules-kit to v1.0.4"
+```
+
+**CI 注意事項：**
+
+```bash
+# CI 若需存取規範檔，請先同步子模組
+git submodule update --init --recursive
+```
+
+### B. 以 Git Subtree 導入（倉庫不帶 submodule 依賴）
+
+```bash
+git subtree add --prefix .github https://github.com/vincent119/copilot-rules-kit.git main --squash
+```
+
+**從上游拉取最新（同分支或 tag）：**
+
+```bash
+git subtree pull --prefix .github https://github.com/vincent119/copilot-rules-kit.git main --squash
+```
+
+---
+
+## 腳本使用說明（可於消費端直接使用）
+
+### 1) `scripts/setup-copilot-submodule.sh`
+
+**用途**：一鍵將本套件以 **submodule** 形式導入到消費端的 `.github/`，並鎖定到指定版本。
+
+**用法**：
+
+```bash
+# 預設導入到 .github 並鎖定 v1.0.3
+bash scripts/setup-copilot-submodule.sh
+
+# 自訂導入目錄與版本
+bash scripts/setup-copilot-submodule.sh .github v1.0.4
+```
+
+**行為**：
+
+- 新增子模組 → 初始化遞迴 → 抓取 tags → 切換至指定 tag
+- 將 `.gitmodules` 與目標目錄加入版本控制並建立提交
+
+### 2) `scripts/setup-copilot-subtree.sh`
+
+**用途**：一鍵以 **subtree** 方式導入到 `.github/`。
+
+**用法**：
+
+```bash
+# 導入 main 分支
+bash scripts/setup-copilot-subtree.sh
+
+# 指定前置目錄與來源 ref（分支或 tag）
+bash scripts/setup-copilot-subtree.sh .github v1.0.3
+```
+
+**行為**：
+
+- 以 `--squash` 壓縮上游歷史，保持消費端歷史乾淨
+
+### 3) `scripts/vocabulary_scan.py`
+
+**用途**：依 `standards/copilot-vocabulary.yaml` 執行術語掃描，提示黑名單或建議用語。
+
+**用法**：
+
+```bash
+python3 .github/scripts/vocabulary_scan.py \
+  --vocab .github/standards/copilot-vocabulary.yaml \
+  --paths "docs/**/*.md" "src/**/*.go" "src/**/*.ts"
+```
+
+**輸出**：
+
+- 發現黑名單：`[DISALLOWED] <詞> in <檔案>`
+- 提示建議改寫：`[SUGGEST] <錯> → <正> in <檔案>`---
+
+## 授權
+
+MIT（詳見 `LICENSE`）。

package/cli/install.js

@@ -0,0 +1,344 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+// 顏色定義
+const colors = {
+  reset: '\x1b[0m',
+  red: '\x1b[31m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  blue: '\x1b[34m',
+  cyan: '\x1b[36m'
+};
+
+function log(message, color = 'reset') {
+  console.log(`${colors[color]}${message}${colors.reset}`);
+}
+
+function detectIDE() {
+  const cwd = process.cwd();
+  const homeDir = require('os').homedir();
+
+  // 檢查是否在專案目錄中
+  if (fs.existsSync(path.join(cwd, '.kiro'))) {
+    return { name: 'kiro', defaultPath: '.kiro/skills' };
+  }
+
+  if (fs.existsSync(path.join(cwd, '.cursor'))) {
+    return { name: 'cursor', defaultPath: '.cursor/skills' };
+  }
+
+  if (fs.existsSync(path.join(cwd, '.vscode'))) {
+    return { name: 'vscode', defaultPath: '.agent_agy' };
+  }
+
+  // 檢查是否有全域 Kiro 配置
+  if (fs.existsSync(path.join(homeDir, '.kiro'))) {
+    return { name: 'kiro-global', defaultPath: path.join(homeDir, '.kiro/skills') };
+  }
+
+  // 預設為 VS Code
+  return { name: 'vscode', defaultPath: '.agent_agy' };
+}
+
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const options = {
+    path: null,
+    mode: 'full', // full, core-only, skills-only
+    skills: null,
+    ide: null,
+    help: false
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+
+    switch (arg) {
+      case '--help':
+      case '-h':
+        options.help = true;
+        break;
+      case '--vscode':
+        options.ide = 'vscode';
+        options.path = '.agent_agy';
+        break;
+      case '--cursor':
+        options.ide = 'cursor';
+        options.path = '.cursor/skills';
+        break;
+      case '--kiro':
+        options.ide = 'kiro';
+        options.path = '.kiro/skills';
+        break;
+      case '--kiro-global':
+        options.ide = 'kiro-global';
+        const homeDir = require('os').homedir();
+        options.path = path.join(homeDir, '.kiro/skills');
+        break;
+      case '--path':
+        options.path = args[++i];
+        break;
+      case '--core-only':
+        options.mode = 'core-only';
+        break;
+      case '--skills-only':
+        options.mode = 'skills-only';
+        break;
+      case '--skills':
+        options.skills = args[++i];
+        break;
+    }
+  }
+
+  return options;
+}
+
+function showHelp() {
+  console.log(`
+${colors.blue}╔══════════════════════════════════════════════════════╗${colors.reset}
+${colors.blue}║     Go Copilot Rules 安裝器                          ║${colors.reset}
+${colors.blue}║     專注於 Go 開發的 Copilot Skills 集合             ║${colors.reset}
+${colors.blue}╚══════════════════════════════════════════════════════╝${colors.reset}
+
+${colors.yellow}用法：${colors.reset}
+    npx @vincent119/go-copilot-rules [選項]
+
+${colors.yellow}選項：${colors.reset}
+    --vscode            安裝到 VS Code 預設位置 (.agent_agy/)
+    --cursor            安裝到 Cursor 預設位置 (.cursor/skills/)
+    --kiro              安裝到 Kiro 專案位置 (.kiro/skills/)
+    --kiro-global       安裝到 Kiro 全域位置 (~/.kiro/skills/)
+    --path <dir>        安裝到自訂路徑
+    --core-only         只安裝核心規範（不包含 Skills）
+    --skills-only       只安裝 Skills（不包含核心規範）
+    --skills <list>     只安裝特定 Skills（逗號分隔）
+    --help, -h          顯示此幫助訊息
+
+${colors.yellow}範例：${colors.reset}
+    # 自動偵測並安裝（預設）
+    npx @vincent119/go-copilot-rules
+
+    # 安裝到 VS Code
+    npx @vincent119/go-copilot-rules --vscode
+
+    # 安裝到 Cursor
+    npx @vincent119/go-copilot-rules --cursor
+
+    # 安裝到 Kiro （專案）
+    npx @vincent119/go-copilot-rules --kiro
+
+    # 安裝到 Kiro （全域）
+    npx @vincent119/go-copilot-rules --kiro-global
+
+    # 只安裝特定 Skills
+    npx @vincent119/go-copilot-rules --skills "go-ddd,go-grpc,go-observability"
+
+    # 安裝到自訂路徑
+    npx @vincent119/go-copilot-rules --path ~/.my-copilot-rules
+
+${colors.yellow}支援的 Skills：${colors.reset}
+    go-ddd                  DDD 架構設計
+    go-grpc                 gRPC 完整規範
+    go-testing-advanced     進階測試策略
+    go-database             Database Migration
+    go-observability        日誌與可觀測性
+    go-graceful-shutdown    優雅關機模式
+    go-http-advanced        HTTP 進階實作
+    go-api-design           API 設計與版本管理
+    go-dependency-injection 依賴注入模式
+    go-configuration        設定管理
+    go-ci-tooling           CI/CD 與工具配置
+    go-domain-events        Domain Events 實作
+    go-examples             實作範例庫
+
+${colors.cyan}更多資訊：${colors.reset}
+    https://github.com/vincent119/copilot-rules-kit
+`);
+}
+
+function copyRecursive(src, dest) {
+  const exists = fs.existsSync(src);
+  const stats = exists && fs.statSync(src);
+  const isDirectory = exists && stats.isDirectory();
+
+  if (isDirectory) {
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true });
+    }
+    fs.readdirSync(src).forEach(childItemName => {
+      copyRecursive(
+        path.join(src, childItemName),
+        path.join(dest, childItemName)
+      );
+    });
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+}
+
+function install(options) {
+  const packageRoot = path.dirname(__dirname);
+  const sourceDir = path.join(packageRoot, '.agent_agy');
+
+  // 如果沒有指定路徑，自動偵測
+  if (!options.path) {
+    const detected = detectIDE();
+    options.path = detected.defaultPath;
+    log(`ℹ️  偵測到 ${detected.name}，使用路徑: ${options.path}`, 'cyan');
+  }
+
+  const targetDir = path.resolve(process.cwd(), options.path);
+
+  log('', 'reset');
+  log('╔══════════════════════════════════════════════════════╗', 'blue');
+  log('║     Go Copilot Rules 安裝器                          ║', 'blue');
+  log('╚══════════════════════════════════════════════════════╝', 'blue');
+  log('', 'reset');
+
+  log('📋 安裝配置：', 'blue');
+  log(`   • 模式: ${options.mode}`, 'green');
+  log(`   • 目標: ${targetDir}`, 'green');
+  if (options.skills) {
+    log(`   • Skills: ${options.skills}`, 'green');
+  }
+  log('', 'reset');
+
+  // 備份現有目錄
+  if (fs.existsSync(targetDir)) {
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, -5);
+    const backupDir = `${targetDir}.backup.${timestamp}`;
+    log(`⚠️  目標目錄已存在，備份到 ${backupDir}`, 'yellow');
+    fs.renameSync(targetDir, backupDir);
+  }
+
+  // 建立目標目錄
+  fs.mkdirSync(targetDir, { recursive: true });
+
+  // 根據模式複製檔案
+  log('📦 安裝檔案...', 'blue');
+
+  switch (options.mode) {
+    case 'full':
+      log('   複製完整規範（核心 + 所有 Skills）', 'cyan');
+      copyRecursive(sourceDir, targetDir);
+      break;
+
+    case 'core-only':
+      log('   複製核心規範', 'cyan');
+      const rulesDir = path.join(targetDir, 'rules');
+      fs.mkdirSync(rulesDir, { recursive: true });
+      copyRecursive(path.join(sourceDir, 'rules'), rulesDir);
+
+      // 複製 README
+      const readmeSrc = path.join(sourceDir, 'README.md');
+      if (fs.existsSync(readmeSrc)) {
+        fs.copyFileSync(readmeSrc, path.join(targetDir, 'README.md'));
+      }
+      break;
+
+    case 'skills-only':
+      log('   複製所有 Skills', 'cyan');
+      const skillsDir = path.join(targetDir, 'skills');
+      fs.mkdirSync(skillsDir, { recursive: true });
+      copyRecursive(path.join(sourceDir, 'skills'), skillsDir);
+      break;
+  }
+
+  // 如果指定了特定 Skills
+  if (options.skills) {
+    log('📋 複製選定的 Skills...', 'blue');
+    const skillsDir = path.join(targetDir, 'skills');
+    fs.mkdirSync(skillsDir, { recursive: true });
+
+    const skillList = options.skills.split(',').map(s => s.trim());
+    skillList.forEach(skill => {
+      const skillSrc = path.join(sourceDir, 'skills', skill);
+      if (fs.existsSync(skillSrc)) {
+        const skillDest = path.join(skillsDir, skill);
+        copyRecursive(skillSrc, skillDest);
+        log(`   • ${skill}`, 'green');
+      } else {
+        log(`   • ${skill} (不存在，跳過)`, 'red');
+      }
+    });
+  }
+
+  // 複製文件
+  ['INSTALLATION.md', 'SKILLS_INDEX.md'].forEach(file => {
+    const src = path.join(sourceDir, file);
+    if (fs.existsSync(src)) {
+      fs.copyFileSync(src, path.join(targetDir, file));
+    }
+  });
+
+  // 統計安裝結果
+  log('', 'reset');
+  log('✅ 安裝完成！', 'green');
+  log('', 'reset');
+
+  // 顯示已安裝內容
+  if (options.mode !== 'skills-only') {
+    const rulesPath = path.join(targetDir, 'rules');
+    if (fs.existsSync(rulesPath)) {
+      const coreFiles = fs.readdirSync(rulesPath).filter(f => f.endsWith('.md'));
+      log(`📊 核心規範: ${coreFiles.length} 個檔案`, 'green');
+    }
+  }
+
+  if (options.mode !== 'core-only') {
+    const skillsPath = path.join(targetDir, 'skills');
+    if (fs.existsSync(skillsPath)) {
+      log('📊 已安裝的 Skills：', 'green');
+      const skills = fs.readdirSync(skillsPath).filter(f => {
+        return fs.statSync(path.join(skillsPath, f)).isDirectory();
+      });
+      skills.forEach(skill => {
+        log(`   • ${skill}`, 'green');
+      });
+    }
+  }
+
+  // 下一步提示
+  log('', 'reset');
+  log('💡 下一步：', 'yellow');
+
+  if (options.ide === 'cursor') {
+    log('   1. 重新啟動 Cursor', 'reset');
+    log('   2. 在 Chat 輸入: @go-ddd 如何設計 Aggregate Root？', 'blue');
+  } else {
+    log('   1. 打開 VS Code / Cursor', 'reset');
+    log('   2. 在 Copilot Chat 輸入: \'這個專案有哪些 Skills？\'', 'blue');
+    log('   3. 測試觸發: \'如何實作 DDD Aggregate Root？\'', 'blue');
+  }
+
+  log('', 'reset');
+  log(`📚 查看完整文件: ${targetDir}/INSTALLATION.md`, 'cyan');
+  log('', 'reset');
+}
+
+// 主程式
+function main() {
+  const options = parseArgs();
+
+  if (options.help) {
+    showHelp();
+    process.exit(0);
+  }
+
+  try {
+    install(options);
+  } catch (error) {
+    log('', 'reset');
+    log('❌ 安裝失敗', 'red');
+    log(`錯誤: ${error.message}`, 'red');
+    log('', 'reset');
+    log('如需協助，請訪問: https://github.com/vincent119/copilot-rules-kit/issues', 'cyan');
+    process.exit(1);
+  }
+}
+
+main();

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@vincent119/go-copilot-rules",
+  "version": "1.0.0",
+  "description": "Professional Go development rules and skills for GitHub Copilot, Cursor, and other AI coding assistants",
+  "keywords": [
+    "copilot",
+    "github-copilot",
+    "cursor",
+    "ai-coding",
+    "golang",
+    "go",
+    "copilot-skills",
+    "copilot-rules",
+    "ddd",
+    "grpc",
+    "testing",
+    "best-practices"
+  ],
+  "author": "vincent119",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vincent119/copilot-rules-kit.git"
+  },
+  "homepage": "https://github.com/vincent119/copilot-rules-kit#readme",
+  "bugs": {
+    "url": "https://github.com/vincent119/copilot-rules-kit/issues"
+  },
+  "bin": {
+    "go-copilot-rules": "./cli/install.js"
+  },
+  "files": [
+    ".agent_agy/",
+    "cli/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}