scm-method 1.0.0

package/tools/installer/yaml-format.js

@@ -0,0 +1,245 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const yaml = require('yaml');
+const { execSync } = require('node:child_process');
+
+// Dynamic import for ES module
+let chalk;
+
+// Initialize ES modules
+async function initializeModules() {
+  if (!chalk) {
+    chalk = (await import('chalk')).default;
+  }
+}
+
+/**
+ * YAML Formatter and Linter for SCM-Method
+ * Formats and validates YAML files and YAML embedded in Markdown
+ */
+
+async function formatYamlContent(content, filename) {
+  await initializeModules();
+  try {
+    // First try to fix common YAML issues
+    let fixedContent = content
+      // Fix "commands :" -> "commands:"
+      .replaceAll(/^(\s*)(\w+)\s+:/gm, '$1$2:')
+      // Fix inconsistent list indentation
+      .replaceAll(/^(\s*)-\s{3,}/gm, '$1- ');
+
+    // Skip auto-fixing for .roomodes files - they have special nested structure
+    if (!filename.includes('.roomodes')) {
+      fixedContent = fixedContent
+        // Fix unquoted list items that contain special characters or multiple parts
+        .replaceAll(/^(\s*)-\s+(.*)$/gm, (match, indent, content) => {
+          // Skip if already quoted
+          if (content.startsWith('"') && content.endsWith('"')) {
+            return match;
+          }
+          // If the content contains special YAML characters or looks complex, quote it
+          // BUT skip if it looks like a proper YAML key-value pair (like "key: value")
+          if (
+            (content.includes(':') || content.includes('-') || content.includes('{') || content.includes('}')) &&
+            !/^\w+:\s/.test(content)
+          ) {
+            // Remove any existing quotes first, escape internal quotes, then add proper quotes
+            const cleanContent = content.replaceAll(/^["']|["']$/g, '').replaceAll('"', String.raw`\"`);
+            return `${indent}- "${cleanContent}"`;
+          }
+          return match;
+        });
+    }
+
+    // Debug: show what we're trying to parse
+    if (fixedContent !== content) {
+      console.log(chalk.blue(`🔧 Applied YAML fixes to ${filename}`));
+    }
+
+    // Parse and re-dump YAML to format it
+    const parsed = yaml.parse(fixedContent);
+    const formatted = yaml.stringify(parsed, {
+      indent: 2,
+      lineWidth: 0, // Disable line wrapping
+      sortKeys: false, // Preserve key order
+    });
+    // Ensure POSIX-compliant final newline
+    return formatted.endsWith('\n') ? formatted : formatted + '\n';
+  } catch (error) {
+    console.error(chalk.red(`❌ YAML syntax error in ${filename}:`), error.message);
+    console.error(chalk.yellow(`💡 Try manually fixing the YAML structure first`));
+    return null;
+  }
+}
+
+async function processMarkdownFile(filePath) {
+  await initializeModules();
+  const content = fs.readFileSync(filePath, 'utf8');
+  let modified = false;
+  let newContent = content;
+
+  // Fix untyped code blocks by adding 'text' type
+  // Match ``` at start of line followed by newline, but only if it's an opening fence
+  newContent = newContent.replaceAll(/^```\n([\s\S]*?)\n```$/gm, '```text\n$1\n```');
+  if (newContent !== content) {
+    modified = true;
+    console.log(chalk.blue(`🔧 Added 'text' type to untyped code blocks in ${filePath}`));
+  }
+
+  // Find YAML code blocks
+  const yamlBlockRegex = /```ya?ml\n([\s\S]*?)\n```/g;
+  let match;
+  const replacements = [];
+
+  while ((match = yamlBlockRegex.exec(newContent)) !== null) {
+    const [fullMatch, yamlContent] = match;
+    const formatted = await formatYamlContent(yamlContent, filePath);
+    if (formatted !== null) {
+      const trimmedFormatted = formatted.replace(/\n$/, '');
+
+      if (trimmedFormatted !== yamlContent) {
+        modified = true;
+        console.log(chalk.green(`✓ Formatted YAML in ${filePath}`));
+      }
+
+      replacements.push({
+        start: match.index,
+        end: match.index + fullMatch.length,
+        replacement: `\`\`\`yaml\n${trimmedFormatted}\n\`\`\``,
+      });
+    }
+  }
+
+  // Apply replacements in reverse order to maintain indices
+  for (let index = replacements.length - 1; index >= 0; index--) {
+    const { start, end, replacement } = replacements[index];
+    newContent = newContent.slice(0, start) + replacement + newContent.slice(end);
+  }
+
+  if (modified) {
+    fs.writeFileSync(filePath, newContent);
+    return true;
+  }
+  return false;
+}
+
+async function processYamlFile(filePath) {
+  await initializeModules();
+  const content = fs.readFileSync(filePath, 'utf8');
+  const formatted = await formatYamlContent(content, filePath);
+
+  if (formatted === null) {
+    return false; // Syntax error
+  }
+
+  if (formatted !== content) {
+    fs.writeFileSync(filePath, formatted);
+    return true;
+  }
+  return false;
+}
+
+async function lintYamlFile(filePath) {
+  await initializeModules();
+  try {
+    // Use yaml-lint for additional validation
+    execSync(`npx yaml-lint "${filePath}"`, { stdio: 'pipe' });
+    return true;
+  } catch (error) {
+    console.error(chalk.red(`❌ YAML lint error in ${filePath}:`));
+    console.error(error.stdout?.toString() || error.message);
+    return false;
+  }
+}
+
+async function main() {
+  await initializeModules();
+  const arguments_ = process.argv.slice(2);
+  const glob = require('glob');
+
+  if (arguments_.length === 0) {
+    console.error('Usage: node yaml-format.js <file1> [file2] ...');
+    process.exit(1);
+  }
+
+  let hasErrors = false;
+  let hasChanges = false;
+  let filesProcessed = [];
+
+  // Expand glob patterns and collect all files
+  const allFiles = [];
+  for (const argument of arguments_) {
+    if (argument.includes('*')) {
+      // It's a glob pattern
+      const matches = glob.sync(argument);
+      allFiles.push(...matches);
+    } else {
+      // It's a direct file path
+      allFiles.push(argument);
+    }
+  }
+
+  for (const filePath of allFiles) {
+    if (!fs.existsSync(filePath)) {
+      // Skip silently for glob patterns that don't match anything
+      if (!arguments_.some((argument) => argument.includes('*') && filePath === argument)) {
+        console.error(chalk.red(`❌ File not found: ${filePath}`));
+        hasErrors = true;
+      }
+      continue;
+    }
+
+    const extension = path.extname(filePath).toLowerCase();
+    const basename = path.basename(filePath).toLowerCase();
+
+    try {
+      let changed = false;
+      if (extension === '.md') {
+        changed = await processMarkdownFile(filePath);
+      } else if (
+        extension === '.yaml' ||
+        extension === '.yml' ||
+        basename.includes('roomodes') ||
+        basename.includes('.yaml') ||
+        basename.includes('.yml')
+      ) {
+        // Handle YAML files and special cases like .roomodes
+        changed = await processYamlFile(filePath);
+
+        // Also run linting
+        const lintPassed = await lintYamlFile(filePath);
+        if (!lintPassed) hasErrors = true;
+      } else {
+        // Skip silently for unsupported files
+        continue;
+      }
+
+      if (changed) {
+        hasChanges = true;
+        filesProcessed.push(filePath);
+      }
+    } catch (error) {
+      console.error(chalk.red(`❌ Error processing ${filePath}:`), error.message);
+      hasErrors = true;
+    }
+  }
+
+  if (hasChanges) {
+    console.log(chalk.green(`\n✨ YAML formatting completed! Modified ${filesProcessed.length} files:`));
+    for (const file of filesProcessed) console.log(chalk.blue(`  📝 ${file}`));
+  }
+
+  if (hasErrors) {
+    console.error(chalk.red('\n💥 Some files had errors. Please fix them before committing.'));
+    process.exit(1);
+  }
+}
+
+if (require.main === module) {
+  main().catch((error) => {
+    console.error('Error:', error);
+    process.exit(1);
+  });
+}
+
+module.exports = { formatYamlContent, processMarkdownFile, processYamlFile };

package/tools/javascript-conventions.md

@@ -0,0 +1,5 @@
+# JavaScript Conventions
+
+## Function ordering
+
+Define functions top-to-bottom in call order: callers above callees. If `install()` calls `_initPaths()`, then `install` appears first and `_initPaths` appears after it.

package/tools/migrate-custom-module-paths.js

@@ -0,0 +1,124 @@
+/**
+ * Migration script to convert relative paths to absolute paths in custom module manifests
+ * This should be run once to update existing installations
+ */
+
+const fs = require('fs-extra');
+const path = require('node:path');
+const yaml = require('yaml');
+const chalk = require('chalk');
+
+/**
+ * Find SCM directory in project
+ */
+function findBmadDir(projectDir = process.cwd()) {
+  const possibleNames = ['_scm'];
+
+  for (const name of possibleNames) {
+    const scmDir = path.join(projectDir, name);
+    if (fs.existsSync(scmDir)) {
+      return scmDir;
+    }
+  }
+
+  return null;
+}
+
+/**
+ * Update manifest to use absolute paths
+ */
+async function updateManifest(manifestPath, projectRoot) {
+  console.log(chalk.cyan(`\nUpdating manifest: ${manifestPath}`));
+
+  const content = await fs.readFile(manifestPath, 'utf8');
+  const manifest = yaml.parse(content);
+
+  if (!manifest.customModules || manifest.customModules.length === 0) {
+    console.log(chalk.dim('  No custom modules found'));
+    return false;
+  }
+
+  let updated = false;
+
+  for (const customModule of manifest.customModules) {
+    if (customModule.relativePath && !customModule.sourcePath) {
+      // Convert relative path to absolute
+      const absolutePath = path.resolve(projectRoot, customModule.relativePath);
+      customModule.sourcePath = absolutePath;
+
+      // Remove the old relativePath
+      delete customModule.relativePath;
+
+      console.log(chalk.green(`  ✓ Updated ${customModule.id}: ${customModule.relativePath} → ${absolutePath}`));
+      updated = true;
+    } else if (customModule.sourcePath && !path.isAbsolute(customModule.sourcePath)) {
+      // Source path exists but is not absolute
+      const absolutePath = path.resolve(customModule.sourcePath);
+      customModule.sourcePath = absolutePath;
+
+      console.log(chalk.green(`  ✓ Updated ${customModule.id}: ${customModule.sourcePath} → ${absolutePath}`));
+      updated = true;
+    }
+  }
+
+  if (updated) {
+    // Write back the updated manifest
+    const yamlStr = yaml.dump(manifest, {
+      indent: 2,
+      lineWidth: -1,
+      noRefs: true,
+      sortKeys: false,
+    });
+
+    await fs.writeFile(manifestPath, yamlStr);
+    console.log(chalk.green('  Manifest updated successfully'));
+  } else {
+    console.log(chalk.dim('  All paths already absolute'));
+  }
+
+  return updated;
+}
+
+/**
+ * Main migration function
+ */
+async function migrate(directory) {
+  const projectRoot = path.resolve(directory || process.cwd());
+  const scmDir = findBmadDir(projectRoot);
+
+  if (!scmDir) {
+    console.error(chalk.red('✗ No SCM installation found in directory'));
+    process.exit(1);
+  }
+
+  console.log(chalk.blue.bold('🔄 SCM Custom Module Path Migration'));
+  console.log(chalk.dim(`Project: ${projectRoot}`));
+  console.log(chalk.dim(`SCM Directory: ${scmDir}`));
+
+  const manifestPath = path.join(scmDir, '_config', 'manifest.yaml');
+
+  if (!fs.existsSync(manifestPath)) {
+    console.error(chalk.red('✗ No manifest.yaml found'));
+    process.exit(1);
+  }
+
+  const updated = await updateManifest(manifestPath, projectRoot);
+
+  if (updated) {
+    console.log(chalk.green.bold('\n✨ Migration completed successfully!'));
+    console.log(chalk.dim('Custom modules now use absolute source paths.'));
+  } else {
+    console.log(chalk.yellow('\n⚠ No migration needed - paths already absolute'));
+  }
+}
+
+// Run migration if called directly
+if (require.main === module) {
+  const directory = process.argv[2];
+  migrate(directory).catch((error) => {
+    console.error(chalk.red('\n✗ Migration failed:'), error.message);
+    process.exit(1);
+  });
+}
+
+module.exports = { migrate };

package/tools/platform-codes.yaml

@@ -0,0 +1,169 @@
+# SCM Platform Codes Configuration
+# Central configuration for all platform/IDE codes used in the SCM system
+#
+# This file defines the standardized platform codes that are used throughout
+# the installation system to identify different platforms (IDEs, tools, etc.)
+#
+# Format:
+#   code: Platform identifier used internally
+#   name: Display name shown to users
+#   preferred: Whether this platform is shown as a recommended option on install
+#   category: Type of platform (ide, tool, service, etc.)
+
+platforms:
+  # Recommended Platforms
+  claude-code:
+    name: "Claude Code"
+    preferred: true
+    category: cli
+    description: "Anthropic's official CLI for Claude"
+
+  cursor:
+    name: "Cursor"
+    preferred: true
+    category: ide
+    description: "AI-first code editor"
+
+  # Other IDEs and Tools
+  cline:
+    name: "Cline"
+    preferred: false
+    category: ide
+    description: "AI coding assistant"
+
+  opencode:
+    name: "OpenCode"
+    preferred: false
+    category: ide
+    description: "OpenCode terminal coding assistant"
+
+  codebuddy:
+    name: "CodeBuddy"
+    preferred: false
+    category: ide
+    description: "Tencent Cloud Code Assistant - AI-powered coding companion"
+
+  auggie:
+    name: "Auggie"
+    preferred: false
+    category: cli
+    description: "AI development tool"
+
+  roo:
+    name: "Roo Code"
+    preferred: false
+    category: ide
+    description: "Enhanced Cline fork"
+
+  rovo-dev:
+    name: "Rovo Dev"
+    preferred: false
+    category: ide
+    description: "Atlassian's Rovo development environment"
+
+  kiro:
+    name: "Kiro"
+    preferred: false
+    category: ide
+    description: "Amazon's AI-powered IDE"
+
+  github-copilot:
+    name: "GitHub Copilot"
+    preferred: false
+    category: ide
+    description: "GitHub's AI pair programmer"
+
+  codex:
+    name: "Codex"
+    preferred: false
+    category: cli
+    description: "OpenAI Codex integration"
+
+  qwen:
+    name: "QwenCoder"
+    preferred: false
+    category: ide
+    description: "Qwen AI coding assistant"
+
+  gemini:
+    name: "Gemini CLI"
+    preferred: false
+    category: cli
+    description: "Google's CLI for Gemini"
+
+  iflow:
+    name: "iFlow"
+    preferred: false
+    category: ide
+    description: "AI workflow automation"
+
+  kilo:
+    name: "KiloCoder"
+    preferred: false
+    category: ide
+    description: "AI coding platform"
+
+  crush:
+    name: "Crush"
+    preferred: false
+    category: ide
+    description: "AI development assistant"
+
+  antigravity:
+    name: "Google Antigravity"
+    preferred: false
+    category: ide
+    description: "Google's AI development environment"
+
+  trae:
+    name: "Trae"
+    preferred: false
+    category: ide
+    description: "AI coding tool"
+
+  windsurf:
+    name: "Windsurf"
+    preferred: false
+    category: ide
+    description: "AI-powered IDE with cascade flows"
+
+  junie:
+    name: "Junie"
+    preferred: false
+    category: cli
+    description: "AI coding agent by JetBrains"
+
+  ona:
+    name: "Ona"
+    preferred: false
+    category: ide
+    description: "Ona AI development environment"
+
+# Platform categories
+categories:
+  ide:
+    name: "Integrated Development Environment"
+    description: "Full-featured code editors with AI assistance"
+
+  cli:
+    name: "Command Line Interface"
+    description: "Terminal-based tools"
+
+  tool:
+    name: "Development Tool"
+    description: "Standalone development utilities"
+
+  service:
+    name: "Cloud Service"
+    description: "Cloud-based development platforms"
+
+  extension:
+    name: "Editor Extension"
+    description: "Plugins for existing editors"
+
+# Naming conventions and rules
+conventions:
+  code_format: "lowercase-kebab-case"
+  name_format: "Title Case"
+  max_code_length: 20
+  allowed_characters: "a-z0-9-"