@mrpatronz/nexusflow 0.2.17 → 0.2.18

package/src/utils/workflow-advisor.ts

@@ -0,0 +1,118 @@
+/**
+ * @module utils/workflow-advisor
+ * Dynamically suggests task difficulty and teamwork strategy guidelines.
+ */
+
+import { callLocalLlm } from './local-ai.js';
+import type { LocalLlmConfig, RepoInfo } from '../types.js';
+
+export interface WorkflowSuggestion {
+  difficulty: 'simple' | 'moderate' | 'complex';
+  rationale: string;
+  suggestedWorkflowId: 'solo-developer' | 'research-verify' | 'plan-implement-review';
+  customInstructions: string;
+}
+
+/**
+ * Analyzes feature description and repositories to recommend strategy guidelines.
+ */
+export async function suggestWorkflow(
+  description: string,
+  repos: RepoInfo[],
+  localLlmConfig?: LocalLlmConfig
+): Promise<WorkflowSuggestion> {
+  const repoNames = repos.map((r) => r.name);
+  
+  const runHeuristic = (): WorkflowSuggestion => {
+    const descLower = (description || '').toLowerCase();
+    const isComplexWord = descLower.includes('refactor') ||
+                          descLower.includes('migrate') ||
+                          descLower.includes('architecture') ||
+                          descLower.includes('design') ||
+                          descLower.includes('rewrite') ||
+                          descLower.includes('optimize') ||
+                          descLower.includes('performance') ||
+                          descLower.includes('security') ||
+                          descLower.includes('database') ||
+                          descLower.includes('schema') ||
+                          descLower.includes('break') ||
+                          descLower.includes('major');
+    
+    const isSimpleWord = descLower.includes('fix') ||
+                         descLower.includes('bug') ||
+                         descLower.includes('typo') ||
+                         descLower.includes('tweak') ||
+                         descLower.includes('color') ||
+                         descLower.includes('alignment') ||
+                         descLower.includes('comment') ||
+                         descLower.includes('readme') ||
+                         descLower.includes('test') ||
+                         descLower.includes('doc');
+
+    if (repos.length > 2 || isComplexWord) {
+      return {
+        difficulty: 'complex',
+        suggestedWorkflowId: 'plan-implement-review',
+        rationale: `This task spans multiple repositories or involves architectural components (${repoNames.join(', ')}). A structured Plan-Implement-Review strategy is recommended to coordinate changes carefully.`,
+        customInstructions: `# Team Strategy: Plan, Implement, Review\n\nThis workspace involves complex changes across multiple projects: ${repoNames.join(', ')}.\n\n## Roles & Coordination\n1. **Lead Planner**: Analyzes requirements and details a step-by-step design plan in \`implementation_plan.md\`.\n2. **Code Implementer**: Executes modifications project-by-project following the approved design.\n3. **Code Reviewer**: Runs testing/verification and approves before completion.\n\nPlease follow these roles strictly.`
+      };
+    } else if (repos.length === 1 && isSimpleWord && !isComplexWord) {
+      return {
+        difficulty: 'simple',
+        suggestedWorkflowId: 'solo-developer',
+        rationale: `This is a localized fix/tweak within a single repository (${repoNames.join(', ')}). A Solo Developer pattern minimizes overhead and speeds up the modification.`,
+        customInstructions: `# Team Strategy: Solo Developer\n\nThis task is a localized fix in ${repoNames[0] || 'the project'}.\n\n## Guidelines\n- Direct implementation by the main agent.\n- Run tests and compile code immediately.\n- Avoid spawning subagents to reduce overhead.`
+      };
+    } else {
+      return {
+        difficulty: 'moderate',
+        suggestedWorkflowId: 'research-verify',
+        rationale: `This is a feature of moderate scope affecting ${repoNames.join(', ')}. We recommend first researching the codebase and dependencies, followed by targeted implementation.`,
+        customInstructions: `# Team Strategy: Research & Verify\n\nThis task involves moderate changes in ${repoNames.join(', ')}.\n\n## Guidelines\n1. **Research Phase**: Inspect existing components and API interfaces first.\n2. **Implementation Phase**: Write modular code changes.\n3. **Verification Phase**: Confirm build and runs correctly.`
+      };
+    }
+  };
+
+  if (localLlmConfig?.enabled) {
+    try {
+      const prompt = `You are a software architect analyzing a new feature request.
+Feature Description: "${description}"
+Target Repositories: ${JSON.stringify(repos.map(r => ({ name: r.name, path: r.path })))}
+
+Determine:
+1. Difficulty: "simple", "moderate", or "complex".
+2. Suggested Workflow Strategy ID: "solo-developer" (for small tweaks), "research-verify" (for moderate features requiring codebase exploration), or "plan-implement-review" (for complex features spanning multiple repositories/refactorings).
+3. A short explanation/rationale.
+4. Custom teamwork cooperation guidelines for AGENTS.md, detailing how the agents should coordinate across the selected repositories.
+
+Respond ONLY with a JSON object of this structure:
+{
+  "difficulty": "simple" | "moderate" | "complex",
+  "rationale": "Explanation here",
+  "suggestedWorkflowId": "solo-developer" | "research-verify" | "plan-implement-review",
+  "customInstructions": "Markdown format teamwork guidelines for AGENTS.md"
+}`;
+
+      const responseText = await callLocalLlm(localLlmConfig, [
+        { role: 'system', content: 'You are a helpful software architect assistant. Always output valid JSON.' },
+        { role: 'user', content: prompt }
+      ]);
+
+      const cleanJson = responseText.replace(/```json/i, '').replace(/```/g, '').trim();
+      const result = JSON.parse(cleanJson);
+      
+      if (result.difficulty && result.suggestedWorkflowId && result.customInstructions) {
+        return {
+          difficulty: result.difficulty,
+          rationale: result.rationale || '',
+          suggestedWorkflowId: result.suggestedWorkflowId,
+          customInstructions: result.customInstructions
+        };
+      }
+    } catch (err) {
+      console.warn('Failed to get LLM workflow suggestion, falling back to heuristics:', err);
+    }
+  }
+
+  return runHeuristic();
+}

package/src/utils/workflows.test.ts

@@ -1,114 +1,114 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import * as fs from 'node:fs/promises';
-import * as os from 'node:os';
-import * as path from 'node:path';
-import { getWorkflowTemplates, saveWorkflowTemplate, deleteWorkflowTemplate } from './workflows.js';
-
-vi.mock('node:fs/promises');
-vi.mock('node:os', () => ({
-  homedir: () => '/mock/home'
-}));
-
-describe('Workflows Utility Unit Tests', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  describe('saveWorkflowTemplate', () => {
-    it('should save a template and extract its name from H1 header', async () => {
-      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
-      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
-
-      const result = await saveWorkflowTemplate('My Temp Name', '# Final Strategy Name\n\nStrategy Content');
-
-      expect(fs.mkdir).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows'), { recursive: true });
-      expect(fs.writeFile).toHaveBeenCalledWith(
-        path.join('/mock/home', '.nexusflow', 'workflows', 'final-strategy-name.md'),
-        '# Final Strategy Name\n\nStrategy Content',
-        'utf-8'
-      );
-      expect(result).toEqual({
-        id: 'final-strategy-name',
-        name: 'Final Strategy Name',
-        description: 'Strategy Content',
-        content: '# Final Strategy Name\n\nStrategy Content',
-        custom: true
-      });
-    });
-
-    it('should add H1 header if not present', async () => {
-      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
-      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
-
-      const result = await saveWorkflowTemplate('My Temp Name', 'Strategy Content');
-
-      expect(fs.writeFile).toHaveBeenCalledWith(
-        path.join('/mock/home', '.nexusflow', 'workflows', 'my-temp-name.md'),
-        '# My Temp Name\n\nStrategy Content',
-        'utf-8'
-      );
-      expect(result.id).toBe('my-temp-name');
-    });
-
-    it('should clean up originalId file if template is renamed', async () => {
-      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
-      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
-      vi.spyOn(fs, 'unlink').mockResolvedValue(undefined);
-
-      const result = await saveWorkflowTemplate('New Name', '# New Name\n\nContent', 'old-id');
-
-      expect(fs.unlink).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows', 'old-id.md'));
-      expect(result.id).toBe('new-name');
-    });
-  });
-
-  describe('deleteWorkflowTemplate', () => {
-    it('should delete template file', async () => {
-      vi.spyOn(fs, 'unlink').mockResolvedValue(undefined);
-
-      await deleteWorkflowTemplate('some-id');
-
-      expect(fs.unlink).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows', 'some-id.md'));
-    });
-
-    it('should ignore ENOENT error', async () => {
-      const error = new Error('File not found') as any;
-      error.code = 'ENOENT';
-      vi.spyOn(fs, 'unlink').mockRejectedValue(error);
-
-      await expect(deleteWorkflowTemplate('some-id')).resolves.toBeUndefined();
-    });
-  });
-
-  describe('getWorkflowTemplates', () => {
-    it('should load and merge built-in and user templates', async () => {
-      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
-      // Mock readdir to return files
-      vi.spyOn(fs, 'readdir').mockImplementation(async (dirPath) => {
-        if (dirPath.toString().includes('.nexusflow')) {
-          return ['custom-one.md'] as any;
-        }
-        return ['solo-developer.md'] as any;
-      });
-
-      // Mock readFile
-      vi.spyOn(fs, 'readFile').mockImplementation(async (filePath) => {
-        if (filePath.toString().includes('custom-one.md')) {
-          return '# Custom One\n\nDescription content.' as any;
-        }
-        return '# Solo Developer\n\nOverride content.' as any;
-      });
-
-      const templates = await getWorkflowTemplates();
-
-      expect(templates.length).toBe(2);
-      expect(templates.find(t => t.id === 'custom-one')).toEqual({
-        id: 'custom-one',
-        name: 'Custom One',
-        description: 'Description content.',
-        content: '# Custom One\n\nDescription content.',
-        custom: true
-      });
-    });
-  });
-});
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import * as fs from 'node:fs/promises';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { getWorkflowTemplates, saveWorkflowTemplate, deleteWorkflowTemplate } from './workflows.js';
+
+vi.mock('node:fs/promises');
+vi.mock('node:os', () => ({
+  homedir: () => '/mock/home'
+}));
+
+describe('Workflows Utility Unit Tests', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe('saveWorkflowTemplate', () => {
+    it('should save a template and extract its name from H1 header', async () => {
+      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
+      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
+
+      const result = await saveWorkflowTemplate('My Temp Name', '# Final Strategy Name\n\nStrategy Content');
+
+      expect(fs.mkdir).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows'), { recursive: true });
+      expect(fs.writeFile).toHaveBeenCalledWith(
+        path.join('/mock/home', '.nexusflow', 'workflows', 'final-strategy-name.md'),
+        '# Final Strategy Name\n\nStrategy Content',
+        'utf-8'
+      );
+      expect(result).toEqual({
+        id: 'final-strategy-name',
+        name: 'Final Strategy Name',
+        description: 'Strategy Content',
+        content: '# Final Strategy Name\n\nStrategy Content',
+        custom: true
+      });
+    });
+
+    it('should add H1 header if not present', async () => {
+      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
+      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
+
+      const result = await saveWorkflowTemplate('My Temp Name', 'Strategy Content');
+
+      expect(fs.writeFile).toHaveBeenCalledWith(
+        path.join('/mock/home', '.nexusflow', 'workflows', 'my-temp-name.md'),
+        '# My Temp Name\n\nStrategy Content',
+        'utf-8'
+      );
+      expect(result.id).toBe('my-temp-name');
+    });
+
+    it('should clean up originalId file if template is renamed', async () => {
+      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
+      vi.spyOn(fs, 'writeFile').mockResolvedValue(undefined);
+      vi.spyOn(fs, 'unlink').mockResolvedValue(undefined);
+
+      const result = await saveWorkflowTemplate('New Name', '# New Name\n\nContent', 'old-id');
+
+      expect(fs.unlink).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows', 'old-id.md'));
+      expect(result.id).toBe('new-name');
+    });
+  });
+
+  describe('deleteWorkflowTemplate', () => {
+    it('should delete template file', async () => {
+      vi.spyOn(fs, 'unlink').mockResolvedValue(undefined);
+
+      await deleteWorkflowTemplate('some-id');
+
+      expect(fs.unlink).toHaveBeenCalledWith(path.join('/mock/home', '.nexusflow', 'workflows', 'some-id.md'));
+    });
+
+    it('should ignore ENOENT error', async () => {
+      const error = new Error('File not found') as any;
+      error.code = 'ENOENT';
+      vi.spyOn(fs, 'unlink').mockRejectedValue(error);
+
+      await expect(deleteWorkflowTemplate('some-id')).resolves.toBeUndefined();
+    });
+  });
+
+  describe('getWorkflowTemplates', () => {
+    it('should load and merge built-in and user templates', async () => {
+      vi.spyOn(fs, 'mkdir').mockResolvedValue(undefined);
+      // Mock readdir to return files
+      vi.spyOn(fs, 'readdir').mockImplementation(async (dirPath) => {
+        if (dirPath.toString().includes('.nexusflow')) {
+          return ['custom-one.md'] as any;
+        }
+        return ['solo-developer.md'] as any;
+      });
+
+      // Mock readFile
+      vi.spyOn(fs, 'readFile').mockImplementation(async (filePath) => {
+        if (filePath.toString().includes('custom-one.md')) {
+          return '# Custom One\n\nDescription content.' as any;
+        }
+        return '# Solo Developer\n\nOverride content.' as any;
+      });
+
+      const templates = await getWorkflowTemplates();
+
+      expect(templates.length).toBe(2);
+      expect(templates.find(t => t.id === 'custom-one')).toEqual({
+        id: 'custom-one',
+        name: 'Custom One',
+        description: 'Description content.',
+        content: '# Custom One\n\nDescription content.',
+        custom: true
+      });
+    });
+  });
+});