specweave 0.17.0 → 0.17.2

package/plugins/specweave-ado/lib/ado-spec-commit-sync.ts

@@ -0,0 +1,288 @@
+/**
+ * Azure DevOps Spec Commit Sync
+ *
+ * Posts commit/PR comments to ADO work items linked to living docs specs.
+ * This enables traceability from spec user stories to actual code changes.
+ */
+
+import { AdoClientV2 } from './ado-client-v2.js';
+import {
+  getRecentCommits,
+  detectRepository,
+  getCommitUrl,
+  findPRForCommit,
+  getLastSyncCommit,
+  updateLastSyncCommit,
+  GitCommit,
+  GitRepository,
+  PullRequest,
+} from '../../../src/utils/git-utils.js';
+import {
+  getSpecTaskMapping,
+  getCompletedUserStories,
+  SpecTaskMapping,
+  UserStory,
+} from '../../../src/core/spec-task-mapper.js';
+import {
+  buildUserStoryComment,
+  buildCommitBatchComment,
+  buildShortComment,
+  generateSmartSummary,
+  formatForAdo,
+  CommentContent,
+} from '../../../src/core/comment-builder.js';
+import path from 'path';
+import fs from 'fs/promises';
+
+export interface SyncOptions {
+  incrementPath: string;
+  dryRun?: boolean;
+  verbose?: boolean;
+}
+
+export interface SyncResult {
+  success: boolean;
+  commentsPosted: number;
+  errors: string[];
+  commits: GitCommit[];
+  userStories: UserStory[];
+}
+
+/**
+ * Sync commits for completed user stories to ADO work item
+ */
+export async function syncSpecCommitsToAdo(
+  client: AdoClientV2,
+  options: SyncOptions
+): Promise<SyncResult> {
+  const { incrementPath, dryRun = false, verbose = false } = options;
+
+  const result: SyncResult = {
+    success: true,
+    commentsPosted: 0,
+    errors: [],
+    commits: [],
+    userStories: [],
+  };
+
+  try {
+    // 1. Check if increment has ADO work item linked
+    const metadataPath = path.join(incrementPath, 'metadata.json');
+    let metadata: any;
+
+    try {
+      metadata = JSON.parse(await fs.readFile(metadataPath, 'utf-8'));
+    } catch {
+      result.errors.push('No metadata.json found');
+      return result;
+    }
+
+    const adoWorkItemId = metadata.ado?.workItemId;
+    if (!adoWorkItemId) {
+      if (verbose) {
+        console.log('No ADO work item linked to increment');
+      }
+      return result;
+    }
+
+    // 2. Detect repository
+    const repo = await detectRepository('origin', incrementPath);
+    if (!repo) {
+      result.errors.push('Git repository not found');
+      result.success = false;
+      return result;
+    }
+
+    // 3. Get spec-task mapping
+    const mapping = await getSpecTaskMapping(incrementPath);
+    if (!mapping) {
+      if (verbose) {
+        console.log('No spec mapping found for increment');
+      }
+      return result;
+    }
+
+    // 4. Get completed user stories
+    const completedUserStories = getCompletedUserStories(mapping);
+    if (completedUserStories.length === 0) {
+      if (verbose) {
+        console.log('No completed user stories');
+      }
+      return result;
+    }
+
+    result.userStories = completedUserStories;
+
+    // 5. Get recent commits (since last sync)
+    const lastSyncCommit = await getLastSyncCommit(metadataPath);
+    const commits = lastSyncCommit
+      ? await getRecentCommits(undefined, lastSyncCommit, incrementPath)
+      : await getRecentCommits('7.days', undefined, incrementPath);
+
+    if (commits.length === 0) {
+      if (verbose) {
+        console.log('No new commits since last sync');
+      }
+      return result;
+    }
+
+    result.commits = commits;
+
+    // Add commit URLs
+    for (const commit of commits) {
+      commit.url = getCommitUrl(commit, repo);
+    }
+
+    // 6. Post comments for each completed user story
+    for (const userStory of completedUserStories) {
+      try {
+        // Get tasks for this user story
+        const relatedTasks = mapping.tasks.filter(t =>
+          t.userStories.includes(userStory.id)
+        );
+
+        // Find PRs for commits (optional, best effort)
+        const pullRequests: PullRequest[] = [];
+        if (repo.provider === 'github') {
+          for (const commit of commits.slice(0, 3)) {
+            const pr = await findPRForCommit(commit.sha, repo.owner, repo.repo);
+            if (pr && !pullRequests.find(p => p.number === pr.number)) {
+              pullRequests.push(pr);
+            }
+          }
+        }
+
+        // Build comment
+        const summary = generateSmartSummary(commits, relatedTasks);
+        const commentContent: CommentContent = {
+          userStory,
+          tasks: relatedTasks,
+          commits,
+          pullRequests,
+          summary,
+        };
+
+        const formattedComment = buildUserStoryComment(commentContent, repo);
+        const adoComment = formatForAdo(formattedComment);
+
+        if (verbose) {
+          console.log(`\nComment for ${userStory.id} (ADO format):`);
+          console.log(adoComment);
+          console.log('\n---\n');
+        }
+
+        // Post comment to ADO
+        if (!dryRun) {
+          await client.addComment(adoWorkItemId, adoComment);
+          result.commentsPosted++;
+        } else {
+          result.commentsPosted++;
+        }
+      } catch (error: any) {
+        result.errors.push(`Failed to post comment for ${userStory.id}: ${error.message}`);
+      }
+    }
+
+    // 7. If no user stories completed but there are commits, post a simple update
+    if (completedUserStories.length === 0 && commits.length > 0) {
+      try {
+        const summary = `Work in progress: ${commits.length} commit${commits.length > 1 ? 's' : ''}`;
+        const formattedComment = buildShortComment(commits, repo, summary);
+        const adoComment = formatForAdo(formattedComment);
+
+        if (verbose) {
+          console.log(`\nShort update comment (ADO format):`);
+          console.log(adoComment);
+          console.log('\n---\n');
+        }
+
+        if (!dryRun) {
+          await client.addComment(adoWorkItemId, adoComment);
+          result.commentsPosted++;
+        } else {
+          result.commentsPosted++;
+        }
+      } catch (error: any) {
+        result.errors.push(`Failed to post short update: ${error.message}`);
+      }
+    }
+
+    // 8. Update last sync commit
+    if (!dryRun && commits.length > 0) {
+      await updateLastSyncCommit(metadataPath, commits[0].sha);
+    }
+
+  } catch (error: any) {
+    result.success = false;
+    result.errors.push(error.message);
+  }
+
+  return result;
+}
+
+/**
+ * Post batch commit update to ADO work item
+ */
+export async function postCommitBatchUpdate(
+  client: AdoClientV2,
+  incrementPath: string,
+  commits: GitCommit[],
+  workItemId: number,
+  repo: GitRepository,
+  dryRun: boolean = false
+): Promise<boolean> {
+  try {
+    // Add commit URLs
+    for (const commit of commits) {
+      commit.url = getCommitUrl(commit, repo);
+    }
+
+    // Build and post comment
+    const formattedComment = buildCommitBatchComment(commits, repo, true);
+    const adoComment = formatForAdo(formattedComment);
+
+    if (!dryRun) {
+      await client.addComment(workItemId, adoComment);
+    }
+
+    return true;
+  } catch (error: any) {
+    console.error(`Failed to post batch update: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * Check if spec commit sync is enabled in config
+ */
+export async function isSpecCommitSyncEnabled(
+  projectRoot: string
+): Promise<boolean> {
+  try {
+    const configPath = path.join(projectRoot, '.specweave', 'config.json');
+    const config = JSON.parse(await fs.readFile(configPath, 'utf-8'));
+
+    return config.sync?.settings?.postCommitComments !== false;
+  } catch {
+    return true; // Default: enabled
+  }
+}
+
+/**
+ * Get ADO work item ID from spec metadata
+ */
+export async function getAdoWorkItemForSpec(
+  specPath: string
+): Promise<number | null> {
+  try {
+    const content = await fs.readFile(specPath, 'utf-8');
+
+    // Extract ADO work item from frontmatter or body
+    // Pattern: **ADO Feature**: #12345
+    const match = content.match(/\*\*ADO Feature\*\*:\s*#?(\d+)/);
+
+    return match ? parseInt(match[1], 10) : null;
+  } catch {
+    return null;
+  }
+}

package/plugins/specweave-ado/lib/ado-spec-content-sync.js

@@ -0,0 +1,205 @@
+import {
+  parseSpecContent,
+  detectContentChanges,
+  hasExternalLink,
+  updateSpecWithExternalLink
+} from "../../../src/core/spec-content-sync.js";
+import path from "path";
+import fs from "fs/promises";
+async function syncSpecContentToAdo(options) {
+  const { specPath, client, dryRun = false, verbose = false } = options;
+  try {
+    const spec = await parseSpecContent(specPath);
+    if (!spec) {
+      return {
+        success: false,
+        action: "error",
+        error: "Failed to parse spec content"
+      };
+    }
+    if (verbose) {
+      console.log(`\u{1F4C4} Parsed spec: ${spec.id}`);
+      console.log(`   Title: ${spec.title}`);
+      console.log(`   User Stories: ${spec.userStories.length}`);
+    }
+    const existingWorkItemId = await hasExternalLink(specPath, "ado");
+    if (existingWorkItemId) {
+      return await updateAdoFeature(
+        client,
+        spec,
+        parseInt(existingWorkItemId),
+        options
+      );
+    } else {
+      return await createAdoFeature(client, spec, options);
+    }
+  } catch (error) {
+    return {
+      success: false,
+      action: "error",
+      error: error.message
+    };
+  }
+}
+async function createAdoFeature(client, spec, options) {
+  const { specPath, dryRun, verbose } = options;
+  try {
+    const title = `[${spec.id.toUpperCase()}] ${spec.title}`;
+    const description = buildAdoDescription(spec);
+    if (verbose) {
+      console.log(`
+\u{1F4DD} Creating ADO feature:`);
+      console.log(`   Title: ${title}`);
+      console.log(`   Description length: ${description.length} chars`);
+    }
+    if (dryRun) {
+      console.log("\n\u{1F50D} Dry run - would create feature:");
+      console.log(`   Title: ${title}`);
+      console.log(`   Description:
+${description}`);
+      return {
+        success: true,
+        action: "created",
+        externalId: "DRY-RUN",
+        externalUrl: "https://dev.azure.com/DRY-RUN"
+      };
+    }
+    const tags = ["specweave", "spec", spec.metadata.priority || "P2"];
+    const workItem = await client.createEpic({
+      title,
+      description,
+      tags
+    });
+    if (verbose) {
+      console.log(`\u2705 Created feature #${workItem.id}`);
+      console.log(`   URL: ${workItem._links.html.href}`);
+    }
+    await updateSpecWithExternalLink(
+      specPath,
+      "ado",
+      workItem.id.toString(),
+      workItem._links.html.href
+    );
+    return {
+      success: true,
+      action: "created",
+      externalId: workItem.id.toString(),
+      externalUrl: workItem._links.html.href
+    };
+  } catch (error) {
+    return {
+      success: false,
+      action: "error",
+      error: `Failed to create ADO feature: ${error.message}`
+    };
+  }
+}
+async function updateAdoFeature(client, spec, workItemId, options) {
+  const { specPath, dryRun, verbose } = options;
+  try {
+    const workItem = await client.getWorkItem(workItemId);
+    if (verbose) {
+      console.log(`
+\u{1F504} Checking for changes in feature #${workItemId}`);
+    }
+    const changes = detectContentChanges(spec, {
+      title: workItem.fields["System.Title"].replace(/^\[SPEC-\d+\]\s*/, ""),
+      description: stripHtmlTags(workItem.fields["System.Description"] || ""),
+      userStoryCount: 0
+      // TODO: Parse from description
+    });
+    if (!changes.hasChanges) {
+      if (verbose) {
+        console.log("   \u2139\uFE0F  No changes detected");
+      }
+      return {
+        success: true,
+        action: "no-change",
+        externalId: workItemId.toString(),
+        externalUrl: workItem._links.html.href
+      };
+    }
+    if (verbose) {
+      console.log("   \u{1F4DD} Changes detected:");
+      for (const change of changes.changes) {
+        console.log(`      - ${change}`);
+      }
+    }
+    const newTitle = `[${spec.id.toUpperCase()}] ${spec.title}`;
+    const newDescription = buildAdoDescription(spec);
+    if (dryRun) {
+      console.log("\n\u{1F50D} Dry run - would update feature:");
+      console.log(`   Title: ${newTitle}`);
+      console.log(`   Description:
+${newDescription}`);
+      return {
+        success: true,
+        action: "updated",
+        externalId: workItemId.toString(),
+        externalUrl: workItem._links.html.href
+      };
+    }
+    await client.updateWorkItem(workItemId, {
+      title: newTitle,
+      description: newDescription
+    });
+    if (verbose) {
+      console.log(`\u2705 Updated feature #${workItemId}`);
+    }
+    return {
+      success: true,
+      action: "updated",
+      externalId: workItemId.toString(),
+      externalUrl: workItem._links.html.href
+    };
+  } catch (error) {
+    return {
+      success: false,
+      action: "error",
+      error: `Failed to update ADO feature: ${error.message}`
+    };
+  }
+}
+function buildAdoDescription(spec) {
+  let html = "";
+  if (spec.description) {
+    html += `<p>${escapeHtml(spec.description)}</p>`;
+  }
+  if (spec.userStories.length > 0) {
+    html += "<h2>User Stories</h2>";
+    for (const us of spec.userStories) {
+      html += `<h3>${us.id}: ${escapeHtml(us.title)}</h3>`;
+      if (us.acceptanceCriteria.length > 0) {
+        html += "<p><strong>Acceptance Criteria:</strong></p><ul>";
+        for (const ac of us.acceptanceCriteria) {
+          const checkbox = ac.completed ? "\u2611" : "\u2610";
+          html += `<li>${checkbox} ${ac.id}: ${escapeHtml(ac.description)}</li>`;
+        }
+        html += "</ul>";
+      }
+    }
+  }
+  if (spec.metadata.priority) {
+    html += `<p><strong>Priority:</strong> ${spec.metadata.priority}</p>`;
+  }
+  return html;
+}
+function escapeHtml(text) {
+  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+}
+function stripHtmlTags(html) {
+  return html.replace(/<[^>]*>/g, "").trim();
+}
+async function isContentSyncEnabled(projectRoot) {
+  try {
+    const configPath = path.join(projectRoot, ".specweave", "config.json");
+    const config = JSON.parse(await fs.readFile(configPath, "utf-8"));
+    return config.sync?.settings?.syncSpecContent !== false;
+  } catch {
+    return true;
+  }
+}
+export {
+  isContentSyncEnabled,
+  syncSpecContentToAdo
+};