projxo 1.0.1 → 1.1.0

package/index.js

@@ -1,20 +1,57 @@
 #!/usr/bin/env node
 
 /**
- * ProjXO - Quick Project Setup CLI
+ * ProjXO - Quick Project Setup & Management CLI
  * 
  * Entry point for the CLI application
- * This file should remain minimal, with all logic in src/cli.js
+ * Handles command routing and argument parsing
  * 
- * @author Sasanga Chathumal
- * @version 1.0.1
+ * @version 1.1.0
  */
 
-// Import the main CLI function
-const { run } = require('./src/cli');
+const { program } = require('commander');
+const { run: createProject } = require('./src/cli');
+const { listCommand } = require('./src/commands/list');
+const logger = require('./src/utils/logger');
 
-// Run the CLI
-run().catch((error) => {
-  console.error('Fatal error:', error.message);
-  process.exit(1);
-});
+// Package info
+const packageJson = require('./package.json');
+
+// Configure CLI
+program
+  .name('pxo')
+  .description('Quick project setup and management for modern web frameworks')
+  .version(packageJson.version);
+
+// Default command (no arguments) - Create new project
+program
+  .action(() => {
+    createProject();
+  });
+
+// List all projects
+program
+  .command('list')
+  .alias('ls')
+  .description('List all tracked projects')
+  .action(() => {
+    listCommand();
+  });
+
+// Handle errors
+program.exitOverride();
+
+try {
+  program.parse(process.argv);
+} catch (error) {
+  if (error.code === 'commander.help') {
+    // Help was displayed, exit normally
+    process.exit(0);
+  } else if (error.code === 'commander.version') {
+    // Version was displayed, exit normally
+    process.exit(0);
+  } else {
+    // logger.error(`Error: ${error.message}`);
+    process.exit(1);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "projxo",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Cross-platform CLI tool to quickly create React, Next.js, Angular, and React Native projects with automatic IDE integration",
   "main": "index.js",
   "bin": {
@@ -44,6 +44,7 @@
   "homepage": "https://github.com/sasangachathumal/ProjXO#readme",
   "files": [
     "index.js",
+    "src/**/*",
     "README.md",
     "LICENSE"
   ],
@@ -54,6 +55,7 @@
     "win32"
   ],
   "dependencies": {
-    "inquirer": "^8.2.6"
+    "inquirer": "^8.2.6",
+    "commander": "^11.1.0"
   }
 }

package/src/cli.js

@@ -0,0 +1,184 @@
+/**
+ * Main CLI orchestration
+ * Coordinates the project creation workflow
+ */
+
+const inquirer = require('inquirer');
+const logger = require('./utils/logger');
+const { pathExists } = require('./utils/fileSystem');
+const { getProjectType } = require('./config/projectTypes');
+const {
+  getProjectTypePrompt,
+  getProjectNamePrompt,
+  getDirectoryPrompt,
+  getIDEPrompt,
+  getOverwritePrompt
+} = require('./prompts/questions');
+const { 
+  createProject, 
+  displaySuccessMessage,
+  validateProjectParams 
+} = require('./handlers/projectCreator');
+const { openInIDE } = require('./handlers/ideOpener');
+
+/**
+ * Main CLI function
+ * Orchestrates the entire project creation flow
+ */
+async function run() {
+  try {
+    // Display welcome banner
+    displayBanner();
+
+    // Get user inputs through prompts
+    const answers = await getUserInputs();
+
+    // Validate inputs
+    const validation = validateProjectParams(answers);
+    if (!validation.valid) {
+      logger.error(validation.error);
+      process.exit(1);
+    }
+
+    // Check if project exists and handle overwrite
+    const shouldProceed = await handleExistingProject(answers);
+    if (!shouldProceed) {
+      logger.warning('Operation cancelled');
+      process.exit(0);
+    }
+
+    // Create the project
+    const projectPath = await createProject({
+      projectType: answers.projectType,
+      projectName: answers.projectName,
+      directory: answers.directory
+    });
+
+    // Display success message
+    displaySuccessMessage(projectPath, answers.projectType);
+
+    // Open in IDE if selected
+    if (answers.selectedIDE !== 'skip') {
+      await openInIDE(projectPath, answers.selectedIDE);
+      
+      // Update project with IDE preference
+      const { getProjectByPath, updateProject } = require('./storage/projects');
+      const project = getProjectByPath(projectPath);
+      if (project) {
+        updateProject(project.id, { ide: answers.selectedIDE });
+      }
+    } else {
+      // Show quick access info
+      logger.log('\nQuick access:', 'dim');
+      logger.log(`  pxo list`, 'cyan');
+    }
+
+  } catch (error) {
+    handleError(error);
+  }
+}
+
+/**
+ * Display welcome banner
+ */
+function displayBanner() {
+  logger.newLine();
+  logger.log('═══════════════════════════════════════════════════', 'bright');
+  logger.log('   ProjXO - Quick Project Setup', 'brightCyan');
+  logger.log('═══════════════════════════════════════════════════', 'bright');
+  logger.newLine();
+}
+
+/**
+ * Get user inputs through interactive prompts
+ * @returns {Promise<Object>} User answers
+ */
+async function getUserInputs() {
+  const defaultDirectory = process.cwd();
+
+  // Get project type
+  const { projectType } = await inquirer.prompt([getProjectTypePrompt()]);
+  
+  const config = getProjectType(projectType);
+  logger.success(`Selected: ${config.name}`);
+  logger.newLine();
+
+  // Get project name
+  const { projectName } = await inquirer.prompt([getProjectNamePrompt()]);
+
+  // Get directory
+  const { directory } = await inquirer.prompt([getDirectoryPrompt(defaultDirectory)]);
+
+  // Get IDE choice
+  const { selectedIDE } = await inquirer.prompt([getIDEPrompt()]);
+
+  return {
+    projectType,
+    projectName,
+    directory,
+    selectedIDE
+  };
+}
+
+/**
+ * Handle existing project scenario
+ * @param {Object} answers - User answers containing projectName and directory
+ * @returns {Promise<boolean>} True if should proceed, false if cancelled
+ */
+async function handleExistingProject({ projectName, directory }) {
+  const { expandHomePath, getProjectPath } = require('./utils/fileSystem');
+  const expandedDir = expandHomePath(directory);
+  const fullPath = getProjectPath(expandedDir, projectName);
+
+  if (pathExists(fullPath)) {
+    logger.warning(`Project "${projectName}" already exists at: ${fullPath}`);
+    
+    const { overwrite } = await inquirer.prompt([getOverwritePrompt(projectName)]);
+    
+    if (!overwrite) {
+      return false;
+    }
+    
+    logger.info('Proceeding with overwrite...');
+  }
+
+  return true;
+}
+
+/**
+ * Handle errors gracefully
+ * @param {Error} error - Error object
+ */
+function handleError(error) {
+  logger.newLine();
+  
+  if (error.isTtyError) {
+    logger.error('Prompt could not be rendered in this environment');
+    logger.info('Please ensure you are running in an interactive terminal');
+  } else if (error.message === 'PROJECT_EXISTS') {
+    // This shouldn't happen as we handle it, but just in case
+    logger.error('Project already exists');
+  } else {
+    logger.error(`An error occurred: ${error.message}`);
+    
+    // Show stack trace in debug mode
+    if (process.env.DEBUG) {
+      console.error(error);
+    }
+  }
+  
+  logger.newLine();
+  process.exit(1);
+}
+
+/**
+ * Handle graceful shutdown on SIGINT (Ctrl+C)
+ */
+process.on('SIGINT', () => {
+  logger.newLine();
+  logger.warning('Operation cancelled by user');
+  logger.newLine();
+  process.exit(0);
+});
+
+module.exports = { run };

package/src/commands/list.js

@@ -0,0 +1,251 @@
+/**
+ * List command - Show all tracked projects
+ * Usage: pxo list
+ */
+
+const inquirer = require('inquirer');
+const path = require('path');
+const { getAllProjects, touchProject, deleteProject } = require('../storage/projects');
+const { openInIDE } = require('../handlers/ideOpener');
+const { getIDE } = require('../config/ides');
+const logger = require('../utils/logger');
+
+/**
+ * Format relative time
+ * @param {string} isoDate - ISO date string
+ * @returns {string} Human-readable relative time
+ */
+function formatRelativeTime(isoDate) {
+  const date = new Date(isoDate);
+  const now = new Date();
+  const diffMs = now - date;
+  const diffMins = Math.floor(diffMs / 60000);
+  const diffHours = Math.floor(diffMs / 3600000);
+  const diffDays = Math.floor(diffMs / 86400000);
+  
+  if (diffMins < 1) return 'just now';
+  if (diffMins < 60) return `${diffMins} min${diffMins > 1 ? 's' : ''} ago`;
+  if (diffHours < 24) return `${diffHours} hour${diffHours > 1 ? 's' : ''} ago`;
+  if (diffDays < 7) return `${diffDays} day${diffDays > 1 ? 's' : ''} ago`;
+  if (diffDays < 30) return `${Math.floor(diffDays / 7)} week${Math.floor(diffDays / 7) > 1 ? 's' : ''} ago`;
+  return `${Math.floor(diffDays / 30)} month${Math.floor(diffDays / 30) > 1 ? 's' : ''} ago`;
+}
+
+/**
+ * Get project type display name
+ * @param {string} type - Project type key
+ * @returns {string} Formatted display name
+ */
+function getTypeDisplay(type) {
+  const typeMap = {
+    'react-vite': 'React+Vite',
+    'react-vite-ts': 'React+Vite(TS)',
+    'nextjs': 'Next.js',
+    'angular': 'Angular',
+    'react-native': 'React Native'
+  };
+  return typeMap[type] || type;
+}
+
+/**
+ * Execute list command
+ */
+async function listCommand() {
+  try {
+    const projects = getAllProjects();
+    
+    if (projects.length === 0) {
+      logger.info('No projects found');
+      logger.log('\nCreate your first project with:', 'dim');
+      logger.log('  pxo', 'cyan');
+      return;
+    }
+    
+    logger.newLine();
+    logger.log(`📦 Your Projects (${projects.length})`, 'bright');
+    logger.newLine();
+    
+    // Create choices for inquirer
+    const choices = projects.map(project => {
+      const typeDisplay = getTypeDisplay(project.type);
+      const timeAgo = formatRelativeTime(project.lastAccessed);
+      
+      return {
+        name: `${project.name}  │  ${typeDisplay}  │  ${timeAgo}`,
+        value: project.id,
+        short: project.name
+      };
+    });
+    
+    // Add separator and action options
+    choices.push(
+      new inquirer.Separator(),
+      { name: '← Back', value: 'back' }
+    );
+    
+    const { selectedId } = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'selectedId',
+        message: 'Select a project:',
+        choices,
+        pageSize: 15
+      }
+    ]);
+    
+    if (selectedId === 'back') {
+      return;
+    }
+    
+    // Show actions for selected project
+    await showProjectActions(selectedId);
+    
+  } catch (error) {
+    if (error.isTtyError) {
+      logger.error('This command requires an interactive terminal');
+    } else {
+      logger.error(`Failed to list projects: ${error.message}`);
+    }
+  }
+}
+
+/**
+ * Show actions for a selected project
+ * @param {string} projectId - Project ID
+ */
+async function showProjectActions(projectId) {
+  const { getProjectById } = require('../storage/projects');
+  const project = getProjectById(projectId);
+  
+  if (!project) {
+    logger.error('Project not found');
+    return;
+  }
+  
+  const { action } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'action',
+      message: `Actions for "${project.name}":`,
+      choices: [
+        { name: '📂 Open in IDE', value: 'open' },
+        { name: '📋 Copy path', value: 'copy' },
+        { name: '🗑️  Remove from tracking', value: 'delete' },
+        { name: 'ℹ️  Show details', value: 'details' },
+        new inquirer.Separator(),
+        { name: '← Back to list', value: 'back' }
+      ]
+    }
+  ]);
+  
+  switch (action) {
+    case 'open':
+      await handleOpenProject(project);
+      break;
+      
+    case 'copy':
+      handleCopyPath(project);
+      break;
+      
+    case 'delete':
+      await handleDeleteProject(project);
+      await listCommand(); // Refresh list
+      break;
+      
+    case 'details':
+      showProjectDetails(project);
+      await showProjectActions(projectId); // Show actions again
+      break;
+      
+    case 'back':
+      await listCommand(); // Go back to list
+      break;
+  }
+}
+
+/**
+ * Handle opening project in IDE
+ * @param {Object} project - Project object
+ */
+async function handleOpenProject(project) {
+  // Update last accessed time
+  touchProject(project.id);
+  
+  // Use project's preferred IDE or prompt
+  let ideKey = project.ide;
+  
+  if (!ideKey || ideKey === 'skip') {
+    const { getIDEChoices } = require('../config/ides');
+    const { selectedIDE } = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'selectedIDE',
+        message: 'Select IDE:',
+        choices: getIDEChoices()
+      }
+    ]);
+    ideKey = selectedIDE;
+  }
+  
+  if (ideKey !== 'skip') {
+    const success = await openInIDE(project.path, ideKey);
+    if (success) {
+      logger.success(`Opened ${project.name}`);
+    }
+  }
+}
+
+/**
+ * Handle copying project path
+ * @param {Object} project - Project object
+ */
+function handleCopyPath(project) {
+  // For now, just display the path
+  // In future, could use clipboard library
+  logger.info('Project path:');
+  logger.log(`  ${project.path}`, 'cyan');
+  logger.log('\n(Copy from above)', 'dim');
+}
+
+/**
+ * Handle deleting project from tracking
+ * @param {Object} project - Project object
+ */
+async function handleDeleteProject(project) {
+  const { confirm } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'confirm',
+      message: `Remove "${project.name}" from tracking? (Files won't be deleted)`,
+      default: false
+    }
+  ]);
+  
+  if (confirm) {
+    deleteProject(project.id);
+    logger.success(`Removed ${project.name} from tracking`);
+  }
+}
+
+/**
+ * Show detailed project information
+ * @param {Object} project - Project object
+ */
+function showProjectDetails(project) {
+  logger.newLine();
+  logger.log('━'.repeat(50), 'dim');
+  logger.log(`  ${project.name}`, 'bright');
+  logger.log('━'.repeat(50), 'dim');
+  logger.log(`  Type:         ${getTypeDisplay(project.type)}`, 'cyan');
+  logger.log(`  Path:         ${project.path}`, 'dim');
+  logger.log(`  Created:      ${new Date(project.createdAt).toLocaleString()}`, 'dim');
+  logger.log(`  Last accessed: ${formatRelativeTime(project.lastAccessed)}`, 'dim');
+  if (project.ide) {
+    const ide = getIDE(project.ide);
+    logger.log(`  Default IDE:  ${ide?.name || project.ide}`, 'dim');
+  }
+  logger.log('━'.repeat(50), 'dim');
+  logger.newLine();
+}
+
+module.exports = { listCommand };

package/src/config/ides.js

@@ -0,0 +1,129 @@
+/**
+ * IDE/Editor configurations
+ * Defines supported IDEs and their command-line commands
+ * 
+ * To add a new IDE:
+ * 1. Add a new key to IDES object
+ * 2. Specify name and command
+ * 3. Optionally add installation instructions in getIDEInstallInstructions
+ */
+
+/**
+ * IDE configuration object
+ * @typedef {Object} IDEConfig
+ * @property {string} name - Display name for the IDE
+ * @property {string|null} command - Command-line command to open IDE (null for 'skip')
+ * @property {string} [description] - Optional description
+ */
+
+const IDES = {
+  'vscode': {
+    name: 'VS Code',
+    command: 'code',
+    description: 'Visual Studio Code'
+  },
+  
+  'cursor': {
+    name: 'Cursor',
+    command: 'cursor',
+    description: 'Cursor AI Editor'
+  },
+  
+  'webstorm': {
+    name: 'WebStorm',
+    command: 'webstorm',
+    description: 'JetBrains WebStorm IDE'
+  },
+  
+  'idea': {
+    name: 'IntelliJ IDEA',
+    command: 'idea',
+    description: 'JetBrains IntelliJ IDEA'
+  },
+  
+  'sublime': {
+    name: 'Sublime Text',
+    command: 'subl',
+    description: 'Sublime Text Editor'
+  },
+  
+  'atom': {
+    name: 'Atom',
+    command: 'atom',
+    description: 'GitHub Atom Editor'
+  },
+  
+  'skip': {
+    name: 'Skip (open manually)',
+    command: null,
+    description: 'Do not open in any IDE'
+  }
+};
+
+/**
+ * Get IDE configuration
+ * @param {string} ideKey - IDE key
+ * @returns {IDEConfig|null} Configuration object or null if not found
+ */
+function getIDE(ideKey) {
+  return IDES[ideKey] || null;
+}
+
+/**
+ * Get all IDEs as an array
+ * @returns {Array<{key: string, config: IDEConfig}>}
+ */
+function getAllIDEs() {
+  return Object.entries(IDES).map(([key, config]) => ({
+    key,
+    config
+  }));
+}
+
+/**
+ * Get formatted choices for inquirer prompts
+ * @returns {Array<{name: string, value: string}>}
+ */
+function getIDEChoices() {
+  return Object.entries(IDES).map(([key, config]) => ({
+    name: config.name,
+    value: key,
+    short: config.name
+  }));
+}
+
+/**
+ * Check if an IDE key is valid
+ * @param {string} ideKey - IDE key to check
+ * @returns {boolean}
+ */
+function isValidIDE(ideKey) {
+  return ideKey in IDES;
+}
+
+/**
+ * Get installation instructions for an IDE command
+ * @param {string} ideKey - IDE key
+ * @returns {string} Installation instructions
+ */
+function getIDEInstallInstructions(ideKey) {
+  const instructions = {
+    'vscode': 'Install "Shell Command: Install \'code\' command in PATH" from Command Palette (Cmd/Ctrl+Shift+P)',
+    'cursor': 'Cursor command is usually available after installation',
+    'webstorm': 'Enable in WebStorm: Tools → Create Command-line Launcher',
+    'idea': 'Enable in IntelliJ IDEA: Tools → Create Command-line Launcher',
+    'sublime': 'Create symlink: ln -s "/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl" /usr/local/bin/subl',
+    'atom': 'Install shell commands from Atom: Atom → Install Shell Commands'
+  };
+  
+  return instructions[ideKey] || 'Please refer to your IDE\'s documentation for command-line setup';
+}
+
+module.exports = {
+  IDES,
+  getIDE,
+  getAllIDEs,
+  getIDEChoices,
+  isValidIDE,
+  getIDEInstallInstructions
+};