@cregis-dev/cckit 0.6.5 → 0.6.7

package/src/steps/install-bmad.js

@@ -1,85 +1,85 @@
-/**
- * Step: Install BMAD methodology via `npx bmad-method install`.
- *
- * Spawns the BMAD CLI as a child process with stdio inherited
- * so the user sees real-time output.
- */
-
-import { spawn } from 'node:child_process'
-
-/**
- * @param {object} opts
- * @param {string} opts.targetDir - Project root
- * @param {object} opts.bmadConfig - { command, args, outputDirs } from registry
- * @param {object} [opts.config] - User config (communication_language, document_output_language)
- * @param {boolean} opts.skip - Skip this step
- * @param {object} logger
- * @param {object} [_deps] - Injectable dependencies for testing
- * @returns {Promise<import('../core/orchestrator.js').StepResult>}
- */
-export async function installBmad(opts, logger, _deps = {}) {
-  if (opts.skip) {
-    return { stepId: 'install-bmad', name: 'Install BMAD', success: true, skipped: true, details: {} }
-  }
-
-  const { spawnFn = spawn } = _deps
-  const { command, args: baseArgs } = opts.bmadConfig
-
-  // Override language args from user config if provided
-  const args = [...baseArgs]
-  if (opts.config) {
-    const langMap = {
-      '--communication-language': opts.config.communication_language,
-      '--document-output-language': opts.config.document_output_language,
-    }
-    for (const [flag, value] of Object.entries(langMap)) {
-      if (!value) continue
-      const idx = args.indexOf(flag)
-      if (idx !== -1) {
-        args[idx + 1] = value
-      }
-    }
-  }
-
-  logger.info(`  Running: ${command} ${args.join(' ')}`)
-
-  return new Promise((resolve) => {
-    const child = spawnFn(command, args, {
-      cwd: opts.targetDir,
-      stdio: 'inherit',
-      shell: true,
-    })
-
-    child.on('close', (code) => {
-      if (code === 0) {
-        resolve({
-          stepId: 'install-bmad',
-          name: 'Install BMAD',
-          success: true,
-          skipped: false,
-          details: { outputDirs: opts.bmadConfig.outputDirs },
-        })
-      } else {
-        resolve({
-          stepId: 'install-bmad',
-          name: 'Install BMAD',
-          success: false,
-          skipped: false,
-          details: {},
-          error: `npx bmad-method exited with code ${code}`,
-        })
-      }
-    })
-
-    child.on('error', (err) => {
-      resolve({
-        stepId: 'install-bmad',
-        name: 'Install BMAD',
-        success: false,
-        skipped: false,
-        details: {},
-        error: `Failed to spawn: ${err.message}`,
-      })
-    })
-  })
-}
+/**
+ * Step: Install BMAD methodology via `npx bmad-method install`.
+ *
+ * Spawns the BMAD CLI as a child process with stdio inherited
+ * so the user sees real-time output.
+ */
+
+import { spawn } from 'node:child_process'
+
+/**
+ * @param {object} opts
+ * @param {string} opts.targetDir - Project root
+ * @param {object} opts.bmadConfig - { command, args, outputDirs } from registry
+ * @param {object} [opts.config] - User config (communication_language, document_output_language)
+ * @param {boolean} opts.skip - Skip this step
+ * @param {object} logger
+ * @param {object} [_deps] - Injectable dependencies for testing
+ * @returns {Promise<import('../core/orchestrator.js').StepResult>}
+ */
+export async function installBmad(opts, logger, _deps = {}) {
+  if (opts.skip) {
+    return { stepId: 'install-bmad', name: 'Install BMAD', success: true, skipped: true, details: {} }
+  }
+
+  const { spawnFn = spawn } = _deps
+  const { command, args: baseArgs } = opts.bmadConfig
+
+  // Override language args from user config if provided
+  const args = [...baseArgs]
+  if (opts.config) {
+    const langMap = {
+      '--communication-language': opts.config.communication_language,
+      '--document-output-language': opts.config.document_output_language,
+    }
+    for (const [flag, value] of Object.entries(langMap)) {
+      if (!value) continue
+      const idx = args.indexOf(flag)
+      if (idx !== -1) {
+        args[idx + 1] = value
+      }
+    }
+  }
+
+  logger.info(`  Running: ${command} ${args.join(' ')}`)
+
+  return new Promise((resolve) => {
+    const child = spawnFn(command, args, {
+      cwd: opts.targetDir,
+      stdio: 'inherit',
+      shell: true,
+    })
+
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve({
+          stepId: 'install-bmad',
+          name: 'Install BMAD',
+          success: true,
+          skipped: false,
+          details: { outputDirs: opts.bmadConfig.outputDirs },
+        })
+      } else {
+        resolve({
+          stepId: 'install-bmad',
+          name: 'Install BMAD',
+          success: false,
+          skipped: false,
+          details: {},
+          error: `npx bmad-method exited with code ${code}`,
+        })
+      }
+    })
+
+    child.on('error', (err) => {
+      resolve({
+        stepId: 'install-bmad',
+        name: 'Install BMAD',
+        success: false,
+        skipped: false,
+        details: {},
+        error: `Failed to spawn: ${err.message}`,
+      })
+    })
+  })
+}

package/src/steps/install-mcp.js

@@ -1,70 +1,70 @@
-/**
- * Step: Install MCP configuration.
- *
- * Copies the bundled `.mcp.json` template to the project root.
- * Uses `overwrite: false` to preserve user modifications.
- */
-
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-import fse from 'fs-extra'
-import { computeFileHash } from '../utils/fs.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const CCKIT_ROOT = path.resolve(__dirname, '../..')
-
-/**
- * @param {object} opts
- * @param {string} opts.targetDir - Project root
- * @param {object} opts.mcpConfig - { template, target } from registry
- * @param {boolean} opts.skip - Skip this step
- * @param {boolean} [opts.forceOverwrite] - Overwrite existing file
- * @param {object} logger
- * @returns {Promise<import('../core/orchestrator.js').StepResult>}
- */
-export async function installMcp(opts, logger) {
-  if (opts.skip) {
-    return { stepId: 'install-mcp', name: 'Install MCP Config', success: true, skipped: true, details: {} }
-  }
-
-  const srcPath = path.resolve(CCKIT_ROOT, opts.mcpConfig.template)
-  const destPath = path.join(opts.targetDir, opts.mcpConfig.target)
-
-  if (!await fse.pathExists(srcPath)) {
-    return {
-      stepId: 'install-mcp',
-      name: 'Install MCP Config',
-      success: false,
-      skipped: false,
-      details: {},
-      error: `MCP template not found at ${opts.mcpConfig.template}`,
-    }
-  }
-
-  // Don't overwrite user-modified file unless forced
-  if (!opts.forceOverwrite && await fse.pathExists(destPath)) {
-    const hash = await computeFileHash(destPath)
-    logger.info(`  ${opts.mcpConfig.target} already exists, skipping (use --force to overwrite)`)
-    return {
-      stepId: 'install-mcp',
-      name: 'Install MCP Config',
-      success: true,
-      skipped: false,
-      details: { target: opts.mcpConfig.target, hash, preserved: true },
-    }
-  }
-
-  await fse.ensureDir(path.dirname(destPath))
-  await fse.copy(srcPath, destPath)
-
-  const hash = await computeFileHash(destPath)
-  logger.debug(`Installed MCP config to ${opts.mcpConfig.target}`)
-
-  return {
-    stepId: 'install-mcp',
-    name: 'Install MCP Config',
-    success: true,
-    skipped: false,
-    details: { target: opts.mcpConfig.target, hash },
-  }
-}
+/**
+ * Step: Install MCP configuration.
+ *
+ * Copies the bundled `.mcp.json` template to the project root.
+ * Uses `overwrite: false` to preserve user modifications.
+ */
+
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import fse from 'fs-extra'
+import { computeFileHash } from '../utils/fs.js'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const CCKIT_ROOT = path.resolve(__dirname, '../..')
+
+/**
+ * @param {object} opts
+ * @param {string} opts.targetDir - Project root
+ * @param {object} opts.mcpConfig - { template, target } from registry
+ * @param {boolean} opts.skip - Skip this step
+ * @param {boolean} [opts.forceOverwrite] - Overwrite existing file
+ * @param {object} logger
+ * @returns {Promise<import('../core/orchestrator.js').StepResult>}
+ */
+export async function installMcp(opts, logger) {
+  if (opts.skip) {
+    return { stepId: 'install-mcp', name: 'Install MCP Config', success: true, skipped: true, details: {} }
+  }
+
+  const srcPath = path.resolve(CCKIT_ROOT, opts.mcpConfig.template)
+  const destPath = path.join(opts.targetDir, opts.mcpConfig.target)
+
+  if (!await fse.pathExists(srcPath)) {
+    return {
+      stepId: 'install-mcp',
+      name: 'Install MCP Config',
+      success: false,
+      skipped: false,
+      details: {},
+      error: `MCP template not found at ${opts.mcpConfig.template}`,
+    }
+  }
+
+  // Don't overwrite user-modified file unless forced
+  if (!opts.forceOverwrite && await fse.pathExists(destPath)) {
+    const hash = await computeFileHash(destPath)
+    logger.info(`  ${opts.mcpConfig.target} already exists, skipping (use --force to overwrite)`)
+    return {
+      stepId: 'install-mcp',
+      name: 'Install MCP Config',
+      success: true,
+      skipped: false,
+      details: { target: opts.mcpConfig.target, hash, preserved: true },
+    }
+  }
+
+  await fse.ensureDir(path.dirname(destPath))
+  await fse.copy(srcPath, destPath)
+
+  const hash = await computeFileHash(destPath)
+  logger.debug(`Installed MCP config to ${opts.mcpConfig.target}`)
+
+  return {
+    stepId: 'install-mcp',
+    name: 'Install MCP Config',
+    success: true,
+    skipped: false,
+    details: { target: opts.mcpConfig.target, hash },
+  }
+}

package/src/steps/install-rules.js

@@ -1,69 +1,69 @@
-/**
- * Step: Install ECC rules via template copy.
- *
- * Copies the bundled rules template to `.claude/rules/`.
- */
-
-import path from 'node:path'
-import fse from 'fs-extra'
-import { listFiles } from '../utils/fs.js'
-import { fileURLToPath } from 'node:url'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-
-/**
- * @param {object} opts
- * @param {string} opts.targetDir - Project root
- * @param {object} opts.rulesConfig - { template, target }
- * @param {boolean} opts.skip - Skip this step
- * @param {object} logger
- * @param {object} [_deps] - Injectable dependencies
- * @returns {Promise<import('../core/orchestrator.js').StepResult>}
- */
-export async function installRules(opts, logger, _deps = {}) {
-  if (opts.skip) {
-    return { stepId: 'install-rules', name: 'Install ECC Rules', success: true, skipped: true, details: {} }
-  }
-
-  const { template, target } = opts.rulesConfig
-
-  try {
-    // Resolve template path - use absolute path if provided, otherwise relative to cckit package
-    const templatePath = path.resolve(__dirname, '../../', template)
-    const destDir = path.join(opts.targetDir, target)
-
-    if (!await fse.pathExists(templatePath)) {
-      return {
-        stepId: 'install-rules',
-        name: 'Install ECC Rules',
-        success: false,
-        skipped: false,
-        details: {},
-        error: `Rules template not found: ${templatePath}`,
-      }
-    }
-
-    await fse.ensureDir(destDir)
-    await fse.copy(templatePath, destDir, { overwrite: true })
-
-    const files = await listFiles(destDir)
-    logger.debug(`Copied ${files.length} rule files to ${target}`)
-
-    return {
-      stepId: 'install-rules',
-      name: 'Install ECC Rules',
-      success: true,
-      skipped: false,
-      details: { files: files.length, target },
-    }
-  } catch (err) {
-    return {
-      stepId: 'install-rules',
-      name: 'Install ECC Rules',
-      success: false,
-      skipped: false,
-      details: {},
-      error: err.message,
-    }
-  }
-}
+/**
+ * Step: Install ECC rules via template copy.
+ *
+ * Copies the bundled rules template to `.claude/rules/`.
+ */
+
+import path from 'node:path'
+import fse from 'fs-extra'
+import { listFiles } from '../utils/fs.js'
+import { fileURLToPath } from 'node:url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * @param {object} opts
+ * @param {string} opts.targetDir - Project root
+ * @param {object} opts.rulesConfig - { template, target }
+ * @param {boolean} opts.skip - Skip this step
+ * @param {object} logger
+ * @param {object} [_deps] - Injectable dependencies
+ * @returns {Promise<import('../core/orchestrator.js').StepResult>}
+ */
+export async function installRules(opts, logger, _deps = {}) {
+  if (opts.skip) {
+    return { stepId: 'install-rules', name: 'Install ECC Rules', success: true, skipped: true, details: {} }
+  }
+
+  const { template, target } = opts.rulesConfig
+
+  try {
+    // Resolve template path - use absolute path if provided, otherwise relative to cckit package
+    const templatePath = path.resolve(__dirname, '../../', template)
+    const destDir = path.join(opts.targetDir, target)
+
+    if (!await fse.pathExists(templatePath)) {
+      return {
+        stepId: 'install-rules',
+        name: 'Install ECC Rules',
+        success: false,
+        skipped: false,
+        details: {},
+        error: `Rules template not found: ${templatePath}`,
+      }
+    }
+
+    await fse.ensureDir(destDir)
+    await fse.copy(templatePath, destDir, { overwrite: true })
+
+    const files = await listFiles(destDir)
+    logger.debug(`Copied ${files.length} rule files to ${target}`)
+
+    return {
+      stepId: 'install-rules',
+      name: 'Install ECC Rules',
+      success: true,
+      skipped: false,
+      details: { files: files.length, target },
+    }
+  } catch (err) {
+    return {
+      stepId: 'install-rules',
+      name: 'Install ECC Rules',
+      success: false,
+      skipped: false,
+      details: {},
+      error: err.message,
+    }
+  }
+}

package/src/steps/install-skills.js

@@ -1,56 +1,56 @@
-/**
- * Step: Install skills via `npx skills add`.
- *
- * Iterates over skill entries from the registry and runs
- * `npx skills add <repo> --skill <id>` for each.
- * Individual failures do not abort the overall step.
- */
-
-import { execFile } from 'node:child_process'
-import { promisify } from 'node:util'
-
-const execFileAsync = promisify(execFile)
-
-/**
- * @param {object} opts
- * @param {string} opts.targetDir - Project root
- * @param {Array<{id: string, repo: string, skill: string}>} opts.skills - Skill definitions
- * @param {boolean} opts.skip - Skip this step
- * @param {object} logger
- * @param {object} [_deps] - Injectable dependencies
- * @returns {Promise<import('../core/orchestrator.js').StepResult>}
- */
-export async function installSkills(opts, logger, _deps = {}) {
-  if (opts.skip) {
-    return { stepId: 'install-skills', name: 'Install Skills', success: true, skipped: true, details: {} }
-  }
-
-  const { execFileFn = execFileAsync } = _deps
-  const results = []
-
-  for (const skillDef of opts.skills) {
-    logger.info(`  Installing skill: ${skillDef.id}`)
-    try {
-      // Use installCommand from registry if available, otherwise fallback to basic command
-      const installCmd = skillDef.installCommand || `npx skills add ${skillDef.repo} --skill ${skillDef.skill} -y -a claude-code`
-      await execFileFn(installCmd, [], {
-        cwd: opts.targetDir,
-        shell: true,
-      })
-      results.push({ id: skillDef.id, success: true })
-      logger.debug(`  Skill "${skillDef.id}" installed successfully`)
-    } catch (err) {
-      results.push({ id: skillDef.id, success: false, error: err.message })
-      logger.warn(`Skill "${skillDef.id}" failed: ${err.message}`)
-    }
-  }
-
-  const allSuccess = results.every(r => r.success)
-  return {
-    stepId: 'install-skills',
-    name: 'Install Skills',
-    success: allSuccess,
-    skipped: false,
-    details: { results },
-  }
-}
+/**
+ * Step: Install skills via `npx skills add`.
+ *
+ * Iterates over skill entries from the registry and runs
+ * `npx skills add <repo> --skill <id>` for each.
+ * Individual failures do not abort the overall step.
+ */
+
+import { execFile } from 'node:child_process'
+import { promisify } from 'node:util'
+
+const execFileAsync = promisify(execFile)
+
+/**
+ * @param {object} opts
+ * @param {string} opts.targetDir - Project root
+ * @param {Array<{id: string, repo: string, skill: string}>} opts.skills - Skill definitions
+ * @param {boolean} opts.skip - Skip this step
+ * @param {object} logger
+ * @param {object} [_deps] - Injectable dependencies
+ * @returns {Promise<import('../core/orchestrator.js').StepResult>}
+ */
+export async function installSkills(opts, logger, _deps = {}) {
+  if (opts.skip) {
+    return { stepId: 'install-skills', name: 'Install Skills', success: true, skipped: true, details: {} }
+  }
+
+  const { execFileFn = execFileAsync } = _deps
+  const results = []
+
+  for (const skillDef of opts.skills) {
+    logger.info(`  Installing skill: ${skillDef.id}`)
+    try {
+      // Use installCommand from registry if available, otherwise fallback to basic command
+      const installCmd = skillDef.installCommand || `npx skills add ${skillDef.repo} --skill ${skillDef.skill} -y -a claude-code`
+      await execFileFn(installCmd, [], {
+        cwd: opts.targetDir,
+        shell: true,
+      })
+      results.push({ id: skillDef.id, success: true })
+      logger.debug(`  Skill "${skillDef.id}" installed successfully`)
+    } catch (err) {
+      results.push({ id: skillDef.id, success: false, error: err.message })
+      logger.warn(`Skill "${skillDef.id}" failed: ${err.message}`)
+    }
+  }
+
+  const allSuccess = results.every(r => r.success)
+  return {
+    stepId: 'install-skills',
+    name: 'Install Skills',
+    success: allSuccess,
+    skipped: false,
+    details: { results },
+  }
+}

package/src/utils/compare-versions.js

@@ -0,0 +1,106 @@
+/**
+ * Version comparison utilities for detecting configuration changes.
+ *
+ * Compares installed versions (from manifest) with registry versions
+ * to determine which components need updating.
+ */
+
+import { loadRegistry } from '../core/registry.js'
+
+/**
+ * Component map: stepId -> version key in registry.versions
+ */
+const COMPONENT_MAP = {
+  'configure-user': 'userSettings',
+  'enable-plugins': 'plugins',
+  'install-rules': 'rules',
+  'install-skills': 'skills',
+  'install-bmad': 'bmad',
+  'install-mcp': 'mcp',
+}
+
+/**
+ * Compare installed versions against registry versions.
+ *
+ * @param {object} manifest - Installed manifest with config.versions
+ * @param {object} registry - Current registry with versions
+ * @returns {object} - { needsUpdate: boolean, components: { [stepId]: { current, latest, needsUpdate } } }
+ */
+export function compareVersions(manifest, registry) {
+  const installedVersions = manifest.cckit?.config?.versions || {}
+  const latestVersions = registry.versions || {}
+
+  const components = {}
+  let needsUpdate = false
+
+  // Compare each component
+  for (const [stepId, versionKey] of Object.entries(COMPONENT_MAP)) {
+    const current = installedVersions[versionKey]
+    const latest = latestVersions[versionKey]
+
+    // If either version is missing, consider it needs update
+    const componentNeedsUpdate = !current || !latest || current !== latest
+
+    components[stepId] = {
+      versionKey,
+      current: current || 'none',
+      latest: latest || 'none',
+      needsUpdate: componentNeedsUpdate,
+    }
+
+    if (componentNeedsUpdate) {
+      needsUpdate = true
+    }
+  }
+
+  return { needsUpdate, components }
+}
+
+/**
+ * Check if specific component needs update.
+ *
+ * @param {object} manifest - Installed manifest
+ * @param {object} registry - Current registry
+ * @param {string} stepId - Step ID to check
+ * @returns {boolean}
+ */
+export function needsComponentUpdate(manifest, registry, stepId) {
+  const versionKey = COMPONENT_MAP[stepId]
+  if (!versionKey) return false
+
+  const current = manifest.cckit?.config?.versions?.[versionKey]
+  const latest = registry.versions?.[versionKey]
+
+  return !current || !latest || current !== latest
+}
+
+/**
+ * Get version info for a specific component.
+ *
+ * @param {object} registry - Current registry
+ * @returns {object} - { plugins, rules, skills, bmad, mcp, userSettings }
+ */
+export function getRegistryVersions(registry) {
+  return registry.versions || {}
+}
+
+/**
+ * Load registry and compare versions (async).
+ *
+ * @param {string} targetDir - Project directory
+ * @returns {Promise<{ needsUpdate: boolean, components: object }>}
+ */
+export async function checkForUpdates(targetDir) {
+  const { readManifest } = await import('../utils/manifest.js')
+  const registry = await loadRegistry()
+
+  let manifest
+  try {
+    manifest = await readManifest(targetDir)
+  } catch {
+    // Not installed yet
+    return { needsUpdate: true, components: {}, notInstalled: true }
+  }
+
+  return compareVersions(manifest, registry)
+}