agile-context-engineering 0.3.0 → 0.5.1

package/{commands/ace/research-technical-solution.md → skills/research-technical-solution/SKILL.md}

@@ -1,147 +1,131 @@
----
-name: ace:research-technical-solution
-description: COMPREHENSIVE Technical Solution Design for a Story — Architecture, Patterns, Algorithms, Sequence Diagrams, and Implementation Plan
-argument-hint: "story=<file-path|github-url>"
-allowed-tools:
-  - Read
-  - Bash
-  - Write
-  - Edit
-  - AskUserQuestion
-  - Glob
-  - Grep
-  - Agent
----
-
-```xml
-<command>
-
-    <execution-time>
-        <runs-after>
-            <trigger>After /ace:plan-story — once story requirements (pass 1-2) are complete</trigger>
-            <trigger>After /ace:research-integration-solution — integration analysis (pass 4) MUST exist</trigger>
-            <trigger>Optionally after /ace:research-external-solution — external analysis (pass 3) if applicable</trigger>
-        </runs-after>
-        <use-when>
-            <condition>Story requirements, wiki references, and integration analysis are available (passes 1-4 complete)</condition>
-            <condition>Need to design a concrete technical solution for the story</condition>
-            <condition>Want a detailed implementation blueprint with class diagrams, sequence diagrams, algorithms, and file structure</condition>
-            <condition>Need a comprehensive technical design to guide AI agents implementing the story</condition>
-        </use-when>
-    </execution-time>
-
-    <input>
-        <flags>
-        </flags>
-
-        <parameters>
-            <required>
-                <param name="story" type="file | github-url">
-                    Story source — can be either:
-                    - **File path**: Path to a markdown file containing the story (from plan-story command)
-                    - **GitHub URL or issue number**: GitHub story reference
-                    Must be a valid, accessible file or GitHub issue.
-                    Contains the user story, acceptance criteria, and Relevant Wiki references
-                    that define what to design a technical solution for.
-
-                    **All context is extracted from the story document:**
-                    - Feature file (from story description/metadata)
-                    - Story requirements (User Story, Description, AC)
-                    - Wiki references (from Relevant Wiki section — pass 2)
-                    - External analysis (auto-detected in story directory — OPTIONAL)
-                    - Integration analysis (auto-detected in story directory — MANDATORY)
-
-                    If not valid, stop and prompt the user.
-                </param>
-            </required>
-
-            <optional>
-                <!-- No optional parameters.
-                     All context is extracted from the story document and story directory:
-                     - Feature file (from story description/metadata)
-                     - Story requirements (User Story, Description, AC)
-                     - Wiki references (from Relevant Wiki section — pass 2)
-                     - External analysis (auto-detected in story directory)
-                     - Integration analysis (auto-detected in story directory)
-                -->
-            </optional>
-        </parameters>
-    </input>
-
-    <execution-context>
-        <research-technical-workflow>@~/.claude/agile-context-engineering/workflows/research-technical-solution.xml</research-technical-workflow>
-        <technical-solution-template>@~/.claude/agile-context-engineering/templates/product/story-technical-solution.xml</technical-solution-template>
-        <ui-formatting>@~/.claude/agile-context-engineering/utils/ui-formatting.md</ui-formatting>
-    </execution-context>
-
-    <output>
-        <objective>
-            Use business requirements, integration analysis, and optionally external/industry-standard
-            analysis to create a CONCRETE TECHNICAL SOLUTION DESIGN for the story, following Clean
-            Architecture principles, SOLID patterns, OOP best practices, considering external analysis
-            for approach, algorithms and formulas (when most efficient and performant), while following
-            the integration analysis so that we don't break our already complex codebase.
-
-            **CRITICAL**: The technical solution MUST include detailed sequence diagrams for EVERY
-            scenario in the Acceptance Criteria, showing the complete flow of data and control
-            through all architectural layers.
-
-            The analysis covers:
-            - Complete component and boundary architecture
-            - Design patterns and technical decisions
-            - Full class diagrams and interfaces (one per file!)
-            - Data models and structures
-            - Algorithms and business logic
-            - Event flow and entry points
-            - MANDATORY sequence diagrams for ALL AC scenarios
-            - Complete file structure tree
-            - DI container configuration
-            - Testing strategy (unit, integration, e2e)
-            - Implementation order and dependencies
-
-            **Output**: The entire technical solution is written INTO the story document
-            (appended as the Technical Solution section) AND updated in the GitHub issue.
-            No separate output file is created.
-        </objective>
-
-        <artifacts>
-            Written directly into the story file and GitHub issue — pass 5 of the story specification pipeline.
-            See story.xml: &lt;section name="technical-solution" pass="5" template="story-technical-solution.xml"&gt;
-        </artifacts>
-    </output>
-
-    <process>
-        For this command use the `ace-technical-application-architect` agent
-        that's specialized in application architecture and is intimate with the codebase.
-
-        Execute the research-technical-solution workflow from
-        `@~/.claude/agile-context-engineering/workflows/research-technical-solution.xml` end-to-end.
-        Preserve all workflow gates (validation, approvals, commits).
-    </process>
-
-    <example-usage>
-        ```
-        # Example with file path story
-        /ace:research-technical-solution \
-          story=.ace/artifacts/product/e1-auth/f3-oauth/s1-buttons/s1-buttons.md
-
-        # Example with GitHub story
-        /ace:research-technical-solution \
-          story=https://github.com/owner/repo/issues/83
-
-        # Example with just issue number (uses current repo)
-        /ace:research-technical-solution \
-          story=83
-        ```
-    </example-usage>
-
-    <next-steps>
-        **After this command:**
-        - The story is now fully refined (pass 5 complete) — ready for implementation
-        - `/ace:execute-story story=...` — Execute the story implementation
-        - `/ace:refine-story story=...` — Re-refine if scope changes
-        - `/ace:help` — Check project initialization status
-    </next-steps>
-
-</command>
-```
+---
+name: research-technical-solution
+description: COMPREHENSIVE Technical Solution Design for a Story -- Architecture, Patterns, Algorithms, Sequence Diagrams, and Implementation Plan
+argument-hint: "story=<file-path|github-url>"
+disable-model-invocation: true
+allowed-tools: Read, Bash, Write, Edit, AskUserQuestion, Glob, Grep, Agent
+model: opus
+effort: max
+context: fork
+agent: ace-technical-application-architect
+---
+
+## Environment Context (preprocessed)
+
+!`node "${CLAUDE_SKILL_DIR}/script.js" init "$ARGUMENTS" 2>/dev/null`
+
+## Supporting Resources (auto-loaded)
+
+!`cat "${CLAUDE_SKILL_DIR}/workflow.xml"`
+
+!`cat "${CLAUDE_SKILL_DIR}/technical-solution-template.xml"`
+
+!`cat "${CLAUDE_SKILL_DIR}/../../shared/utils/ui-formatting.md"`
+
+```xml
+<command>
+
+    <execution-time>
+        <runs-after>
+            <trigger>After /ace:plan-story — once story requirements (pass 1-2) are complete</trigger>
+            <trigger>After /ace:research-integration-solution — integration analysis (pass 4) MUST exist</trigger>
+            <trigger>Optionally after /ace:research-external-solution — external analysis (pass 3) if applicable</trigger>
+        </runs-after>
+        <use-when>
+            <condition>Story requirements, wiki references, and integration analysis are available (passes 1-4 complete)</condition>
+            <condition>Need to design a concrete technical solution for the story</condition>
+            <condition>Want a detailed implementation blueprint with class diagrams, sequence diagrams, algorithms, and file structure</condition>
+            <condition>Need a comprehensive technical design to guide AI agents implementing the story</condition>
+        </use-when>
+    </execution-time>
+
+    <input>
+        <flags>
+        </flags>
+
+        <parameters>
+            <required>
+                <param name="story" type="file | github-url">
+                    Story source — can be either:
+                    - **File path**: Path to a markdown file containing the story (from plan-story command)
+                    - **GitHub URL or issue number**: GitHub story reference
+                    Must be a valid, accessible file or GitHub issue.
+                    Contains the user story, acceptance criteria, and Relevant Wiki references
+                    that define what to design a technical solution for.
+
+                    **All context is extracted from the story document:**
+                    - Feature file (from story description/metadata)
+                    - Story requirements (User Story, Description, AC)
+                    - Wiki references (from Relevant Wiki section — pass 2)
+                    - External analysis (auto-detected in story directory — OPTIONAL)
+                    - Integration analysis (auto-detected in story directory — MANDATORY)
+
+                    If not valid, stop and prompt the user.
+                </param>
+            </required>
+
+            <optional>
+                <!-- No optional parameters.
+                     All context is extracted from the story document and story directory:
+                     - Feature file (from story description/metadata)
+                     - Story requirements (User Story, Description, AC)
+                     - Wiki references (from Relevant Wiki section — pass 2)
+                     - External analysis (auto-detected in story directory)
+                     - Integration analysis (auto-detected in story directory)
+                -->
+            </optional>
+        </parameters>
+    </input>
+
+    <execution-context>
+        <!-- All supporting files are auto-loaded in the Supporting Resources section above.
+             The model does NOT need to Read these files — they are already in context. -->
+    </execution-context>
+
+    <output>
+        <objective>
+            Use business requirements, integration analysis, and optionally external/industry-standard
+            analysis to create a CONCRETE TECHNICAL SOLUTION DESIGN for the story, following Clean
+            Architecture principles, SOLID patterns, OOP best practices, considering external analysis
+            for approach, algorithms and formulas (when most efficient and performant), while following
+            the integration analysis so that we don't break our already complex codebase.
+
+            **CRITICAL**: The technical solution MUST include detailed sequence diagrams for EVERY
+            scenario in the Acceptance Criteria, showing the complete flow of data and control
+            through all architectural layers.
+
+            The analysis covers:
+            - Complete component and boundary architecture
+            - Design patterns and technical decisions
+            - Full class diagrams and interfaces (one per file!)
+            - Data models and structures
+            - Algorithms and business logic
+            - Event flow and entry points
+            - MANDATORY sequence diagrams for ALL AC scenarios
+            - Complete file structure tree
+            - DI container configuration
+            - Testing strategy (unit, integration, e2e)
+            - Implementation order and dependencies
+
+            **Output**: The entire technical solution is written INTO the story document
+            (appended as the Technical Solution section) AND updated in the GitHub issue.
+            No separate output file is created.
+        </objective>
+
+        <artifacts>
+            Written directly into the story file and GitHub issue — pass 5 of the story specification pipeline.
+            See story.xml: &lt;section name="technical-solution" pass="5" template="story-technical-solution.xml"&gt;
+        </artifacts>
+    </output>
+
+    <process>
+        For this command use the `ace-technical-application-architect` agent
+        that's specialized in application architecture and is intimate with the codebase.
+
+        Execute the research-technical-solution workflow from
+        `workflow.xml` end-to-end.
+        Preserve all workflow gates (validation, approvals, commits).
+    </process>
+
+    <example-usage>
+        ```

package/skills/research-technical-solution/script.js

@@ -0,0 +1,223 @@
+#!/usr/bin/env node
+
+/**
+ * research-technical-solution skill script — Entry point for ace-tools operations
+ * needed by the research-technical-solution skill.
+ *
+ * Subcommands:
+ *   init [story-param]        Environment detection for research-technical-solution workflow
+ *
+ * Usage: node script.js <subcommand> [args] [--raw]
+ */
+
+const path = require('path');
+
+const {
+  loadConfig, pathExists, safeReadFile, loadSettings, resolveModel,
+  execCommand, output, error, runSkillScript,
+} = require('../../shared/lib/ace-core');
+
+const {
+  classifyStoryParam, extractStoryMetadata, extractStoryRequirements,
+  extractWikiReferences,
+  computeStoryPaths,
+} = require('../../shared/lib/ace-story');
+
+// ─── CLI Dispatch ────────────────────────────────────────────────────────────
+
+runSkillScript({
+  init: cmdInit,
+});
+
+// ─── Init: Research Story ───────────────────────────────────────────────────
+
+/**
+ * Environment detection for the research-technical-solution workflow.
+ *
+ * Replicates cmdInitResearchStory from ace-tools.js:
+ * 1. loadConfig, detect git/gh CLI/github_project
+ * 2. classifyStoryParam — validate story source
+ * 3. Load story content (from file or GitHub)
+ * 4. extractStoryMetadata, extractStoryRequirements, extractWikiReferences
+ * 5. computeStoryPaths or derive from file location
+ * 6. Check artifact existence (external/integration analysis, feature file)
+ * 7. Verify wiki doc existence
+ * 8. Output JSON with all data
+ */
+function cmdInit(cwd, raw, args, parsed) {
+  const storyParam = parsed.story || parsed._positional || null;
+  const config = loadConfig(cwd);
+
+  // ── Environment detection ──
+  const has_git = pathExists(cwd, '.git');
+  const has_gh_cli = (() => {
+    try {
+      const { execSync } = require('child_process');
+      execSync('gh --version', { stdio: 'pipe' });
+      return true;
+    } catch { return false; }
+  })();
+  const github_project = (() => {
+    const settings = loadSettings(cwd);
+    return settings.github_project;
+  })();
+
+  // ── Classify the story parameter ──
+  const classified = classifyStoryParam(storyParam);
+
+  // Early exit if invalid
+  if (classified.type === null || classified.type === 'invalid') {
+    output({
+      analyst_model: resolveModel(cwd, 'ace-code-integration-analyst'),
+      mapper_model: resolveModel(cwd, 'ace-wiki-mapper'),
+      commit_docs: config.commit_docs,
+      has_git, has_gh_cli, github_project,
+      story_source: null,
+      story_valid: false,
+      story_error: classified.reason || 'No story parameter provided',
+      story: { id: null, title: null, status: null, size: null },
+      feature: { id: null, title: null },
+      epic: { id: null, title: null },
+      user_story: null, description: null, acceptance_criteria_count: 0,
+      paths: null,
+      has_external_analysis: false, has_integration_analysis: false, has_feature_file: false,
+      wiki_references: { system_wide: [], subsystem_docs: [], total_count: 0 },
+      wiki_docs_exist: { existing: [], missing: [] },
+    }, raw);
+    return;
+  }
+
+  // ── Load story content ──
+  let storyContent = null;
+  let storySource = classified.type === 'file' ? 'file' : 'github';
+  let storyError = null;
+  let storyFilePath = null;
+
+  if (classified.type === 'file') {
+    const resolvedPath = path.isAbsolute(classified.filePath)
+      ? classified.filePath
+      : path.join(cwd, classified.filePath);
+    if (!pathExists(cwd, classified.filePath)) {
+      storyError = `Story file not found: ${classified.filePath}`;
+    } else {
+      storyContent = safeReadFile(resolvedPath);
+      storyFilePath = classified.filePath;
+      if (!storyContent) storyError = `Could not read story file: ${classified.filePath}`;
+    }
+  } else {
+    // github-url or issue-number
+    if (!has_gh_cli) {
+      storyError = 'GitHub CLI (gh) not installed. Cannot fetch GitHub issues.';
+    } else {
+      const repo = classified.repo || (github_project.repo || null);
+      if (!repo) {
+        storyError = 'No repository configured. Provide a full GitHub URL or configure github_project.repo in settings.';
+      } else {
+        const ghResult = execCommand(
+          `gh issue view ${classified.issueNumber} --repo ${repo} --json title,body,labels,state`,
+          cwd
+        );
+        if (!ghResult) {
+          storyError = `Could not fetch GitHub issue #${classified.issueNumber} from ${repo}.`;
+        } else {
+          try {
+            const issue = JSON.parse(ghResult);
+            storyContent = issue.body || '';
+            if (storyContent && !storyContent.match(/^#\s+/m)) {
+              storyContent = `# ${issue.title}\n\n${storyContent}`;
+            }
+          } catch {
+            storyError = `Failed to parse GitHub issue response for #${classified.issueNumber}.`;
+          }
+        }
+      }
+    }
+  }
+
+  // ── Extract metadata & requirements ──
+  const metadata = extractStoryMetadata(storyContent);
+  const requirements = extractStoryRequirements(storyContent);
+  const wikiRefs = extractWikiReferences(storyContent);
+
+  // ── Compute paths ──
+  let paths = null;
+  if (storyFilePath) {
+    const resolvedPath = path.isAbsolute(storyFilePath)
+      ? storyFilePath
+      : path.join(cwd, storyFilePath);
+    const storyDir = path.dirname(resolvedPath);
+    const relStoryDir = path.relative(cwd, storyDir).replace(/\\/g, '/');
+    const storySlug = path.basename(storyDir);
+    const featureDir = path.dirname(storyDir);
+    const relFeatureDir = path.relative(cwd, featureDir).replace(/\\/g, '/');
+    const featureSlug = path.basename(featureDir);
+
+    paths = {
+      epic_slug: null,
+      feature_slug: featureSlug,
+      story_slug: storySlug,
+      story_dir: relStoryDir,
+      story_file: storyFilePath.replace(/\\/g, '/'),
+      external_analysis_file: `${relStoryDir}/external-analysis.md`,
+      integration_analysis_file: `${relStoryDir}/integration-analysis.md`,
+      feature_dir: relFeatureDir,
+      feature_file: `${relFeatureDir}/${featureSlug}.md`,
+    };
+  } else if (metadata.epic.id && metadata.feature.id && metadata.id) {
+    paths = computeStoryPaths(
+      metadata.epic.id, metadata.epic.title || '',
+      metadata.feature.id, metadata.feature.title || '',
+      metadata.id, metadata.title || ''
+    );
+  }
+
+  // ── Check artifact existence ──
+  const has_external_analysis = paths ? pathExists(cwd, paths.external_analysis_file) : false;
+  const has_integration_analysis = paths ? pathExists(cwd, paths.integration_analysis_file) : false;
+  const has_feature_file = paths ? pathExists(cwd, paths.feature_file) : false;
+
+  // ── Verify wiki doc existence ──
+  const allWikiPaths = [...wikiRefs.system_wide, ...wikiRefs.subsystem_docs.map(d => d.path)];
+  const wikiExisting = [];
+  const wikiMissing = [];
+  for (const wikiPath of allWikiPaths) {
+    if (pathExists(cwd, wikiPath)) {
+      wikiExisting.push(wikiPath);
+    } else {
+      wikiMissing.push(wikiPath);
+    }
+  }
+
+  // ── Build result ──
+  const result = {
+    analyst_model: resolveModel(cwd, 'ace-code-integration-analyst'),
+    mapper_model: resolveModel(cwd, 'ace-wiki-mapper'),
+    commit_docs: config.commit_docs,
+    has_git, has_gh_cli, github_project,
+    story_source: storySource,
+    story_valid: storyContent !== null && storyError === null,
+    story_error: storyError,
+    story: {
+      id: metadata.id,
+      title: metadata.title,
+      status: metadata.status,
+      size: metadata.size,
+    },
+    feature: metadata.feature,
+    epic: metadata.epic,
+    user_story: requirements.user_story,
+    description: requirements.description,
+    acceptance_criteria_count: requirements.acceptance_criteria_count,
+    paths,
+    has_external_analysis,
+    has_integration_analysis,
+    has_feature_file,
+    wiki_references: wikiRefs,
+    wiki_docs_exist: {
+      existing: wikiExisting,
+      missing: wikiMissing,
+    },
+  };
+
+  output(result, raw);
+}

package/skills/research-technical-solution/script.test.js

@@ -0,0 +1,134 @@
+const { describe, it, before, after } = require('node:test');
+const assert = require('node:assert');
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const SCRIPT = path.join(__dirname, 'script.js');
+
+/**
+ * Create a minimal ACE project structure in a temp directory.
+ */
+function createTestProject() {
+  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'ace-test-'));
+
+  // .ace/config.json
+  const aceDir = path.join(tmpDir, '.ace');
+  fs.mkdirSync(aceDir, { recursive: true });
+  fs.writeFileSync(path.join(aceDir, 'config.json'), JSON.stringify({
+    version: '0.1.0',
+    projectName: 'test-project',
+    model_profile: 'quality',
+    commit_docs: true,
+    github: { enabled: false },
+  }, null, 2));
+
+  // .ace/settings.json
+  fs.writeFileSync(path.join(aceDir, 'settings.json'), JSON.stringify({
+    model_profile: 'quality',
+    commit_docs: true,
+    agent_teams: false,
+    github_project: { enabled: false, gh_installed: false, repo: '', project_number: null, owner: '' },
+  }, null, 2));
+
+  return tmpDir;
+}
+
+/**
+ * Create a story file in the test project.
+ */
+function createStoryFile(tmpDir, relPath, content) {
+  const fullPath = path.join(tmpDir, relPath);
+  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+  fs.writeFileSync(fullPath, content, 'utf-8');
+  return relPath;
+}
+
+function runScript(subcommand, args, cwd) {
+  return execSync(`node "${SCRIPT}" ${subcommand} ${args}`, {
+    cwd,
+    encoding: 'utf-8',
+    timeout: 10000,
+  });
+}
+
+function cleanup(tmpDir) {
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+}
+
+// ─── Tests ───────────────────────────────────────────────────────────────────
+
+describe('research-technical-solution script', () => {
+
+  describe('init', () => {
+    let tmpDir;
+
+    before(() => { tmpDir = createTestProject(); });
+    after(() => { cleanup(tmpDir); });
+
+    it('returns valid JSON with environment detection for a story file', () => {
+      const storyContent = [
+        '# S1: Add Login Button',
+        '**Feature**: F1 User Auth | **Epic**: E1 Platform',
+        '**Status**: Todo | **Size**: 3 | **Sprint**: — | **Link**: —',
+        '',
+        '## User Story',
+        '',
+        '> As a user,',
+        '> I want to click a login button,',
+        '> so that I can access my account.',
+        '',
+        '## Description',
+        '',
+        'Adds a login button to the header.',
+        '',
+        '## Acceptance Criteria',
+        '',
+        '### Scenario: Click login button',
+        '',
+        '**Given** the user is on the homepage',
+        '**When** they click "Login"',
+        '**Then** they see the login form',
+      ].join('\n');
+
+      const storyPath = createStoryFile(
+        tmpDir,
+        '.ace/artifacts/product/e1-platform/f1-user-auth/s1-add-login-button/s1-add-login-button.md',
+        storyContent
+      );
+
+      const result = JSON.parse(runScript('init', storyPath, tmpDir));
+
+      assert.ok(result.analyst_model, 'should have analyst_model');
+      assert.ok(result.mapper_model, 'should have mapper_model');
+      assert.strictEqual(result.story_valid, true, 'story should be valid');
+      assert.strictEqual(result.story_source, 'file');
+      assert.strictEqual(result.story.id, 'S1');
+      assert.strictEqual(result.story.title, 'Add Login Button');
+      assert.strictEqual(result.acceptance_criteria_count, 1);
+      assert.ok(result.paths, 'should have computed paths');
+      assert.ok(result.wiki_references, 'should have wiki_references');
+      assert.ok(result.wiki_docs_exist, 'should have wiki_docs_exist');
+    });
+
+    it('errors on init without story param', () => {
+      const result = JSON.parse(runScript('init', '', tmpDir));
+      assert.strictEqual(result.story_valid, false);
+    });
+
+    it('handles non-existent story file gracefully', () => {
+      const result = JSON.parse(runScript('init', 'nonexistent/story.md', tmpDir));
+      assert.strictEqual(result.story_valid, false);
+      assert.ok(result.story_error.includes('not found'));
+    });
+  });
+
+  describe('error handling', () => {
+    it('errors on unknown command', () => {
+      assert.throws(() => {
+        execSync(`node "${SCRIPT}" bogus`, { encoding: 'utf-8', stdio: 'pipe' });
+      });
+    });
+  });
+});