@cregis-dev/cckit 0.6.5 → 0.6.7

package/src/utils/fs.js

@@ -1,33 +1,33 @@
-import fse from 'fs-extra'
-import path from 'node:path'
-import crypto from 'node:crypto'
-import { glob } from 'glob'
-
-/**
- * Compute SHA256 hash of a file.
- *
- * @param {string} filePath - Absolute path to file
- * @returns {Promise<string>} Hash in format "sha256:<hex>"
- */
-export async function computeFileHash(filePath) {
-  const content = await fse.readFile(filePath)
-  const hash = crypto.createHash('sha256').update(content).digest('hex')
-  return `sha256:${hash}`
-}
-
-/**
- * List all files in a directory recursively.
- *
- * @param {string} dir - Directory to scan
- * @returns {Promise<string[]>} Relative file paths
- */
-export async function listFiles(dir) {
-  const pattern = '**/*'
-  const files = await glob(pattern, {
-    cwd: dir,
-    nodir: true,
-    dot: true,
-    ignore: ['**/.git/**'],
-  })
-  return files
-}
+import fse from 'fs-extra'
+import path from 'node:path'
+import crypto from 'node:crypto'
+import { glob } from 'glob'
+
+/**
+ * Compute SHA256 hash of a file.
+ *
+ * @param {string} filePath - Absolute path to file
+ * @returns {Promise<string>} Hash in format "sha256:<hex>"
+ */
+export async function computeFileHash(filePath) {
+  const content = await fse.readFile(filePath)
+  const hash = crypto.createHash('sha256').update(content).digest('hex')
+  return `sha256:${hash}`
+}
+
+/**
+ * List all files in a directory recursively.
+ *
+ * @param {string} dir - Directory to scan
+ * @returns {Promise<string[]>} Relative file paths
+ */
+export async function listFiles(dir) {
+  const pattern = '**/*'
+  const files = await glob(pattern, {
+    cwd: dir,
+    nodir: true,
+    dot: true,
+    ignore: ['**/.git/**'],
+  })
+  return files
+}

package/src/utils/manifest.js

@@ -1,99 +1,101 @@
-/**
- * Manifest utilities — read/write the cckit installation manifest.
- *
- * Manifest lives at `_bmad/_config/manifest.yaml` and tracks:
- * - Installation config (user preferences)
- * - Step execution results
- * - File registry (SHA256 hashes for tracked files)
- */
-
-import path from 'node:path'
-import fse from 'fs-extra'
-import YAML from 'yaml'
-
-export const MANIFEST_REL = path.join('_bmad', '_config', 'manifest.yaml')
-
-/**
- * Read and parse the manifest from a project directory.
- *
- * @param {string} dir - Project root directory
- * @returns {Promise<object>} Parsed manifest object
- * @throws {Error} If manifest does not exist
- */
-export async function readManifest(dir) {
-  const manifestPath = path.join(path.resolve(dir), MANIFEST_REL)
-  try {
-    const content = await fse.readFile(manifestPath, 'utf8')
-    return YAML.parse(content)
-  } catch (err) {
-    if (err.code === 'ENOENT') {
-      throw new Error('cckit is not installed. Run `cckit init` first.')
-    }
-    throw err
-  }
-}
-
-/**
- * Write manifest to a project directory.
- *
- * @param {string} dir - Project root directory
- * @param {object} manifest - Manifest data to write
- * @returns {Promise<void>}
- */
-export async function writeManifest(dir, manifest) {
-  const manifestPath = path.join(path.resolve(dir), MANIFEST_REL)
-  await fse.ensureDir(path.dirname(manifestPath))
-  await fse.writeFile(manifestPath, YAML.stringify(manifest), 'utf8')
-}
-
-/**
- * Serialize step results for manifest storage.
- *
- * @param {Array<import('../core/orchestrator.js').StepResult>} steps
- * @returns {Array<object>}
- */
-export function serializeSteps(steps) {
-  return steps.map(s => ({
-    stepId: s.stepId,
-    success: s.success,
-    skipped: s.skipped || false,
-    ...(s.details ? { details: s.details } : {}),
-    ...(s.error ? { error: s.error } : {}),
-  }))
-}
-
-/**
- * Build a new manifest from orchestration results.
- *
- * @param {object} params
- * @param {object} params.config - Merged config
- * @param {import('../core/orchestrator.js').RunReport} params.report - Orchestration report
- * @param {string} params.version - cckit version
- * @returns {object} Manifest object
- */
-export function buildManifest({ config, report, version }) {
-  return {
-    cckit: {
-      version,
-      installedAt: new Date().toISOString(),
-      config: {
-        user_name: config.user_name,
-        communication_language: config.communication_language,
-        document_output_language: config.document_output_language,
-        languages: config.languages,
-      },
-      steps: serializeSteps(report.steps),
-      fileRegistry: report.fileRegistry,
-    }
-  }
-}
-
-/**
- * Check if a manifest uses the legacy v1 format (modules-based).
- *
- * @param {object} manifest - Parsed manifest
- * @returns {boolean}
- */
-export function isLegacyManifest(manifest) {
-  return !!(manifest.cckit?.modules) && !manifest.cckit?.steps
-}
+/**
+ * Manifest utilities — read/write the cckit installation manifest.
+ *
+ * Manifest lives at `_bmad/_config/manifest.yaml` and tracks:
+ * - Installation config (user preferences)
+ * - Step execution results
+ * - File registry (SHA256 hashes for tracked files)
+ */
+
+import path from 'node:path'
+import fse from 'fs-extra'
+import YAML from 'yaml'
+
+export const MANIFEST_REL = path.join('_bmad', '_config', 'manifest.yaml')
+
+/**
+ * Read and parse the manifest from a project directory.
+ *
+ * @param {string} dir - Project root directory
+ * @returns {Promise<object>} Parsed manifest object
+ * @throws {Error} If manifest does not exist
+ */
+export async function readManifest(dir) {
+  const manifestPath = path.join(path.resolve(dir), MANIFEST_REL)
+  try {
+    const content = await fse.readFile(manifestPath, 'utf8')
+    return YAML.parse(content)
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      throw new Error('cckit is not installed. Run `cckit init` first.')
+    }
+    throw err
+  }
+}
+
+/**
+ * Write manifest to a project directory.
+ *
+ * @param {string} dir - Project root directory
+ * @param {object} manifest - Manifest data to write
+ * @returns {Promise<void>}
+ */
+export async function writeManifest(dir, manifest) {
+  const manifestPath = path.join(path.resolve(dir), MANIFEST_REL)
+  await fse.ensureDir(path.dirname(manifestPath))
+  await fse.writeFile(manifestPath, YAML.stringify(manifest), 'utf8')
+}
+
+/**
+ * Serialize step results for manifest storage.
+ *
+ * @param {Array<import('../core/orchestrator.js').StepResult>} steps
+ * @returns {Array<object>}
+ */
+export function serializeSteps(steps) {
+  return steps.map(s => ({
+    stepId: s.stepId,
+    success: s.success,
+    skipped: s.skipped || false,
+    ...(s.details ? { details: s.details } : {}),
+    ...(s.error ? { error: s.error } : {}),
+  }))
+}
+
+/**
+ * Build a new manifest from orchestration results.
+ *
+ * @param {object} params
+ * @param {object} params.config - Merged config
+ * @param {import('../core/orchestrator.js').RunReport} params.report - Orchestration report
+ * @param {string} params.version - cckit version
+ * @param {object} [params.versions] - Component versions from registry
+ * @returns {object} Manifest object
+ */
+export function buildManifest({ config, report, version, versions = {} }) {
+  return {
+    cckit: {
+      version,
+      installedAt: new Date().toISOString(),
+      config: {
+        user_name: config.user_name,
+        communication_language: config.communication_language,
+        document_output_language: config.document_output_language,
+        languages: config.languages,
+        versions,
+      },
+      steps: serializeSteps(report.steps),
+      fileRegistry: report.fileRegistry,
+    }
+  }
+}
+
+/**
+ * Check if a manifest uses the legacy v1 format (modules-based).
+ *
+ * @param {object} manifest - Parsed manifest
+ * @returns {boolean}
+ */
+export function isLegacyManifest(manifest) {
+  return !!(manifest.cckit?.modules) && !manifest.cckit?.steps
+}

package/src/utils/prompt.js

@@ -1,41 +1,41 @@
-/**
- * Readline utility for interactive prompts.
- */
-
-import { createInterface } from 'node:readline'
-
-/**
- * Prompt user for input via readline.
- * Returns empty string if user presses Enter without typing.
- *
- * @param {string} question - Prompt text
- * @param {object} [_deps] - Injectable dependencies for testing
- * @param {object} [_deps.rl] - Mock readline interface
- * @returns {Promise<string>} User input (trimmed)
- */
-export function askQuestion(question, _deps = {}) {
-  const { rl: mockRl } = _deps
-
-  // If mock is provided, use it directly
-  if (mockRl) {
-    return new Promise((resolve) => {
-      mockRl.question(question, (answer) => {
-        mockRl.close()
-        resolve((answer == null ? '' : String(answer)).trim())
-      })
-    })
-  }
-
-  // Default: use real readline
-  const rl = createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  })
-
-  return new Promise((resolve) => {
-    rl.question(question, (answer) => {
-      rl.close()
-      resolve((answer == null ? '' : String(answer)).trim())
-    })
-  })
-}
+/**
+ * Readline utility for interactive prompts.
+ */
+
+import { createInterface } from 'node:readline'
+
+/**
+ * Prompt user for input via readline.
+ * Returns empty string if user presses Enter without typing.
+ *
+ * @param {string} question - Prompt text
+ * @param {object} [_deps] - Injectable dependencies for testing
+ * @param {object} [_deps.rl] - Mock readline interface
+ * @returns {Promise<string>} User input (trimmed)
+ */
+export function askQuestion(question, _deps = {}) {
+  const { rl: mockRl } = _deps
+
+  // If mock is provided, use it directly
+  if (mockRl) {
+    return new Promise((resolve) => {
+      mockRl.question(question, (answer) => {
+        mockRl.close()
+        resolve((answer == null ? '' : String(answer)).trim())
+      })
+    })
+  }
+
+  // Default: use real readline
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  })
+
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      rl.close()
+      resolve((answer == null ? '' : String(answer)).trim())
+    })
+  })
+}

package/templates/mcp/claude-code/.mcp.json

@@ -1,40 +1,40 @@
-{
-  "$schema": "https://raw.githubusercontent.com/anthropics/claude-code/main/.mcp.schema.json",
-  "mcpServers": {
-    "cf-bindings": {
-      "command": "npx",
-      "args": ["-y", "mcp-remote", "https://bindings.mcp.cloudflare.com/mcp"],
-      "description": "Workers Bindings: D1, R2, KV, Queues 资源管理",
-      "disabled": true
-    },
-    "cf-observability": {
-      "command": "npx",
-      "args": ["-y", "mcp-remote", "https://observability.mcp.cloudflare.com/mcp"],
-      "description": "Workers 日志分析与调试",
-      "disabled": true
-    },
-    "cf-builds": {
-      "command": "npx",
-      "args": ["-y", "mcp-remote", "https://builds.mcp.cloudflare.com/mcp"],
-      "description": "Workers 构建状态监控",
-      "disabled": true
-    },
-    "cf-docs": {
-      "command": "npx",
-      "args": ["-y", "mcp-remote", "https://docs.mcp.cloudflare.com/sse"],
-      "description": "Cloudflare 官方文档查询",
-      "disabled": true
-    },
-    "context7": {
-      "command": "npx",
-      "args": ["-y", "@upstash/context7-mcp@latest"],
-      "description": "库文档实时查询（Hono, Zod, React Query, Zustand, Radix UI 等）"
-    },
-    "playwright": {
-      "command": "npx",
-      "args": ["-y", "@anthropic-ai/mcp-playwright@latest"],
-      "description": "Playwright 浏览器自动化，用于 E2E 测试和 UI 验证",
-      "disabled": true
-    }
-  }
-}
+{
+  "$schema": "https://raw.githubusercontent.com/anthropics/claude-code/main/.mcp.schema.json",
+  "mcpServers": {
+    "cf-bindings": {
+      "command": "npx",
+      "args": ["-y", "mcp-remote", "https://bindings.mcp.cloudflare.com/mcp"],
+      "description": "Workers Bindings: D1, R2, KV, Queues 资源管理",
+      "disabled": true
+    },
+    "cf-observability": {
+      "command": "npx",
+      "args": ["-y", "mcp-remote", "https://observability.mcp.cloudflare.com/mcp"],
+      "description": "Workers 日志分析与调试",
+      "disabled": true
+    },
+    "cf-builds": {
+      "command": "npx",
+      "args": ["-y", "mcp-remote", "https://builds.mcp.cloudflare.com/mcp"],
+      "description": "Workers 构建状态监控",
+      "disabled": true
+    },
+    "cf-docs": {
+      "command": "npx",
+      "args": ["-y", "mcp-remote", "https://docs.mcp.cloudflare.com/sse"],
+      "description": "Cloudflare 官方文档查询",
+      "disabled": true
+    },
+    "context7": {
+      "command": "npx",
+      "args": ["-y", "@upstash/context7-mcp@latest"],
+      "description": "库文档实时查询（Hono, Zod, React Query, Zustand, Radix UI 等）"
+    },
+    "playwright": {
+      "command": "npx",
+      "args": ["-y", "@anthropic-ai/mcp-playwright@latest"],
+      "description": "Playwright 浏览器自动化，用于 E2E 测试和 UI 验证",
+      "disabled": true
+    }
+  }
+}

package/templates/rules/README.md

@@ -1,103 +1,103 @@
-# Rules
-## Structure
-
-Rules are organized into a **common** layer plus **language-specific** directories:
-
-```
-rules/
-├── common/          # Language-agnostic principles (always install)
-│   ├── coding-style.md
-│   ├── git-workflow.md
-│   ├── testing.md
-│   ├── performance.md
-│   ├── patterns.md
-│   ├── hooks.md
-│   ├── agents.md
-│   └── security.md
-├── typescript/      # TypeScript/JavaScript specific
-├── python/          # Python specific
-├── golang/          # Go specific
-└── swift/           # Swift specific
-```
-
-- **common/** contains universal principles — no language-specific code examples.
-- **Language directories** extend the common rules with framework-specific patterns, tools, and code examples. Each file references its common counterpart.
-
-## Installation
-
-### Option 1: Install Script (Recommended)
-
-```bash
-# Install common + one or more language-specific rule sets
-./install.sh typescript
-./install.sh python
-./install.sh golang
-./install.sh swift
-
-# Install multiple languages at once
-./install.sh typescript python
-```
-
-### Option 2: Manual Installation
-
-> **Important:** Copy entire directories — do NOT flatten with `/*`.
-> Common and language-specific directories contain files with the same names.
-> Flattening them into one directory causes language-specific files to overwrite
-> common rules, and breaks the relative `../common/` references used by
-> language-specific files.
-
-```bash
-# Install common rules (required for all projects)
-cp -r rules/common ~/.claude/rules/common
-
-# Install language-specific rules based on your project's tech stack
-cp -r rules/typescript ~/.claude/rules/typescript
-cp -r rules/python ~/.claude/rules/python
-cp -r rules/golang ~/.claude/rules/golang
-cp -r rules/swift ~/.claude/rules/swift
-
-# Attention ! ! ! Configure according to your actual project requirements; the configuration here is for reference only.
-```
-
-## Rules vs Skills
-
-- **Rules** define standards, conventions, and checklists that apply broadly (e.g., "80% test coverage", "no hardcoded secrets").
-- **Skills** (`skills/` directory) provide deep, actionable reference material for specific tasks (e.g., `python-patterns`, `golang-testing`).
-
-Language-specific rule files reference relevant skills where appropriate. Rules tell you *what* to do; skills tell you *how* to do it.
-
-## Adding a New Language
-
-To add support for a new language (e.g., `rust/`):
-
-1. Create a `rules/rust/` directory
-2. Add files that extend the common rules:
-   - `coding-style.md` — formatting tools, idioms, error handling patterns
-   - `testing.md` — test framework, coverage tools, test organization
-   - `patterns.md` — language-specific design patterns
-   - `hooks.md` — PostToolUse hooks for formatters, linters, type checkers
-   - `security.md` — secret management, security scanning tools
-3. Each file should start with:
-   ```
-   > This file extends [common/xxx.md](../common/xxx.md) with <Language> specific content.
-   ```
-4. Reference existing skills if available, or create new ones under `skills/`.
-
-## Rule Priority
-
-When language-specific rules and common rules conflict, **language-specific rules take precedence** (specific overrides general). This follows the standard layered configuration pattern (similar to CSS specificity or `.gitignore` precedence).
-
-- `rules/common/` defines universal defaults applicable to all projects.
-- `rules/golang/`, `rules/python/`, `rules/typescript/`, etc. override those defaults where language idioms differ.
-
-### Example
-
-`common/coding-style.md` recommends immutability as a default principle. A language-specific `golang/coding-style.md` can override this:
-
-> Idiomatic Go uses pointer receivers for struct mutation — see [common/coding-style.md](../common/coding-style.md) for the general principle, but Go-idiomatic mutation is preferred here.
-
-### Common rules with override notes
-
-Rules in `rules/common/` that may be overridden by language-specific files are marked with:
-
-> **Language note**: This rule may be overridden by language-specific rules for languages where this pattern is not idiomatic.
+# Rules
+## Structure
+
+Rules are organized into a **common** layer plus **language-specific** directories:
+
+```
+rules/
+├── common/          # Language-agnostic principles (always install)
+│   ├── coding-style.md
+│   ├── git-workflow.md
+│   ├── testing.md
+│   ├── performance.md
+│   ├── patterns.md
+│   ├── hooks.md
+│   ├── agents.md
+│   └── security.md
+├── typescript/      # TypeScript/JavaScript specific
+├── python/          # Python specific
+├── golang/          # Go specific
+└── swift/           # Swift specific
+```
+
+- **common/** contains universal principles — no language-specific code examples.
+- **Language directories** extend the common rules with framework-specific patterns, tools, and code examples. Each file references its common counterpart.
+
+## Installation
+
+### Option 1: Install Script (Recommended)
+
+```bash
+# Install common + one or more language-specific rule sets
+./install.sh typescript
+./install.sh python
+./install.sh golang
+./install.sh swift
+
+# Install multiple languages at once
+./install.sh typescript python
+```
+
+### Option 2: Manual Installation
+
+> **Important:** Copy entire directories — do NOT flatten with `/*`.
+> Common and language-specific directories contain files with the same names.
+> Flattening them into one directory causes language-specific files to overwrite
+> common rules, and breaks the relative `../common/` references used by
+> language-specific files.
+
+```bash
+# Install common rules (required for all projects)
+cp -r rules/common ~/.claude/rules/common
+
+# Install language-specific rules based on your project's tech stack
+cp -r rules/typescript ~/.claude/rules/typescript
+cp -r rules/python ~/.claude/rules/python
+cp -r rules/golang ~/.claude/rules/golang
+cp -r rules/swift ~/.claude/rules/swift
+
+# Attention ! ! ! Configure according to your actual project requirements; the configuration here is for reference only.
+```
+
+## Rules vs Skills
+
+- **Rules** define standards, conventions, and checklists that apply broadly (e.g., "80% test coverage", "no hardcoded secrets").
+- **Skills** (`skills/` directory) provide deep, actionable reference material for specific tasks (e.g., `python-patterns`, `golang-testing`).
+
+Language-specific rule files reference relevant skills where appropriate. Rules tell you *what* to do; skills tell you *how* to do it.
+
+## Adding a New Language
+
+To add support for a new language (e.g., `rust/`):
+
+1. Create a `rules/rust/` directory
+2. Add files that extend the common rules:
+   - `coding-style.md` — formatting tools, idioms, error handling patterns
+   - `testing.md` — test framework, coverage tools, test organization
+   - `patterns.md` — language-specific design patterns
+   - `hooks.md` — PostToolUse hooks for formatters, linters, type checkers
+   - `security.md` — secret management, security scanning tools
+3. Each file should start with:
+   ```
+   > This file extends [common/xxx.md](../common/xxx.md) with <Language> specific content.
+   ```
+4. Reference existing skills if available, or create new ones under `skills/`.
+
+## Rule Priority
+
+When language-specific rules and common rules conflict, **language-specific rules take precedence** (specific overrides general). This follows the standard layered configuration pattern (similar to CSS specificity or `.gitignore` precedence).
+
+- `rules/common/` defines universal defaults applicable to all projects.
+- `rules/golang/`, `rules/python/`, `rules/typescript/`, etc. override those defaults where language idioms differ.
+
+### Example
+
+`common/coding-style.md` recommends immutability as a default principle. A language-specific `golang/coding-style.md` can override this:
+
+> Idiomatic Go uses pointer receivers for struct mutation — see [common/coding-style.md](../common/coding-style.md) for the general principle, but Go-idiomatic mutation is preferred here.
+
+### Common rules with override notes
+
+Rules in `rules/common/` that may be overridden by language-specific files are marked with:
+
+> **Language note**: This rule may be overridden by language-specific rules for languages where this pattern is not idiomatic.