scm-method 1.0.0

package/tools/installer/commands/uninstall.js

@@ -0,0 +1,167 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const prompts = require('../prompts');
+const { Installer } = require('../core/installer');
+
+const installer = new Installer();
+
+module.exports = {
+  command: 'uninstall',
+  description: 'Remove SCM installation from the current project',
+  options: [
+    ['-y, --yes', 'Remove all SCM components without prompting (preserves user artifacts)'],
+    ['--directory <path>', 'Project directory (default: current directory)'],
+  ],
+  action: async (options) => {
+    try {
+      let projectDir;
+
+      if (options.directory) {
+        // Explicit --directory flag takes precedence
+        projectDir = path.resolve(options.directory);
+      } else if (options.yes) {
+        // Non-interactive mode: use current directory
+        projectDir = process.cwd();
+      } else {
+        // Interactive: ask user which directory to uninstall from
+        // select() handles cancellation internally (exits process)
+        const dirChoice = await prompts.select({
+          message: 'Where do you want to uninstall SCM from?',
+          choices: [
+            { value: 'cwd', name: `Current directory (${process.cwd()})` },
+            { value: 'other', name: 'Another directory...' },
+          ],
+        });
+
+        if (dirChoice === 'other') {
+          // text() handles cancellation internally (exits process)
+          const customDir = await prompts.text({
+            message: 'Enter the project directory path:',
+            placeholder: process.cwd(),
+            validate: (value) => {
+              if (!value || value.trim().length === 0) return 'Directory path is required';
+            },
+          });
+
+          projectDir = path.resolve(customDir.trim());
+        } else {
+          projectDir = process.cwd();
+        }
+      }
+
+      if (!(await fs.pathExists(projectDir))) {
+        await prompts.log.error(`Directory does not exist: ${projectDir}`);
+        process.exit(1);
+      }
+
+      const { scmDir } = await installer.findBmadDir(projectDir);
+
+      if (!(await fs.pathExists(scmDir))) {
+        await prompts.log.warn('No SCM installation found.');
+        process.exit(0);
+      }
+
+      const existingInstall = await installer.getStatus(projectDir);
+      const version = existingInstall.installed ? existingInstall.version : 'unknown';
+      const modules = existingInstall.moduleIds.join(', ');
+      const ides = existingInstall.ides.join(', ');
+
+      const outputFolder = await installer.getOutputFolder(projectDir);
+
+      await prompts.intro('SCM Uninstall');
+      await prompts.note(`Version: ${version}\nModules: ${modules}\nIDE integrations: ${ides}`, 'Current Installation');
+
+      let removeModules = true;
+      let removeIdeConfigs = true;
+      let removeOutputFolder = false;
+
+      if (!options.yes) {
+        // multiselect() handles cancellation internally (exits process)
+        const selected = await prompts.multiselect({
+          message: 'Select components to remove:',
+          options: [
+            {
+              value: 'modules',
+              label: `SCM Modules & data (${installer.scmFolderName}/)`,
+              hint: 'Core installation, agents, workflows, config',
+            },
+            { value: 'ide', label: 'IDE integrations', hint: ides || 'No IDEs configured' },
+            { value: 'output', label: `User artifacts (${outputFolder}/)`, hint: 'WARNING: Contains your work products' },
+          ],
+          initialValues: ['modules', 'ide'],
+          required: true,
+        });
+
+        removeModules = selected.includes('modules');
+        removeIdeConfigs = selected.includes('ide');
+        removeOutputFolder = selected.includes('output');
+
+        const red = (s) => `\u001B[31m${s}\u001B[0m`;
+        await prompts.note(
+          red('💀 This action is IRREVERSIBLE! Removed files cannot be recovered!') +
+            '\n' +
+            red('💀 IDE configurations and modules will need to be reinstalled.') +
+            '\n' +
+            red('💀 User artifacts are preserved unless explicitly selected.'),
+          '!! DESTRUCTIVE ACTION !!',
+        );
+
+        const confirmed = await prompts.confirm({
+          message: 'Proceed with uninstall?',
+          default: false,
+        });
+
+        if (!confirmed) {
+          await prompts.outro('Uninstall cancelled.');
+          process.exit(0);
+        }
+      }
+
+      // Phase 1: IDE integrations
+      if (removeIdeConfigs) {
+        const s = await prompts.spinner();
+        s.start('Removing IDE integrations...');
+        await installer.uninstallIdeConfigs(projectDir, existingInstall, { silent: true });
+        s.stop(`Removed IDE integrations (${ides || 'none'})`);
+      }
+
+      // Phase 2: User artifacts
+      if (removeOutputFolder) {
+        const s = await prompts.spinner();
+        s.start(`Removing user artifacts (${outputFolder}/)...`);
+        await installer.uninstallOutputFolder(projectDir, outputFolder);
+        s.stop('User artifacts removed');
+      }
+
+      // Phase 3: SCM modules & data (last — other phases may need _scm/)
+      if (removeModules) {
+        const s = await prompts.spinner();
+        s.start(`Removing SCM modules & data (${installer.scmFolderName}/)...`);
+        await installer.uninstallModules(projectDir);
+        s.stop('Modules & data removed');
+      }
+
+      const summary = [];
+      if (removeIdeConfigs) summary.push('IDE integrations cleaned');
+      if (removeModules) summary.push('Modules & data removed');
+      if (removeOutputFolder) summary.push('User artifacts removed');
+      if (!removeOutputFolder) summary.push(`User artifacts preserved in ${outputFolder}/`);
+
+      await prompts.note(summary.join('\n'), 'Summary');
+      await prompts.outro('To reinstall, run: npx SCM-method install');
+
+      process.exit(0);
+    } catch (error) {
+      try {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        await prompts.log.error(`Uninstall failed: ${errorMessage}`);
+        if (error instanceof Error && error.stack) {
+          await prompts.log.message(error.stack);
+        }
+      } catch {
+        console.error(error instanceof Error ? error.message : error);
+      }
+      process.exit(1);
+    }
+  },
+};

package/tools/installer/core/config.js

@@ -0,0 +1,52 @@
+/**
+ * Clean install configuration built from user input.
+ * User input comes from either UI answers or headless CLI flags.
+ */
+class Config {
+  constructor({ directory, modules, ides, skipPrompts, verbose, actionType, coreConfig, moduleConfigs, quickUpdate }) {
+    this.directory = directory;
+    this.modules = Object.freeze([...modules]);
+    this.ides = Object.freeze([...ides]);
+    this.skipPrompts = skipPrompts;
+    this.verbose = verbose;
+    this.actionType = actionType;
+    this.coreConfig = coreConfig;
+    this.moduleConfigs = moduleConfigs;
+    this._quickUpdate = quickUpdate;
+    Object.freeze(this);
+  }
+
+  /**
+   * Build a clean install config from raw user input.
+   * @param {Object} userInput - UI answers or CLI flags
+   * @returns {Config}
+   */
+  static build(userInput) {
+    const modules = [...(userInput.modules || [])];
+    if (userInput.installCore && !modules.includes('core')) {
+      modules.unshift('core');
+    }
+
+    return new Config({
+      directory: userInput.directory,
+      modules,
+      ides: userInput.skipIde ? [] : [...(userInput.ides || [])],
+      skipPrompts: userInput.skipPrompts || false,
+      verbose: userInput.verbose || false,
+      actionType: userInput.actionType,
+      coreConfig: userInput.coreConfig || {},
+      moduleConfigs: userInput.moduleConfigs || null,
+      quickUpdate: userInput._quickUpdate || false,
+    });
+  }
+
+  hasCoreConfig() {
+    return this.coreConfig && Object.keys(this.coreConfig).length > 0;
+  }
+
+  isQuickUpdate() {
+    return this._quickUpdate;
+  }
+}
+
+module.exports = { Config };

package/tools/installer/core/custom-module-cache.js

@@ -0,0 +1,260 @@
+/**
+ * Custom Module Source Cache
+ * Caches custom module sources under _config/custom/ to ensure they're never lost
+ * and can be checked into source control
+ */
+
+const fs = require('fs-extra');
+const path = require('node:path');
+const crypto = require('node:crypto');
+const prompts = require('../prompts');
+
+class CustomModuleCache {
+  constructor(scmDir) {
+    this.scmDir = scmDir;
+    this.customCacheDir = path.join(scmDir, '_config', 'custom');
+    this.manifestPath = path.join(this.customCacheDir, 'cache-manifest.yaml');
+  }
+
+  /**
+   * Ensure the custom cache directory exists
+   */
+  async ensureCacheDir() {
+    await fs.ensureDir(this.customCacheDir);
+  }
+
+  /**
+   * Get cache manifest
+   */
+  async getCacheManifest() {
+    if (!(await fs.pathExists(this.manifestPath))) {
+      return {};
+    }
+
+    const content = await fs.readFile(this.manifestPath, 'utf8');
+    const yaml = require('yaml');
+    return yaml.parse(content) || {};
+  }
+
+  /**
+   * Update cache manifest
+   */
+  async updateCacheManifest(manifest) {
+    const yaml = require('yaml');
+    // Clean the manifest to remove any non-serializable values
+    const cleanManifest = structuredClone(manifest);
+
+    const content = yaml.stringify(cleanManifest, {
+      indent: 2,
+      lineWidth: 0,
+      sortKeys: false,
+    });
+
+    await fs.writeFile(this.manifestPath, content);
+  }
+
+  /**
+   * Stream a file into the hash to avoid loading entire file into memory
+   */
+  async hashFileStream(filePath, hash) {
+    return new Promise((resolve, reject) => {
+      const stream = require('node:fs').createReadStream(filePath);
+      stream.on('data', (chunk) => hash.update(chunk));
+      stream.on('end', resolve);
+      stream.on('error', reject);
+    });
+  }
+
+  /**
+   * Calculate hash of a file or directory using streaming to minimize memory usage
+   */
+  async calculateHash(sourcePath) {
+    const hash = crypto.createHash('sha256');
+
+    const isDir = (await fs.stat(sourcePath)).isDirectory();
+
+    if (isDir) {
+      // For directories, hash all files
+      const files = [];
+      async function collectFiles(dir) {
+        const entries = await fs.readdir(dir, { withFileTypes: true });
+        for (const entry of entries) {
+          if (entry.isFile()) {
+            files.push(path.join(dir, entry.name));
+          } else if (entry.isDirectory() && !entry.name.startsWith('.')) {
+            await collectFiles(path.join(dir, entry.name));
+          }
+        }
+      }
+
+      await collectFiles(sourcePath);
+      files.sort(); // Ensure consistent order
+
+      for (const file of files) {
+        const relativePath = path.relative(sourcePath, file);
+        // Hash the path first, then stream file contents
+        hash.update(relativePath + '|');
+        await this.hashFileStream(file, hash);
+      }
+    } else {
+      // For single files, stream directly into hash
+      await this.hashFileStream(sourcePath, hash);
+    }
+
+    return hash.digest('hex');
+  }
+
+  /**
+   * Cache a custom module source
+   * @param {string} moduleId - Module ID
+   * @param {string} sourcePath - Original source path
+   * @param {Object} metadata - Additional metadata to store
+   * @returns {Object} Cached module info
+   */
+  async cacheModule(moduleId, sourcePath, metadata = {}) {
+    await this.ensureCacheDir();
+
+    const cacheDir = path.join(this.customCacheDir, moduleId);
+    const cacheManifest = await this.getCacheManifest();
+
+    // Check if already cached and unchanged
+    if (cacheManifest[moduleId]) {
+      const cached = cacheManifest[moduleId];
+      if (cached.originalHash && cached.originalHash === (await this.calculateHash(sourcePath))) {
+        // Source unchanged, return existing cache info
+        return {
+          moduleId,
+          cachePath: cacheDir,
+          ...cached,
+        };
+      }
+    }
+
+    // Remove existing cache if it exists
+    if (await fs.pathExists(cacheDir)) {
+      await fs.remove(cacheDir);
+    }
+
+    // Copy module to cache
+    await fs.copy(sourcePath, cacheDir, {
+      filter: (src) => {
+        const relative = path.relative(sourcePath, src);
+        // Skip node_modules, .git, and other common ignore patterns
+        return !relative.includes('node_modules') && !relative.startsWith('.git') && !relative.startsWith('.DS_Store');
+      },
+    });
+
+    // Calculate hash of the source
+    const sourceHash = await this.calculateHash(sourcePath);
+    const cacheHash = await this.calculateHash(cacheDir);
+
+    // Update manifest - don't store absolute paths for portability
+    // Clean metadata to remove absolute paths
+    const cleanMetadata = { ...metadata };
+    if (cleanMetadata.sourcePath) {
+      delete cleanMetadata.sourcePath;
+    }
+
+    cacheManifest[moduleId] = {
+      originalHash: sourceHash,
+      cacheHash: cacheHash,
+      cachedAt: new Date().toISOString(),
+      ...cleanMetadata,
+    };
+
+    await this.updateCacheManifest(cacheManifest);
+
+    return {
+      moduleId,
+      cachePath: cacheDir,
+      ...cacheManifest[moduleId],
+    };
+  }
+
+  /**
+   * Get cached module info
+   * @param {string} moduleId - Module ID
+   * @returns {Object|null} Cached module info or null
+   */
+  async getCachedModule(moduleId) {
+    const cacheManifest = await this.getCacheManifest();
+    const cached = cacheManifest[moduleId];
+
+    if (!cached) {
+      return null;
+    }
+
+    const cacheDir = path.join(this.customCacheDir, moduleId);
+
+    if (!(await fs.pathExists(cacheDir))) {
+      // Cache dir missing, remove from manifest
+      delete cacheManifest[moduleId];
+      await this.updateCacheManifest(cacheManifest);
+      return null;
+    }
+
+    // Verify cache integrity
+    const currentCacheHash = await this.calculateHash(cacheDir);
+    if (currentCacheHash !== cached.cacheHash) {
+      await prompts.log.warn(`Cache integrity check failed for ${moduleId}`);
+    }
+
+    return {
+      moduleId,
+      cachePath: cacheDir,
+      ...cached,
+    };
+  }
+
+  /**
+   * Get all cached modules
+   * @returns {Array} Array of cached module info
+   */
+  async getAllCachedModules() {
+    const cacheManifest = await this.getCacheManifest();
+    const cached = [];
+
+    for (const [moduleId, info] of Object.entries(cacheManifest)) {
+      const cachedModule = await this.getCachedModule(moduleId);
+      if (cachedModule) {
+        cached.push(cachedModule);
+      }
+    }
+
+    return cached;
+  }
+
+  /**
+   * Remove a cached module
+   * @param {string} moduleId - Module ID to remove
+   */
+  async removeCachedModule(moduleId) {
+    const cacheManifest = await this.getCacheManifest();
+    const cacheDir = path.join(this.customCacheDir, moduleId);
+
+    // Remove cache directory
+    if (await fs.pathExists(cacheDir)) {
+      await fs.remove(cacheDir);
+    }
+
+    // Remove from manifest
+    delete cacheManifest[moduleId];
+    await this.updateCacheManifest(cacheManifest);
+  }
+
+  /**
+   * Sync cached modules with a list of module IDs
+   * @param {Array<string>} moduleIds - Module IDs to keep
+   */
+  async syncCache(moduleIds) {
+    const cached = await this.getAllCachedModules();
+
+    for (const cachedModule of cached) {
+      if (!moduleIds.includes(cachedModule.moduleId)) {
+        await this.removeCachedModule(cachedModule.moduleId);
+      }
+    }
+  }
+}
+
+module.exports = { CustomModuleCache };

package/tools/installer/core/existing-install.js

@@ -0,0 +1,127 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const yaml = require('yaml');
+const { Manifest } = require('./manifest');
+
+/**
+ * Immutable snapshot of an existing SCM installation.
+ * Pure query object — no filesystem operations after construction.
+ */
+class ExistingInstall {
+  #version;
+
+  constructor({ installed, version, hasCore, modules, ides, customModules }) {
+    this.installed = installed;
+    this.#version = version;
+    this.hasCore = hasCore;
+    this.modules = Object.freeze(modules.map((m) => Object.freeze({ ...m })));
+    this.moduleIds = Object.freeze(this.modules.map((m) => m.id));
+    this.ides = Object.freeze([...ides]);
+    this.customModules = Object.freeze([...customModules]);
+    Object.freeze(this);
+  }
+
+  get version() {
+    if (!this.installed) {
+      throw new Error('version is not available when nothing is installed');
+    }
+    return this.#version;
+  }
+
+  static empty() {
+    return new ExistingInstall({
+      installed: false,
+      version: null,
+      hasCore: false,
+      modules: [],
+      ides: [],
+      customModules: [],
+    });
+  }
+
+  /**
+   * Scan a scm directory and return an immutable snapshot of what's installed.
+   * @param {string} scmDir - Path to scm directory
+   * @returns {Promise<ExistingInstall>}
+   */
+  static async detect(scmDir) {
+    if (!(await fs.pathExists(scmDir))) {
+      return ExistingInstall.empty();
+    }
+
+    let version = null;
+    let hasCore = false;
+    const modules = [];
+    let ides = [];
+    let customModules = [];
+
+    const manifest = new Manifest();
+    const manifestData = await manifest.read(scmDir);
+    if (manifestData) {
+      version = manifestData.version;
+      if (manifestData.customModules) {
+        customModules = manifestData.customModules;
+      }
+      if (manifestData.ides) {
+        ides = manifestData.ides.filter((ide) => ide && typeof ide === 'string');
+      }
+    }
+
+    const corePath = path.join(scmDir, 'core');
+    if (await fs.pathExists(corePath)) {
+      hasCore = true;
+
+      if (!version) {
+        const coreConfigPath = path.join(corePath, 'config.yaml');
+        if (await fs.pathExists(coreConfigPath)) {
+          try {
+            const configContent = await fs.readFile(coreConfigPath, 'utf8');
+            const config = yaml.parse(configContent);
+            if (config.version) {
+              version = config.version;
+            }
+          } catch {
+            // Ignore config read errors
+          }
+        }
+      }
+    }
+
+    if (manifestData && manifestData.modules && manifestData.modules.length > 0) {
+      for (const moduleId of manifestData.modules) {
+        const modulePath = path.join(scmDir, moduleId);
+        const moduleConfigPath = path.join(modulePath, 'config.yaml');
+
+        const moduleInfo = {
+          id: moduleId,
+          path: modulePath,
+          version: 'unknown',
+        };
+
+        if (await fs.pathExists(moduleConfigPath)) {
+          try {
+            const configContent = await fs.readFile(moduleConfigPath, 'utf8');
+            const config = yaml.parse(configContent);
+            moduleInfo.version = config.version || 'unknown';
+            moduleInfo.name = config.name || moduleId;
+            moduleInfo.description = config.description;
+          } catch {
+            // Ignore config read errors
+          }
+        }
+
+        modules.push(moduleInfo);
+      }
+    }
+
+    const installed = hasCore || modules.length > 0 || !!manifestData;
+
+    if (!installed) {
+      return ExistingInstall.empty();
+    }
+
+    return new ExistingInstall({ installed, version, hasCore, modules, ides, customModules });
+  }
+}
+
+module.exports = { ExistingInstall };