mdboard 1.2.0 → 2.0.0

package/src/cli/config.js

@@ -0,0 +1,234 @@
+/**
+ * mdboard config — Interactive configuration wizard
+ *
+ * Guides the user through initial setup:
+ *   Step 1: Methodology (preset selection)
+ *   Step 2: Theme preference
+ *   Step 3: Configuration overview (informational)
+ *   Step 4: AI Skill installation
+ *
+ * Usage:
+ *   mdboard config
+ */
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const readline = require('readline');
+const configEngine = require('../core/config');
+const { installSkill, AGENTS } = require('./skill');
+
+var cwd = process.cwd();
+
+/**
+ * Run the config wizard.
+ *
+ * @param {string[]} args - CLI arguments after 'config'
+ */
+function run(args) {
+  var rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+
+  console.log('\n  mdboard config — Setup wizard\n');
+
+  stepMethodology(rl);
+}
+
+// --- Step 1: Methodology ---
+
+function stepMethodology(rl) {
+  // Read available presets
+  var presets = [];
+  try {
+    presets = fs.readdirSync(configEngine.PRESETS_DIR).filter(function (d) {
+      return fs.statSync(path.join(configEngine.PRESETS_DIR, d)).isDirectory();
+    });
+  } catch (e) { /* ignore */ }
+
+  console.log('  Step 1: Methodology\n');
+  for (var i = 0; i < presets.length; i++) {
+    console.log('    ' + (i + 1) + ') ' + presets[i]);
+  }
+  console.log('');
+
+  var currentPreset = configEngine.DEFAULT_PRESET;
+  try {
+    var cfg = configEngine.loadConfig(cwd, process.env.MDBOARD_CONFIG);
+    currentPreset = cfg._preset;
+  } catch (e) { /* ignore */ }
+
+  rl.question('  Choice [' + currentPreset + ']: ', function (answer) {
+    var choice = answer.trim();
+    var preset = currentPreset;
+
+    if (choice !== '') {
+      var idx = parseInt(choice, 10);
+      if (idx >= 1 && idx <= presets.length) {
+        preset = presets[idx - 1];
+      } else if (presets.includes(choice)) {
+        preset = choice;
+      } else {
+        console.log('  Preset "' + choice + '" not yet available. Using ' + currentPreset + '.');
+      }
+    }
+
+    // Set for the rest of the process
+    process.env.MDBOARD_PRESET = preset;
+
+    // Scaffold if project/ doesn't exist
+    var projectPath = path.join(cwd, 'project');
+    if (!fs.existsSync(projectPath)) {
+      console.log('  No project/ found — scaffolding with ' + preset + ' preset...');
+      try {
+        require('./init');
+      } catch (e) {
+        // init.js may call process.exit, so we catch and continue
+      }
+    } else {
+      console.log('  Methodology: ' + preset);
+      console.log('  project/ already exists — keeping existing data.\n');
+    }
+
+    stepTheme(rl, preset);
+  });
+}
+
+// --- Step 2: Theme ---
+
+function stepTheme(rl, preset) {
+  console.log('  Step 2: Theme\n');
+  console.log('    1) default     Dark theme (built-in)');
+  console.log('    2) light       Light theme');
+  console.log('    3) custom      Edit project/mdboard.css\n');
+
+  rl.question('  Choice [default]: ', function (answer) {
+    var choice = answer.trim();
+    var theme = 'default';
+
+    if (choice === '2' || choice === 'light') {
+      theme = 'light';
+    } else if (choice === '3' || choice === 'custom') {
+      theme = 'custom';
+    }
+
+    // Save theme preference
+    if (theme !== 'default') {
+      var globalDir = path.join(os.homedir(), '.config', 'mdboard');
+      if (!fs.existsSync(globalDir)) {
+        fs.mkdirSync(globalDir, { recursive: true });
+      }
+      var configPath = path.join(globalDir, 'mdboard.json');
+      var globalCfg = {};
+      try { globalCfg = JSON.parse(fs.readFileSync(configPath, 'utf-8')); } catch (e) { /* */ }
+      globalCfg.theme = theme;
+      fs.writeFileSync(configPath, JSON.stringify(globalCfg, null, 2) + '\n', 'utf-8');
+      console.log('  Theme saved: ' + theme + '\n');
+    } else {
+      console.log('  Theme: default\n');
+    }
+
+    stepConfiguration(rl, preset);
+  });
+}
+
+// --- Step 3: Configuration overview ---
+
+function stepConfiguration(rl, preset) {
+  console.log('  Step 3: Configuration\n');
+
+  var cfg;
+  try {
+    cfg = configEngine.loadConfig(cwd, process.env.MDBOARD_CONFIG);
+  } catch (e) {
+    cfg = configEngine.loadConfig(null);
+  }
+
+  var types = configEngine.getEntityTypes(cfg);
+  var flat = configEngine.flattenHierarchy(cfg);
+  var hierarchy = flat.filter(function (e) { return !e.standalone; });
+  var chain = hierarchy.map(function (e) {
+    var entity = configEngine.getEntity(cfg, e.type);
+    return entity ? entity.singular : e.type;
+  }).join(' > ');
+
+  console.log('  Preset:    ' + preset);
+  console.log('  Hierarchy: ' + chain);
+  console.log('  Entities:  ' + types.join(', '));
+  console.log('');
+  console.log('  Config files (in presets/' + preset + '/):');
+  console.log('    entities.json    Entity definitions, fields, statuses');
+  console.log('    structure.json   Directory layout & hierarchy');
+  console.log('    cli.json         CLI command config');
+  console.log('    api.json         API endpoint config');
+  console.log('    ui.json          Dashboard UI tabs & layout');
+  console.log('    docs.json        Documentation & status report');
+  console.log('');
+  console.log('  Override any file by placing it in project/<file>.json');
+  console.log('');
+
+  stepSkill(rl);
+}
+
+// --- Step 4: AI Skill ---
+
+function stepSkill(rl) {
+  console.log('  Step 4: AI Skill\n');
+  console.log('  Install an AI skill so your IDE/agent understands this project.\n');
+  console.log('    1) Claude Code     ~/.claude/skills/mdboard/SKILL.md');
+  console.log('    2) Cursor          .cursor/rules/mdboard.mdc');
+  console.log('    3) Windsurf        .windsurf/rules/mdboard.md');
+  console.log('    4) VS Code         .claude/skills/mdboard/SKILL.md');
+  console.log('    5) Custom path');
+  console.log('    6) Skip\n');
+
+  rl.question('  Choice [6]: ', function (answer) {
+    var choice = answer.trim() || '6';
+
+    if (choice === '6') {
+      finishWizard(rl);
+      return;
+    }
+
+    if (choice === '5') {
+      rl.question('  Path: ', function (pathAnswer) {
+        var p = path.resolve(pathAnswer.trim());
+        var fmt = p.endsWith('.mdc') ? 'mdc' : 'skill-md';
+        installSkill(cwd, p, fmt);
+        console.log('  Skill installed: ' + p);
+        finishWizard(rl);
+      });
+      return;
+    }
+
+    var agentKeys = ['claude-code', 'cursor', 'windsurf', 'vscode'];
+    var idx = parseInt(choice, 10) - 1;
+    if (idx < 0 || idx >= agentKeys.length) {
+      console.log('  Invalid choice — skipping.');
+      finishWizard(rl);
+      return;
+    }
+
+    var agent = AGENTS[agentKeys[idx]];
+    var fp = agent.path();
+    installSkill(cwd, fp, agent.format);
+    console.log('  Skill installed: ' + agent.label + ' → ' + fp);
+    finishWizard(rl);
+  });
+}
+
+// --- Done ---
+
+function finishWizard(rl) {
+  console.log('\n  Setup complete!\n');
+  console.log('  Next steps:');
+  console.log('    mdboard              Start the dashboard');
+  console.log('    mdboard create ...   Create your first entity');
+  console.log('    mdboard preset list  Switch methodology or create a custom preset');
+  console.log('    mdboard skill        Re-install skill anytime');
+  console.log('');
+  rl.close();
+  process.exit(0);
+}
+
+module.exports = { run };

package/src/cli/init.js

@@ -0,0 +1,175 @@
+/**
+ * mdboard init — Scaffold a new workspace with preset support
+ *
+ * Usage:
+ *   mdboard init [name] [--preset shape-up]
+ *
+ * Creates the project/ directory structure based on the selected methodology preset.
+ * All directories and files are generated from the preset's structure.json config.
+ */
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+const configEngine = require('../core/config');
+
+const cwd = process.cwd();
+const projectPath = path.join(cwd, 'project');
+const today = new Date().toISOString().split('T')[0];
+const args = process.argv.slice(2).filter(a => a !== 'init');
+
+// Parse flags
+const preset = process.env.MDBOARD_PRESET || parseFlag('preset') || configEngine.DEFAULT_PRESET;
+const nameArg = args.filter(a => !a.startsWith('--'))[0] || '';
+
+function parseFlag(flag) {
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--' + flag && args[i + 1]) return args[i + 1];
+  }
+  return null;
+}
+
+// Check if project already exists
+if (fs.existsSync(projectPath)) {
+  console.log('\n  project/ already exists at ' + projectPath);
+  console.log('  Skipping init to avoid overwriting existing data.\n');
+  process.exit(0);
+}
+
+// Validate preset exists
+const presetDir = path.join(configEngine.PRESETS_DIR, preset);
+if (!fs.existsSync(presetDir)) {
+  const available = fs.readdirSync(configEngine.PRESETS_DIR).filter(d => {
+    return fs.statSync(path.join(configEngine.PRESETS_DIR, d)).isDirectory();
+  });
+  console.error('\n  Error: unknown preset "' + preset + '"');
+  console.error('  Available presets: ' + available.join(', ') + '\n');
+  process.exit(1);
+}
+
+if (nameArg) {
+  scaffold(nameArg);
+} else {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  rl.question('  Workspace name: ', function (answer) {
+    rl.close();
+    const name = answer.trim() || path.basename(cwd);
+    scaffold(name);
+  });
+}
+
+function scaffold(name) {
+  // Load preset config
+  const cfg = configEngine.loadConfig(null);
+  const structure = cfg.structure || {};
+  const root = structure.root || 'project';
+  const hierarchy = structure.hierarchy || {};
+  const standalone = structure.standalone || {};
+
+  // Create root directory
+  fs.mkdirSync(projectPath, { recursive: true });
+
+  // Create hierarchy directories
+  createHierarchyDirs(projectPath, hierarchy);
+
+  // Create standalone directories
+  for (const [type, def] of Object.entries(standalone)) {
+    fs.mkdirSync(path.join(projectPath, def.dir), { recursive: true });
+  }
+
+  // Create archive directory if defined
+  if (structure.archive && structure.archive.dir) {
+    fs.mkdirSync(path.join(projectPath, structure.archive.dir), { recursive: true });
+  }
+
+  // PROJECT.md
+  fs.writeFileSync(path.join(projectPath, 'PROJECT.md'), '---\nname: "' + name + '"\ndescription: ""\ncreated: ' + today + '\nmethodology: ' + preset + '\n---\n\n# ' + name + '\n\n## Overview\n\nDescribe your project here.\n\n## Objectives\n\n-\n\n## Scope\n\n-\n', 'utf-8');
+
+  // mdboard.json — project config (preset + theme)
+  fs.writeFileSync(path.join(projectPath, 'mdboard.json'), JSON.stringify({ preset: preset }, null, 2) + '\n', 'utf-8');
+
+  // mdboard.css — example custom theme
+  fs.writeFileSync(path.join(projectPath, 'mdboard.css'), '/* mdboard custom theme\n   Override any CSS variable from the dashboard.\n   Example:\n   :root {\n     --bg: #FFFFFF;\n     --surface: #F8F9FA;\n     --text: #212529;\n     --accent: #0969DA;\n   }\n*/\n', 'utf-8');
+
+  // workspace.json
+  const wsPath = path.join(cwd, 'workspace.json');
+  if (!fs.existsSync(wsPath)) {
+    const slug = name.toLowerCase().replace(/\s+/g, '-');
+    fs.writeFileSync(wsPath, JSON.stringify({
+      name: name,
+      sources: [
+        { name: slug, label: name, path: '.', color: '#5B6EF5' }
+      ],
+      settings: {}
+    }, null, 2) + '\n', 'utf-8');
+  }
+
+  // Build directory listing for output
+  const dirs = collectDirs(hierarchy, standalone, structure.archive);
+
+  console.log('\n  mdboard init — workspace "' + name + '" scaffolded');
+  console.log('  Preset: ' + preset + '\n');
+  console.log('  Created:');
+  console.log('    project/PROJECT.md');
+  for (const d of dirs) {
+    console.log('    project/' + d + '/');
+  }
+  console.log('    project/mdboard.css');
+  console.log('    workspace.json');
+
+  console.log('\n  Next steps:');
+  console.log('    1. Edit project/PROJECT.md with your project details');
+
+  // Show first create command example from hierarchy
+  const firstType = Object.keys(hierarchy)[0];
+  if (firstType) {
+    const entity = configEngine.getEntity(cfg, firstType);
+    if (entity) {
+      console.log('    2. Create your first ' + entity.singular.toLowerCase() + ':');
+      console.log('       mdboard create ' + firstType + ' "My ' + entity.singular + '"');
+    }
+  }
+
+  console.log('    3. Run `mdboard` to start the dashboard');
+  console.log('\n  Other presets available:');
+  console.log('    mdboard preset list             See all methodologies');
+  console.log('    mdboard preset create <name>    Create a custom preset\n');
+}
+
+/**
+ * Recursively create directories for hierarchy entities.
+ */
+function createHierarchyDirs(basePath, hierarchy) {
+  for (const [type, def] of Object.entries(hierarchy)) {
+    fs.mkdirSync(path.join(basePath, def.dir), { recursive: true });
+    // Don't recurse into children dirs here — they get created
+    // inside entity instance dirs when entities are created via CLI
+  }
+}
+
+/**
+ * Collect directory names for output display.
+ */
+function collectDirs(hierarchy, standalone, archive) {
+  const dirs = [];
+
+  function walkHierarchy(node) {
+    for (const [type, def] of Object.entries(node)) {
+      dirs.push(def.dir);
+    }
+  }
+
+  walkHierarchy(hierarchy);
+
+  for (const [type, def] of Object.entries(standalone || {})) {
+    dirs.push(def.dir);
+  }
+
+  if (archive && archive.dir) {
+    dirs.push(archive.dir);
+  }
+
+  return dirs;
+}