setup-vibeflow 0.1.1 → 0.3.0

package/index.js

@@ -8,9 +8,8 @@ import pc from 'picocolors';
 
 const REPO = 'pe-menezes/vibeflow';
 const BRANCH = 'main';
-const BASE_URL = `https://raw.githubusercontent.com/${REPO}/${BRANCH}/copilot`;
 
-const FILES = [
+const COPILOT_FILES = [
   { src: 'github/prompts/vibeflow-analyze.prompt.md', dest: '.github/prompts/vibeflow-analyze.prompt.md' },
   { src: 'github/prompts/vibeflow-audit.prompt.md', dest: '.github/prompts/vibeflow-audit.prompt.md' },
   { src: 'github/prompts/vibeflow-discover.prompt.md', dest: '.github/prompts/vibeflow-discover.prompt.md' },
@@ -24,8 +23,65 @@ const FILES = [
   { src: 'github/instructions/vibeflow/vibeflow.instructions.md', dest: '.github/instructions/vibeflow/vibeflow.instructions.md' },
 ];
 
+const CURSOR_FILES = [
+  { src: 'rules/vibeflow.mdc', dest: '.cursor/rules/vibeflow.mdc' },
+  { src: 'rules/vibeflow-architect.mdc', dest: '.cursor/rules/vibeflow-architect.mdc' },
+  { src: 'skills/vibeflow-analyze/SKILL.md', dest: '.cursor/skills/vibeflow-analyze/SKILL.md' },
+  { src: 'skills/vibeflow-audit/SKILL.md', dest: '.cursor/skills/vibeflow-audit/SKILL.md' },
+  { src: 'skills/vibeflow-discover/SKILL.md', dest: '.cursor/skills/vibeflow-discover/SKILL.md' },
+  { src: 'skills/vibeflow-gen-spec/SKILL.md', dest: '.cursor/skills/vibeflow-gen-spec/SKILL.md' },
+  { src: 'skills/vibeflow-prompt-pack/SKILL.md', dest: '.cursor/skills/vibeflow-prompt-pack/SKILL.md' },
+  { src: 'skills/vibeflow-quick/SKILL.md', dest: '.cursor/skills/vibeflow-quick/SKILL.md' },
+  { src: 'skills/vibeflow-teach/SKILL.md', dest: '.cursor/skills/vibeflow-teach/SKILL.md' },
+  { src: 'skills/vibeflow-stats/SKILL.md', dest: '.cursor/skills/vibeflow-stats/SKILL.md' },
+  { src: 'skills/vibeflow-spec-driven-dev/SKILL.md', dest: '.cursor/skills/vibeflow-spec-driven-dev/SKILL.md' },
+];
+
+const EDITIONS = {
+  copilot: {
+    name: 'Copilot',
+    baseUrl: `https://raw.githubusercontent.com/${REPO}/${BRANCH}/copilot`,
+    files: COPILOT_FILES,
+    marker: '.github/prompts/vibeflow-analyze.prompt.md',
+    markerLegacy: '.github/prompts/vibeflow/vibeflow-analyze.prompt.md',
+    agentsSrc: 'AGENTS.md',
+    doneMessage: `Run ${pc.bold('/vibeflow-analyze')} in Copilot Chat to get started.`,
+    handleCopilotInstructions: true,
+  },
+  cursor: {
+    name: 'Cursor',
+    baseUrl: `https://raw.githubusercontent.com/${REPO}/${BRANCH}/cursor`,
+    files: CURSOR_FILES,
+    marker: '.cursor/rules/vibeflow.mdc',
+    markerLegacy: null,
+    agentsSrc: 'AGENTS.md',
+    doneMessage: `Type ${pc.bold('/vibeflow-analyze')} in Cursor Agent chat to get started.`,
+    handleCopilotInstructions: false,
+  },
+};
+
 const DUPLICATE_MARKER = 'vibeflow-architect';
 
+const GITIGNORE_MARKER = '# Vibeflow — installed + generated (remove to track in git)';
+
+const GITIGNORE_BLOCKS = {
+  copilot: `
+# Vibeflow — installed + generated (remove to track in git)
+.vibeflow/
+.github/prompts/vibeflow-*.prompt.md
+.github/agents/vibeflow-architect.agent.md
+.github/skills/vibeflow-spec-driven-dev/
+.github/instructions/vibeflow/
+`,
+  cursor: `
+# Vibeflow — installed + generated (remove to track in git)
+.vibeflow/
+.cursor/rules/vibeflow.mdc
+.cursor/rules/vibeflow-architect.mdc
+.cursor/skills/vibeflow-*/
+`,
+};
+
 // --- Helpers ---
 
 function log(icon, msg) {
@@ -38,8 +94,8 @@ function ensureDir(dirPath) {
   }
 }
 
-async function downloadFile(srcPath) {
-  const url = `${BASE_URL}/${srcPath}`;
+async function downloadFile(baseUrl, srcPath) {
+  const url = `${baseUrl}/${srcPath}`;
   const res = await fetch(url);
   if (!res.ok) {
     throw new Error(`Failed to download ${url}: ${res.status} ${res.statusText}`);
@@ -48,27 +104,67 @@ async function downloadFile(srcPath) {
 }
 
 function extractAgentsAppendContent(fullContent) {
-  // Remove the instruction note at the top (everything before and including the first ---)
   const separatorIndex = fullContent.indexOf('\n---\n');
   if (separatorIndex === -1) return fullContent;
   return fullContent.slice(separatorIndex + '\n---\n'.length);
 }
 
 function extractCopilotInstructionsSnippet(fullContent) {
-  // Extract the markdown block between ```markdown and ```
   const match = fullContent.match(/```markdown\n([\s\S]*?)```/);
   if (!match) return null;
   return match[1].trim();
 }
 
+function detectEdition() {
+  const args = process.argv.slice(2);
+  if (args.includes('--cursor')) return 'cursor';
+  if (args.includes('--copilot')) return 'copilot';
+  return null;
+}
+
+function printUsage() {
+  console.log('');
+  console.log(`  ${pc.bold(pc.cyan('Vibeflow'))} ${pc.dim('— Setup')}`);
+  console.log('');
+  console.log(`  ${pc.bold('Usage:')} npx setup-vibeflow@latest ${pc.cyan('<edition>')}`);
+  console.log('');
+  console.log(`  ${pc.bold('Editions:')}`);
+  console.log(`    ${pc.cyan('--copilot')}   Install for GitHub Copilot ${pc.dim('(.github/prompts, agents, instructions)')}`);
+  console.log(`    ${pc.cyan('--cursor')}    Install for Cursor ${pc.dim('(.cursor/rules, skills)')}`);
+  console.log('');
+  console.log(`  ${pc.bold('Options:')}`);
+  console.log(`    ${pc.cyan('--force')}     Overwrite existing files`);
+  console.log('');
+  console.log(`  ${pc.bold('Examples:')}`);
+  console.log(`    ${pc.dim('$')} npx setup-vibeflow@latest --copilot`);
+  console.log(`    ${pc.dim('$')} npx setup-vibeflow@latest --cursor`);
+  console.log(`    ${pc.dim('$')} npx setup-vibeflow@latest --cursor --force`);
+  console.log('');
+}
+
 // --- Main ---
 
 async function main() {
   const force = process.argv.includes('--force');
+  const help = process.argv.includes('--help') || process.argv.includes('-h');
   const cwd = process.cwd();
 
+  if (help) {
+    printUsage();
+    process.exit(0);
+  }
+
+  const editionKey = detectEdition();
+
+  if (!editionKey) {
+    printUsage();
+    process.exit(1);
+  }
+
+  const edition = EDITIONS[editionKey];
+
   console.log('');
-  console.log(`  ${pc.bold(pc.cyan('Vibeflow'))} ${pc.dim('— Copilot Edition')}`);
+  console.log(`  ${pc.bold(pc.cyan('Vibeflow'))} ${pc.dim(`— ${edition.name} Edition`)}`);
   console.log('');
 
   // Check Node.js version
@@ -78,10 +174,10 @@ async function main() {
     process.exit(1);
   }
 
-  // Check if already installed (flat structure or legacy subdirectory structure)
-  const markerFlat = join(cwd, '.github/prompts/vibeflow-analyze.prompt.md');
-  const markerLegacy = join(cwd, '.github/prompts/vibeflow/vibeflow-analyze.prompt.md');
-  if ((existsSync(markerFlat) || existsSync(markerLegacy)) && !force) {
+  // Check if already installed
+  const markerPath = join(cwd, edition.marker);
+  const markerLegacyPath = edition.markerLegacy ? join(cwd, edition.markerLegacy) : null;
+  if ((existsSync(markerPath) || (markerLegacyPath && existsSync(markerLegacyPath))) && !force) {
     log(pc.yellow('!'), 'Vibeflow already installed. Use --force to reinstall.');
     console.log('');
     process.exit(0);
@@ -91,7 +187,7 @@ async function main() {
   let created = 0;
   let skipped = 0;
 
-  for (const file of FILES) {
+  for (const file of edition.files) {
     const destPath = join(cwd, file.dest);
     const destDir = join(destPath, '..');
 
@@ -102,7 +198,7 @@ async function main() {
     }
 
     try {
-      const content = await downloadFile(file.src);
+      const content = await downloadFile(edition.baseUrl, file.src);
       ensureDir(destDir);
       writeFileSync(destPath, content, 'utf-8');
       log(pc.green('+'), file.dest);
@@ -118,7 +214,7 @@ async function main() {
   // Handle AGENTS.md
   const agentsPath = join(cwd, 'AGENTS.md');
   try {
-    const agentsSource = await downloadFile('AGENTS.md');
+    const agentsSource = await downloadFile(edition.baseUrl, edition.agentsSrc);
     const appendContent = extractAgentsAppendContent(agentsSource);
 
     if (existsSync(agentsPath)) {
@@ -138,27 +234,50 @@ async function main() {
     log(pc.red('x'), `AGENTS.md — ${err.message}`);
   }
 
-  // Handle copilot-instructions.md
-  const copilotInstrPath = join(cwd, '.github/copilot-instructions.md');
+  // Handle copilot-instructions.md (Copilot only)
+  if (edition.handleCopilotInstructions) {
+    const copilotInstrPath = join(cwd, '.github/copilot-instructions.md');
+    try {
+      if (existsSync(copilotInstrPath)) {
+        const existing = readFileSync(copilotInstrPath, 'utf-8');
+        if (existing.includes('vibeflow') && !force) {
+          log(pc.dim('-'), `${pc.dim('.github/copilot-instructions.md')} ${pc.dim('(vibeflow snippet exists, skipped)')}`);
+        } else {
+          const snippetSource = await downloadFile(edition.baseUrl, 'copilot-instructions.md');
+          const snippet = extractCopilotInstructionsSnippet(snippetSource);
+          if (snippet) {
+            const updated = existing.trimEnd() + '\n\n' + snippet + '\n';
+            writeFileSync(copilotInstrPath, updated, 'utf-8');
+            log(pc.green('+'), `.github/copilot-instructions.md ${pc.dim('(appended vibeflow snippet)')}`);
+          }
+        }
+      } else {
+        log(pc.dim('-'), `${pc.dim('.github/copilot-instructions.md')} ${pc.dim('(not found, skipping — instructions auto-loaded)')}`);
+      }
+    } catch (err) {
+      log(pc.red('x'), `.github/copilot-instructions.md — ${err.message}`);
+    }
+  }
+
+  // Append Vibeflow paths to .gitignore (default: do not track; user can remove to track)
+  const gitignorePath = join(cwd, '.gitignore');
   try {
-    if (existsSync(copilotInstrPath)) {
-      const existing = readFileSync(copilotInstrPath, 'utf-8');
-      if (existing.includes('vibeflow') && !force) {
-        log(pc.dim('-'), `${pc.dim('.github/copilot-instructions.md')} ${pc.dim('(vibeflow snippet exists, skipped)')}`);
+    const block = GITIGNORE_BLOCKS[editionKey];
+    if (block) {
+      let content = '';
+      if (existsSync(gitignorePath)) {
+        content = readFileSync(gitignorePath, 'utf-8');
+      }
+      if (!content.includes(GITIGNORE_MARKER)) {
+        const updated = (content.trimEnd() ? content.trimEnd() + '\n' : '') + block.trim() + '\n';
+        writeFileSync(gitignorePath, updated, 'utf-8');
+        log(pc.green('+'), `.gitignore ${pc.dim('(Vibeflow paths added — remove that block to track in git)')}`);
       } else {
-        const snippetSource = await downloadFile('copilot-instructions.md');
-        const snippet = extractCopilotInstructionsSnippet(snippetSource);
-        if (snippet) {
-          const updated = existing.trimEnd() + '\n\n' + snippet + '\n';
-          writeFileSync(copilotInstrPath, updated, 'utf-8');
-          log(pc.green('+'), `.github/copilot-instructions.md ${pc.dim('(appended vibeflow snippet)')}`);
-        }
+        log(pc.dim('-'), `${pc.dim('.gitignore')} ${pc.dim('(Vibeflow block already present)')}`);
       }
-    } else {
-      log(pc.dim('-'), `${pc.dim('.github/copilot-instructions.md')} ${pc.dim('(not found, skipping — instructions auto-loaded)')}`);
     }
   } catch (err) {
-    log(pc.red('x'), `.github/copilot-instructions.md — ${err.message}`);
+    log(pc.red('x'), `.gitignore — ${err.message}`);
   }
 
   // Summary
@@ -169,7 +288,7 @@ async function main() {
     log(pc.yellow('!'), pc.bold('All files already exist. Nothing to do.'));
   }
   console.log('');
-  log(pc.cyan('→'), `Run ${pc.bold('/vibeflow-analyze')} in Copilot Chat to get started.`);
+  log(pc.cyan('→'), edition.doneMessage);
   console.log('');
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-vibeflow",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Install Vibeflow (spec-driven development) in your project",
   "bin": {
     "setup-vibeflow": "./index.js"
@@ -13,9 +13,12 @@
     "vibeflow",
     "copilot",
     "github-copilot",
+    "cursor",
+    "cursor-ide",
     "spec-driven",
     "prompts",
-    "agents"
+    "agents",
+    "skills"
   ],
   "author": "pe-menezes",
   "license": "MIT",