@vibedx/vibekit 0.1.0

package/index.js

@@ -0,0 +1,106 @@
+#!/usr/bin/env node
+
+/**
+ * VibeKit - A developer-focused ticket and task management CLI tool
+ * 
+ * This is the main entry point for the VibeKit CLI application.
+ * It handles command routing and provides a consistent interface
+ * for all VibeKit operations.
+ * 
+ * @fileoverview Main CLI entry point for VibeKit
+ * @author VibeKit Team
+ * @version 1.0.0
+ */
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+
+// ESM replacement for __dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Available commands in VibeKit
+const AVAILABLE_COMMANDS = [
+  'init', 'new', 'close', 'list', 'get-started', 
+  'start', 'link', 'unlink', 'refine', 'lint', 'review'
+];
+
+/**
+ * Display available commands to the user
+ */
+function showAvailableCommands() {
+  console.log(`Available commands: ${AVAILABLE_COMMANDS.join(', ')}`);
+}
+
+/**
+ * Execute a VibeKit command
+ * @param {string} command - The command to execute
+ * @param {Array} args - Arguments to pass to the command
+ */
+async function executeCommand(command, args) {
+  const commandPath = path.join(__dirname, 'src', 'commands', command, 'index.js');
+  
+  try {
+    // Dynamic import for ESM
+    const commandModule = await import(commandPath);
+    const commandFunction = commandModule.default;
+    
+    if (typeof commandFunction === 'function') {
+      await commandFunction(args);
+    } else {
+      console.error(`❌ Command '${command}' is not executable.`);
+      process.exit(1);
+    }
+  } catch (err) {
+    if (err.code === 'ERR_MODULE_NOT_FOUND') {
+      showAvailableCommands();
+      console.error(`❌ Command '${command}' not found.`);
+    } else {
+      console.error(`❌ Error executing command '${command}': ${err.message}`);
+      
+      // Only show stack trace in debug mode or development
+      if (process.env.NODE_ENV === 'development' || process.env.DEBUG) {
+        console.error(err.stack);
+      }
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Main application entry point
+ */
+async function main() {
+  // Parse command line arguments
+  const [command, ...commandArgs] = process.argv.slice(2);
+  
+  try {
+    // Show help if no command provided
+    if (!command) {
+      console.log('🎆 VibeKit - Developer-focused ticket management\n');
+      showAvailableCommands();
+      console.log('\nUse "vibe <command>" to get started!');
+      process.exit(0);
+    }
+    
+    // Execute the requested command
+    await executeCommand(command, commandArgs);
+    
+  } catch (err) {
+    console.error(`❌ Unexpected error: ${err.message}`);
+    
+    // Only show stack trace in debug mode or development
+    if (process.env.NODE_ENV === 'development' || process.env.DEBUG) {
+      console.error(err.stack);
+    }
+    
+    process.exit(1);
+  }
+}
+
+// Run the application
+main().catch((error) => {
+  console.error(`❌ Fatal error: ${error.message}`);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@vibedx/vibekit",
+  "version": "0.1.0",
+  "description": "A powerful CLI tool for managing development tickets and project workflows",
+  "main": "index.js",
+  "type": "module",
+  "files": [
+    "index.js",
+    "src/",
+    "assets/"
+  ],
+  "bin": {
+    "vibe": "index.js"
+  },
+  "scripts": {
+    "start": "node --watch index.js",
+    "test": "npm run test:cleanup && NODE_OPTIONS='--experimental-vm-modules' jest --detectOpenHandles",
+    "test:watch": "NODE_OPTIONS='--experimental-vm-modules' jest --watch",
+    "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage --detectOpenHandles",
+    "test:cleanup": "rm -rf __temp__",
+    "prepublishOnly": "echo 'Ready to publish'",
+    "version": "git add -A && git commit -m 'chore: version bump'",
+    "postversion": "git push && git push --tags"
+  },
+  "keywords": [
+    "cli",
+    "tickets",
+    "workflow",
+    "development",
+    "project-management"
+  ],
+  "author": "Ives van Hoorne",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vibedx/vibekit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vibedx/vibekit/issues"
+  },
+  "homepage": "https://github.com/vibedx/vibekit#readme",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "clipboardy": "^4.0.0",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "jest": "^29.7.0"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "globals": {
+      "__DEV__": true
+    },
+    "testMatch": [
+      "**/src/**/*.test.js",
+      "**/__tests__/**/*.test.js",
+      "**/tests/**/*.test.js"
+    ],
+    "collectCoverage": true,
+    "coverageDirectory": "coverage",
+    "forceExit": true,
+    "coverageReporters": [
+      "text",
+      "lcov",
+      "html"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.js",
+      "index.js",
+      "!src/utils/cli.test.js",
+      "!src/**/*.test.js",
+      "!**/__tests__/**",
+      "!**/__temp__/**",
+      "!**/node_modules/**"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 13,
+        "functions": 20,
+        "lines": 14,
+        "statements": 14
+      }
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/commands/close/index.js

@@ -0,0 +1,66 @@
+import fs from 'fs';
+import path from 'path';
+import yaml from 'js-yaml';
+import { getTicketsDir } from '../../utils/index.js';
+
+/**
+ * Mark a ticket as done
+ * @param {string[]} args Command arguments
+ */
+function closeCommand(args) {
+  const ticketArg = args[0];
+
+  if (!ticketArg) {
+    console.error("❌ Please provide a ticket ID or number.");
+    process.exit(1);
+  }
+
+  const ticketFolder = getTicketsDir();
+  
+  if (!fs.existsSync(ticketFolder)) {
+    console.error(`❌ Tickets directory not found: ${ticketFolder}`);
+    process.exit(1);
+  }
+  
+  const files = fs.readdirSync(ticketFolder);
+  const normalizedInput = ticketArg.startsWith("TKT-")
+    ? ticketArg
+    : `TKT-${ticketArg.padStart(3, "0")}`;
+
+  let matchFound = false;
+
+  for (const file of files) {
+    const fullPath = path.join(ticketFolder, file);
+    
+    // Skip directories
+    if (fs.statSync(fullPath).isDirectory()) {
+      continue;
+    }
+    
+    const content = fs.readFileSync(fullPath, "utf-8");
+    const match = content.match(/^---\n([\s\S]*?)\n---/);
+
+    if (match) {
+      const frontmatter = yaml.load(match[1]);
+      if (
+        frontmatter.id === normalizedInput ||
+        file.includes(normalizedInput)
+      ) {
+        frontmatter.status = "done";
+
+        const updated = `---\n${yaml.dump(frontmatter)}---${content.split("---").slice(2).join("---")}`;
+        fs.writeFileSync(fullPath, updated, "utf-8");
+
+        console.log(`✅ Ticket ${frontmatter.id} marked as done.`);
+        matchFound = true;
+        break;
+      }
+    }
+  }
+
+  if (!matchFound) {
+    console.log(`❌ No ticket matching '${ticketArg}' found.`);
+  }
+}
+
+export default closeCommand;

package/src/commands/close/index.test.js

@@ -0,0 +1,235 @@
+import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
+import fs from 'fs';
+import path from 'path';
+import { 
+  createTempDir, 
+  cleanupTempDir, 
+  mockConsole, 
+  mockProcessCwd, 
+  mockProcessExit,
+  createMockVibeProject
+} from '../../utils/test-helpers.js';
+import closeCommand from './index.js';
+
+describe('close command', () => {
+  let tempDir;
+  let consoleMock;
+  let restoreCwd;
+  let exitMock;
+
+  beforeEach(() => {
+    tempDir = createTempDir('close-test');
+    consoleMock = mockConsole();
+    restoreCwd = mockProcessCwd(tempDir);
+    exitMock = mockProcessExit();
+  });
+
+  afterEach(() => {
+    consoleMock.restore();
+    restoreCwd();
+    exitMock.restore();
+    cleanupTempDir(tempDir);
+  });
+
+  describe('argument validation', () => {
+    it('should show error when no ticket ID provided', () => {
+      // Act
+      expect(() => closeCommand([])).toThrow('process.exit(1)');
+
+      // Assert
+      expect(exitMock.exitCalls).toContain(1);
+      expect(consoleMock.logs.error).toContain('❌ Please provide a ticket ID or number.');
+    });
+  });
+
+  describe('tickets directory validation', () => {
+    it('should show error when tickets directory does not exist', () => {
+      // Act - no vibe project created
+      expect(() => closeCommand(['TKT-001'])).toThrow('process.exit(1)');
+
+      // Assert
+      expect(exitMock.exitCalls).toContain(1);
+      expect(consoleMock.logs.error.some(log => 
+        log.includes('❌ Tickets directory not found:')
+      )).toBe(true);
+    });
+  });
+
+  describe('ticket closing', () => {
+    it('should mark ticket as done when found by full ID', () => {
+      // Arrange
+      createMockVibeProject(tempDir, {
+        withTickets: [
+          { 
+            id: 'TKT-001', 
+            title: 'Test ticket', 
+            status: 'open',
+            slug: 'test-ticket'
+          }
+        ]
+      });
+
+      // Act
+      closeCommand(['TKT-001']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain('✅ Ticket TKT-001 marked as done.');
+      
+      // Verify file was updated
+      const ticketPath = path.join(tempDir, '.vibe', 'tickets', 'TKT-001-test-ticket.md');
+      const content = fs.readFileSync(ticketPath, 'utf-8');
+      expect(content).toContain('status: done');
+    });
+
+    it('should mark ticket as done when found by number only', () => {
+      // Arrange
+      createMockVibeProject(tempDir, {
+        withTickets: [
+          { 
+            id: 'TKT-002', 
+            title: 'Another ticket', 
+            status: 'in_progress',
+            slug: 'another-ticket'
+          }
+        ]
+      });
+
+      // Act
+      closeCommand(['2']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain('✅ Ticket TKT-002 marked as done.');
+      
+      // Verify file was updated
+      const ticketPath = path.join(tempDir, '.vibe', 'tickets', 'TKT-002-another-ticket.md');
+      const content = fs.readFileSync(ticketPath, 'utf-8');
+      expect(content).toContain('status: done');
+    });
+
+    it('should preserve other frontmatter fields when updating status', () => {
+      // Arrange
+      createMockVibeProject(tempDir, {
+        withTickets: [
+          { 
+            id: 'TKT-003', 
+            title: 'Ticket with priority', 
+            status: 'open',
+            priority: 'high',
+            slug: 'ticket-with-priority'
+          }
+        ]
+      });
+
+      // Act
+      closeCommand(['TKT-003']);
+
+      // Assert
+      const ticketPath = path.join(tempDir, '.vibe', 'tickets', 'TKT-003-ticket-with-priority.md');
+      const content = fs.readFileSync(ticketPath, 'utf-8');
+      expect(content).toContain('status: done');
+      expect(content).toContain('priority: high');
+      expect(content).toContain('title: Ticket with priority');
+    });
+
+    it('should handle ticket not found', () => {
+      // Arrange
+      createMockVibeProject(tempDir, {
+        withTickets: [
+          { 
+            id: 'TKT-001', 
+            title: 'Existing ticket', 
+            status: 'open',
+            slug: 'existing-ticket'
+          }
+        ]
+      });
+
+      // Act
+      closeCommand(['TKT-999']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain("❌ No ticket matching 'TKT-999' found.");
+    });
+
+    it('should handle multiple tickets and find correct one', () => {
+      // Arrange
+      createMockVibeProject(tempDir, {
+        withTickets: [
+          { 
+            id: 'TKT-001', 
+            title: 'First ticket', 
+            status: 'open',
+            slug: 'first-ticket'
+          },
+          { 
+            id: 'TKT-002', 
+            title: 'Second ticket', 
+            status: 'in_progress',
+            slug: 'second-ticket'
+          },
+          { 
+            id: 'TKT-003', 
+            title: 'Third ticket', 
+            status: 'review',
+            slug: 'third-ticket'
+          }
+        ]
+      });
+
+      // Act
+      closeCommand(['2']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain('✅ Ticket TKT-002 marked as done.');
+      
+      // Verify only the targeted ticket was updated
+      const ticket1Path = path.join(tempDir, '.vibe', 'tickets', 'TKT-001-first-ticket.md');
+      const ticket2Path = path.join(tempDir, '.vibe', 'tickets', 'TKT-002-second-ticket.md');
+      const ticket3Path = path.join(tempDir, '.vibe', 'tickets', 'TKT-003-third-ticket.md');
+      
+      expect(fs.readFileSync(ticket1Path, 'utf-8')).toContain('status: open');
+      expect(fs.readFileSync(ticket2Path, 'utf-8')).toContain('status: done');
+      expect(fs.readFileSync(ticket3Path, 'utf-8')).toContain('status: review');
+    });
+  });
+
+  describe('error handling', () => {
+    it('should skip directories in tickets folder', () => {
+      // Arrange
+      const vibeProject = createMockVibeProject(tempDir);
+      
+      // Create a subdirectory in tickets folder
+      fs.mkdirSync(path.join(vibeProject.ticketsDir, 'subdirectory'));
+      
+      // Create a valid ticket
+      const ticketContent = `---
+id: TKT-001
+title: Valid ticket
+status: open
+---
+
+# Test ticket`;
+      fs.writeFileSync(path.join(vibeProject.ticketsDir, 'TKT-001-valid.md'), ticketContent, 'utf-8');
+
+      // Act
+      closeCommand(['TKT-001']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain('✅ Ticket TKT-001 marked as done.');
+    });
+
+    it('should handle files without proper frontmatter', () => {
+      // Arrange
+      const vibeProject = createMockVibeProject(tempDir);
+      
+      // Create invalid file without frontmatter
+      fs.writeFileSync(path.join(vibeProject.ticketsDir, 'invalid.md'), 'No frontmatter here', 'utf-8');
+      
+      // Act
+      closeCommand(['TKT-001']);
+
+      // Assert
+      expect(consoleMock.logs.log).toContain("❌ No ticket matching 'TKT-001' found.");
+    });
+  });
+});

package/src/commands/get-started/index.js

@@ -0,0 +1,138 @@
+import fs from 'fs';
+import path from 'path';
+import yaml from 'js-yaml';
+import { getTicketsDir, getConfig, getNextTicketId, createSlug } from '../../utils/index.js';
+
+/**
+ * Helper function to create sample tickets for the onboarding experience
+ * @param {string} title - The title of the ticket
+ * @param {string} description - The description of the ticket
+ * @param {string} priority - The priority of the ticket (low, medium, high)
+ * @param {string} status - The status of the ticket (open, in_progress, review, done)
+ */
+function createSampleTicket(title, description, priority = "medium", status = "open") {
+  const configPath = path.join(process.cwd(), ".vibe", "config.yml");
+  const templatePath = path.join(process.cwd(), ".vibe", ".templates", "default.md");
+  
+  if (!fs.existsSync(configPath) || !fs.existsSync(templatePath)) {
+    console.error("❌ Missing config.yml or default.md template.");
+    return false;
+  }
+  
+  const config = yaml.load(fs.readFileSync(configPath, "utf-8"));
+  const template = fs.readFileSync(templatePath, "utf-8");
+  const ticketDir = path.join(process.cwd(), config.tickets?.path || ".vibe/tickets");
+  
+  const files = fs.readdirSync(ticketDir);
+  const ticketNumbers = files
+    .map(f => f.match(/^TKT-(\\d+)/))
+    .filter(Boolean)
+    .map(match => parseInt(match[1], 10));
+  const nextId = Math.max(0, ...ticketNumbers) + 1;
+  const paddedId = String(nextId).padStart(3, "0");
+  const now = new Date().toISOString();
+  
+  const ticketId = `TKT-${paddedId}`;
+  const slug = title.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
+  const filename = `${ticketId}-${slug}.md`;
+  
+  // Replace template placeholders with actual values
+  let content = template
+    .replace(/{id}/g, paddedId)
+    .replace(/{title}/g, title)
+    .replace(/{date}/g, now);
+    
+  // Replace priority and status in the frontmatter
+  content = content.replace(/^priority: .*$/m, `priority: ${priority}`);
+  content = content.replace(/^status: .*$/m, `status: ${status}`);
+  
+  // Add description
+  content = content.replace(/## Description\\s*\\n\\s*\\n/m, `## Description\\n\\n${description}\\n\\n`);
+  
+  // Add AI prompt for the feature request example
+  if (title.includes("AI Prompt")) {
+    content = content.replace(/## AI Prompt\\s*\\n\\s*\\n/m, 
+      `## AI Prompt\\n\\nGenerate ideas for implementing this feature in a Node.js CLI application. Consider user experience, error handling, and performance.\\n\\n`);
+  }
+  
+  const outputPath = path.join(ticketDir, filename);
+  fs.writeFileSync(outputPath, content, "utf-8");
+  
+  console.log(`✅ Created sample ticket: ${filename}`);
+  return true;
+}
+
+/**
+ * Create onboarding materials for VibeKit
+ * @param {string[]} args Command arguments
+ */
+function getStartedCommand(args) {
+  console.log("✨ Welcome to VibeKit! Setting up your onboarding experience...");
+  
+  // Check if .vibe directory exists
+  if (!fs.existsSync(path.join(process.cwd(), ".vibe"))) {
+    console.error("❌ VibeKit is not initialized. Please run 'vibe init' first.");
+    process.exit(1);
+  }
+  
+  // Create .vibe/README.md with instructions
+  const readmePath = path.join(process.cwd(), ".vibe", "README.md");
+  const readmeContent = `# Welcome to VibeKit
+
+VibeKit is a CLI tool for managing tickets, project context, and AI suggestions inside your repository.
+
+## Getting Started
+
+Here are the main commands you can use:
+
+- \`vibe init\` - Initialize VibeKit in your repository
+- \`vibe new "Ticket title"\` - Create a new ticket
+- \`vibe list\` - List all tickets
+- \`vibe close TKT-XXX\` - Mark a ticket as done
+- \`vibe get-started\` - Create sample tickets and documentation
+
+## Ticket Structure
+
+Each ticket is a Markdown file with YAML frontmatter containing metadata like:
+- id
+- title
+- status
+- priority
+- created_at
+- updated_at
+
+The body of the ticket contains sections for Description, Acceptance Criteria, Notes, and AI prompts.
+
+## Next Steps
+
+Check out the sample tickets we've created for you to see how VibeKit can be used in your workflow.
+`;
+  
+  fs.writeFileSync(readmePath, readmeContent, "utf-8");
+  console.log("✅ Created README.md with getting started instructions");
+  
+  // Create sample tickets
+  createSampleTicket(
+    "Simple Task Example", 
+    "This is a simple task ticket example showing the basic structure.", 
+    "low"
+  );
+  
+  createSampleTicket(
+    "Bug Report Example", 
+    "This ticket demonstrates how to report and track bugs using VibeKit.", 
+    "high",
+    "in_progress"
+  );
+  
+  createSampleTicket(
+    "Feature Request with AI Prompt", 
+    "This example shows how to use the AI prompt section to get assistance with implementing a feature.", 
+    "medium"
+  );
+  
+  console.log("✅ Created sample tickets to demonstrate VibeKit features");
+  console.log("\n✨ You're all set! Try running 'vibe list' to see your tickets.\n");
+}
+
+export default getStartedCommand;