Refactor: Modularize Task Master CLI into Modules Directory

Simplified the Task Master CLI by organizing code into modules within the directory. **Why:** - **Better Organization:** Code is now grouped by function (AI, commands, dependencies, tasks, UI, utilities). - **Easier to Maintain:** Smaller modules are simpler to update and fix. - **Scalable:** New features can be added more easily in a structured way. **What Changed:** - Moved code from single _____ _ __ __ _ |_ _|_ _ ___| | __ | \/ | __ _ ___| |_ ___ _ __ | |/ _` / __| |/ / | |\/| |/ _` / __| __/ _ \ '__| | | (_| \__ \ < | | | | (_| \__ \ || __/ | |_|\__,_|___/_|\_\ |_| |_|\__,_|___/\__\___|_| by https://x.com/eyaltoledano ╭────────────────────────────────────────────╮ │ │ │ Version: 0.9.16 Project: Task Master │ │ │ ╰────────────────────────────────────────────╯ ╭─────────────────────╮ │ │ │ Task Master CLI │ │ │ ╰─────────────────────╯ ╭───────────────────╮ │ Task Generation │ ╰───────────────────╯ parse-prd --input=<file.txt> [--tasks=10] Generate tasks from a PRD document generate Create individual task files from tasks… ╭───────────────────╮ │ Task Management │ ╰───────────────────╯ list [--status=<status>] [--with-subtas… List all tasks with their status set-status --id=<id> --status=<status> Update task status (done, pending, etc.) update --from=<id> --prompt="<context>" Update tasks based on new requirements add-task --prompt="<text>" [--dependencies=… Add a new task using AI add-dependency --id=<id> --depends-on=<id> Add a dependency to a task remove-dependency --id=<id> --depends-on=<id> Remove a dependency from a task ╭──────────────────────────╮ │ Task Analysis & Detail │ ╰──────────────────────────╯ analyze-complexity [--research] [--threshold=5] Analyze tasks and generate expansion re… complexity-report [--file=<path>] Display the complexity analysis report expand --id=<id> [--num=5] [--research] [… Break down tasks into detailed subtasks expand --all [--force] [--research] Expand all pending tasks with subtasks clear-subtasks --id=<id> Remove subtasks from specified tasks ╭─────────────────────────────╮ │ Task Navigation & Viewing │ ╰─────────────────────────────╯ next Show the next task to work on based on … show <id> Display detailed information about a sp… ╭─────────────────────────╮ │ Dependency Management │ ╰─────────────────────────╯ validate-dependenci… Identify invalid dependencies without f… fix-dependencies Fix invalid dependencies automatically ╭─────────────────────────╮ │ Environment Variables │ ╰─────────────────────────╯ ANTHROPIC_API_KEY Your Anthropic API key Required MODEL Claude model to use Default: claude-3-7-sonn… MAX_TOKENS Maximum tokens for responses Default: 4000 TEMPERATURE Temperature for model responses Default: 0.7 PERPLEXITY_API_KEY Perplexity API key for research Optional PERPLEXITY_MODEL Perplexity model to use Default: sonar-small-onl… DEBUG Enable debug logging Default: false LOG_LEVEL Console output level (debug,info,warn,error) Default: info DEFAULT_SUBTASKS Default number of subtasks to generate Default: 3 DEFAULT_PRIORITY Default task priority Default: medium PROJECT_NAME Project name displayed in UI Default: Task Master file into these new modules: - : AI interactions (Claude, Perplexity) - : CLI command definitions (Commander.js) - : Task dependency handling - : Core task operations (create, list, update, etc.) - : User interface elements (display, formatting) - : Utility functions and configuration - : Exports all modules - Replaced direct use of _____ _ __ __ _ |_ _|_ _ ___| | __ | \/ | __ _ ___| |_ ___ _ __ | |/ _` / __| |/ / | |\/| |/ _` / __| __/ _ \ '__| | | (_| \__ \ < | | | | (_| \__ \ || __/ | |_|\__,_|___/_|\_\ |_| |_|\__,_|___/\__\___|_| by https://x.com/eyaltoledano ╭────────────────────────────────────────────╮ │ │ │ Version: 0.9.16 Project: Task Master │ │ │ ╰────────────────────────────────────────────╯ ╭─────────────────────╮ │ │ │ Task Master CLI │ │ │ ╰─────────────────────╯ ╭───────────────────╮ │ Task Generation │ ╰───────────────────╯ parse-prd --input=<file.txt> [--tasks=10] Generate tasks from a PRD document generate Create individual task files from tasks… ╭───────────────────╮ │ Task Management │ ╰───────────────────╯ list [--status=<status>] [--with-subtas… List all tasks with their status set-status --id=<id> --status=<status> Update task status (done, pending, etc.) update --from=<id> --prompt="<context>" Update tasks based on new requirements add-task --prompt="<text>" [--dependencies=… Add a new task using AI add-dependency --id=<id> --depends-on=<id> Add a dependency to a task remove-dependency --id=<id> --depends-on=<id> Remove a dependency from a task ╭──────────────────────────╮ │ Task Analysis & Detail │ ╰──────────────────────────╯ analyze-complexity [--research] [--threshold=5] Analyze tasks and generate expansion re… complexity-report [--file=<path>] Display the complexity analysis report expand --id=<id> [--num=5] [--research] [… Break down tasks into detailed subtasks expand --all [--force] [--research] Expand all pending tasks with subtasks clear-subtasks --id=<id> Remove subtasks from specified tasks ╭─────────────────────────────╮ │ Task Navigation & Viewing │ ╰─────────────────────────────╯ next Show the next task to work on based on … show <id> Display detailed information about a sp… ╭─────────────────────────╮ │ Dependency Management │ ╰─────────────────────────╯ validate-dependenci… Identify invalid dependencies without f… fix-dependencies Fix invalid dependencies automatically ╭─────────────────────────╮ │ Environment Variables │ ╰─────────────────────────╯ ANTHROPIC_API_KEY Your Anthropic API key Required MODEL Claude model to use Default: claude-3-7-sonn… MAX_TOKENS Maximum tokens for responses Default: 4000 TEMPERATURE Temperature for model responses Default: 0.7 PERPLEXITY_API_KEY Perplexity API key for research Optional PERPLEXITY_MODEL Perplexity model to use Default: sonar-small-onl… DEBUG Enable debug logging Default: false LOG_LEVEL Console output level (debug,info,warn,error) Default: info DEFAULT_SUBTASKS Default number of subtasks to generate Default: 3 DEFAULT_PRIORITY Default task priority Default: medium PROJECT_NAME Project name displayed in UI Default: Task Master with the global command (see ). - Updated documentation () to reflect the new command. **Benefits:** Code is now cleaner, easier to work with, and ready for future growth. Use the command (or ) to run the CLI. See for command details.
2025-03-23 23:19:37 -04:00
parent f003fe8b52
commit 633a5b963e
41 changed files with 7942 additions and 6725 deletions
--- a/scripts/modules/utils.js
+++ b/scripts/modules/utils.js
@@ -0,0 +1,283 @@
+/**
+ * utils.js
+ * Utility functions for the Task Master CLI
+ */
+
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+
+// Configuration and constants
+const CONFIG = {
+  model: process.env.MODEL || 'claude-3-7-sonnet-20250219',
+  maxTokens: parseInt(process.env.MAX_TOKENS || '4000'),
+  temperature: parseFloat(process.env.TEMPERATURE || '0.7'),
+  debug: process.env.DEBUG === "true",
+  logLevel: process.env.LOG_LEVEL || "info",
+  defaultSubtasks: parseInt(process.env.DEFAULT_SUBTASKS || "3"),
+  defaultPriority: process.env.DEFAULT_PRIORITY || "medium",
+  projectName: process.env.PROJECT_NAME || "Task Master",
+  projectVersion: "1.5.0" // Hardcoded version - ALWAYS use this value, ignore environment variable
+};
+
+// Set up logging based on log level
+const LOG_LEVELS = {
+  debug: 0,
+  info: 1,
+  warn: 2,
+  error: 3
+};
+
+/**
+ * Logs a message at the specified level
+ * @param {string} level - The log level (debug, info, warn, error)
+ * @param  {...any} args - Arguments to log
+ */
+function log(level, ...args) {
+  const icons = {
+    debug: chalk.gray('🔍'),
+    info: chalk.blue('ℹ️'),
+    warn: chalk.yellow('⚠️'),
+    error: chalk.red('❌'),
+    success: chalk.green('✅')
+  };
+  
+  if (LOG_LEVELS[level] >= LOG_LEVELS[CONFIG.logLevel]) {
+    const icon = icons[level] || '';
+    console.log(`${icon} ${args.join(' ')}`);
+  }
+}
+
+/**
+ * Reads and parses a JSON file
+ * @param {string} filepath - Path to the JSON file
+ * @returns {Object} Parsed JSON data
+ */
+function readJSON(filepath) {
+  try {
+    const rawData = fs.readFileSync(filepath, 'utf8');
+    return JSON.parse(rawData);
+  } catch (error) {
+    log('error', `Error reading JSON file ${filepath}:`, error.message);
+    if (CONFIG.debug) {
+      console.error(error);
+    }
+    return null;
+  }
+}
+
+/**
+ * Writes data to a JSON file
+ * @param {string} filepath - Path to the JSON file
+ * @param {Object} data - Data to write
+ */
+function writeJSON(filepath, data) {
+  try {
+    fs.writeFileSync(filepath, JSON.stringify(data, null, 2));
+  } catch (error) {
+    log('error', `Error writing JSON file ${filepath}:`, error.message);
+    if (CONFIG.debug) {
+      console.error(error);
+    }
+  }
+}
+
+/**
+ * Sanitizes a prompt string for use in a shell command
+ * @param {string} prompt The prompt to sanitize
+ * @returns {string} Sanitized prompt
+ */
+function sanitizePrompt(prompt) {
+  // Replace double quotes with escaped double quotes
+  return prompt.replace(/"/g, '\\"');
+}
+
+/**
+ * Reads and parses the complexity report if it exists
+ * @param {string} customPath - Optional custom path to the report
+ * @returns {Object|null} The parsed complexity report or null if not found
+ */
+function readComplexityReport(customPath = null) {
+  try {
+    const reportPath = customPath || path.join(process.cwd(), 'scripts', 'task-complexity-report.json');
+    if (!fs.existsSync(reportPath)) {
+      return null;
+    }
+    
+    const reportData = fs.readFileSync(reportPath, 'utf8');
+    return JSON.parse(reportData);
+  } catch (error) {
+    log('warn', `Could not read complexity report: ${error.message}`);
+    return null;
+  }
+}
+
+/**
+ * Finds a task analysis in the complexity report
+ * @param {Object} report - The complexity report
+ * @param {number} taskId - The task ID to find
+ * @returns {Object|null} The task analysis or null if not found
+ */
+function findTaskInComplexityReport(report, taskId) {
+  if (!report || !report.complexityAnalysis || !Array.isArray(report.complexityAnalysis)) {
+    return null;
+  }
+  
+  return report.complexityAnalysis.find(task => task.taskId === taskId);
+}
+
+/**
+ * Checks if a task exists in the tasks array
+ * @param {Array} tasks - The tasks array
+ * @param {string|number} taskId - The task ID to check
+ * @returns {boolean} True if the task exists, false otherwise
+ */
+function taskExists(tasks, taskId) {
+  if (!taskId || !tasks || !Array.isArray(tasks)) {
+    return false;
+  }
+  
+  // Handle both regular task IDs and subtask IDs (e.g., "1.2")
+  if (typeof taskId === 'string' && taskId.includes('.')) {
+    const [parentId, subtaskId] = taskId.split('.').map(id => parseInt(id, 10));
+    const parentTask = tasks.find(t => t.id === parentId);
+    
+    if (!parentTask || !parentTask.subtasks) {
+      return false;
+    }
+    
+    return parentTask.subtasks.some(st => st.id === subtaskId);
+  }
+  
+  const id = parseInt(taskId, 10);
+  return tasks.some(t => t.id === id);
+}
+
+/**
+ * Formats a task ID as a string
+ * @param {string|number} id - The task ID to format
+ * @returns {string} The formatted task ID
+ */
+function formatTaskId(id) {
+  if (typeof id === 'string' && id.includes('.')) {
+    return id; // Already formatted as a string with a dot (e.g., "1.2")
+  }
+  
+  if (typeof id === 'number') {
+    return id.toString();
+  }
+  
+  return id;
+}
+
+/**
+ * Finds a task by ID in the tasks array
+ * @param {Array} tasks - The tasks array
+ * @param {string|number} taskId - The task ID to find
+ * @returns {Object|null} The task object or null if not found
+ */
+function findTaskById(tasks, taskId) {
+  if (!taskId || !tasks || !Array.isArray(tasks)) {
+    return null;
+  }
+  
+  // Check if it's a subtask ID (e.g., "1.2")
+  if (typeof taskId === 'string' && taskId.includes('.')) {
+    const [parentId, subtaskId] = taskId.split('.').map(id => parseInt(id, 10));
+    const parentTask = tasks.find(t => t.id === parentId);
+    
+    if (!parentTask || !parentTask.subtasks) {
+      return null;
+    }
+    
+    const subtask = parentTask.subtasks.find(st => st.id === subtaskId);
+    if (subtask) {
+      // Add reference to parent task for context
+      subtask.parentTask = { 
+        id: parentTask.id, 
+        title: parentTask.title,
+        status: parentTask.status
+      };
+      subtask.isSubtask = true;
+    }
+    
+    return subtask || null;
+  }
+  
+  const id = parseInt(taskId, 10);
+  return tasks.find(t => t.id === id) || null;
+}
+
+/**
+ * Truncates text to a specified length
+ * @param {string} text - The text to truncate
+ * @param {number} maxLength - The maximum length
+ * @returns {string} The truncated text
+ */
+function truncate(text, maxLength) {
+  if (!text || text.length <= maxLength) {
+    return text;
+  }
+  
+  return text.slice(0, maxLength - 3) + '...';
+}
+
+/**
+ * Find cycles in a dependency graph using DFS
+ * @param {string} subtaskId - Current subtask ID
+ * @param {Map} dependencyMap - Map of subtask IDs to their dependencies
+ * @param {Set} visited - Set of visited nodes
+ * @param {Set} recursionStack - Set of nodes in current recursion stack
+ * @returns {Array} - List of dependency edges that need to be removed to break cycles
+ */
+function findCycles(subtaskId, dependencyMap, visited = new Set(), recursionStack = new Set(), path = []) {
+  // Mark the current node as visited and part of recursion stack
+  visited.add(subtaskId);
+  recursionStack.add(subtaskId);
+  path.push(subtaskId);
+  
+  const cyclesToBreak = [];
+  
+  // Get all dependencies of the current subtask
+  const dependencies = dependencyMap.get(subtaskId) || [];
+  
+  // For each dependency
+  for (const depId of dependencies) {
+    // If not visited, recursively check for cycles
+    if (!visited.has(depId)) {
+      const cycles = findCycles(depId, dependencyMap, visited, recursionStack, [...path]);
+      cyclesToBreak.push(...cycles);
+    } 
+    // If the dependency is in the recursion stack, we found a cycle
+    else if (recursionStack.has(depId)) {
+      // Find the position of the dependency in the path
+      const cycleStartIndex = path.indexOf(depId);
+      // The last edge in the cycle is what we want to remove
+      const cycleEdges = path.slice(cycleStartIndex);
+      // We'll remove the last edge in the cycle (the one that points back)
+      cyclesToBreak.push(depId);
+    }
+  }
+  
+  // Remove the node from recursion stack before returning
+  recursionStack.delete(subtaskId);
+  
+  return cyclesToBreak;
+}
+
+// Export all utility functions and configuration
+export {
+  CONFIG,
+  LOG_LEVELS,
+  log,
+  readJSON,
+  writeJSON,
+  sanitizePrompt,
+  readComplexityReport,
+  findTaskInComplexityReport,
+  taskExists,
+  formatTaskId,
+  findTaskById,
+  truncate,
+  findCycles,
+};