@programinglive/dev-workflow-mcp-server 1.0.8 → 1.0.11

package/tests/workflowState.test.js

@@ -1,231 +1,231 @@
-import test from "node:test";
-import assert from "node:assert/strict";
-import { mkdtemp, rm } from "node:fs/promises";
-import { tmpdir } from "node:os";
-import path from "node:path";
-import {
-  WorkflowState,
-  getNextStep,
-  containsTestFilesInStatus,
-  createCommitMessageParts,
-  determineReleaseTypeFromCommit,
-  workingTreeSummary,
-} from "../index.js";
-
-async function withWorkflowState(callback) {
-  const tempDir = await mkdtemp(path.join(tmpdir(), "workflow-state-"));
-  const stateFile = path.join(tempDir, "state.json");
-  const state = new WorkflowState(stateFile);
-  await state.load();
-
-  try {
-    await callback(state);
-  } finally {
-    await rm(tempDir, { recursive: true, force: true });
-  }
-}
-
-test("WorkflowState persists data across save/load", async () => {
-  await withWorkflowState(async (state) => {
-    state.state.currentPhase = "testing";
-    state.state.taskDescription = "Test persistence";
-    state.state.bugFixed = true;
-    state.state.testsCreated = true;
-    state.state.readyCheckCompleted = true;
-    state.state.released = true;
-    state.state.releaseCommand = "npm run release";
-    state.state.releaseNotes = "Automated release";
-    state.state.commitAndPushCompleted = true;
-    state.state.lastCommitMessage = "test: persistence";
-    state.state.lastPushBranch = "main";
-    state.state.testsSkipped = true;
-    state.state.testsSkippedReason = "Legacy app uses manual QA";
-    await state.save();
-
-    const reloaded = new WorkflowState(state.stateFile);
-    await reloaded.load();
-
-    assert.equal(reloaded.state.currentPhase, "testing");
-    assert.equal(reloaded.state.taskDescription, "Test persistence");
-    assert.equal(reloaded.state.bugFixed, true);
-    assert.equal(reloaded.state.testsCreated, true);
-    assert.equal(reloaded.state.readyCheckCompleted, true);
-    assert.equal(reloaded.state.released, true);
-    assert.equal(reloaded.state.releaseCommand, "npm run release");
-    assert.equal(reloaded.state.releaseNotes, "Automated release");
-    assert.equal(reloaded.state.commitAndPushCompleted, true);
-    assert.equal(reloaded.state.lastCommitMessage, "test: persistence");
-    assert.equal(reloaded.state.lastPushBranch, "main");
-    assert.equal(reloaded.state.testsSkipped, true);
-    assert.equal(
-      reloaded.state.testsSkippedReason,
-      "Legacy app uses manual QA"
-    );
-  });
-});
-
-test("WorkflowState reset keeps history but clears progress", async () => {
-  await withWorkflowState(async (state) => {
-    state.state.currentPhase = "ready";
-    state.state.testsCreated = true;
-    state.state.testsPassed = true;
-    state.state.documentationCreated = true;
-    state.state.readyCheckCompleted = true;
-    state.state.released = true;
-    state.state.commitAndPushCompleted = true;
-    state.state.testsSkipped = true;
-    state.state.testsSkippedReason = "Manual QA";
-    state.addToHistory({ taskDescription: "Sample task" });
-
-    state.reset();
-
-    assert.equal(state.state.currentPhase, "idle");
-    assert.equal(state.state.testsCreated, false);
-    assert.equal(state.state.testsPassed, false);
-    assert.equal(state.state.documentationCreated, false);
-    assert.equal(state.state.readyCheckCompleted, false);
-    assert.equal(state.state.released, false);
-    assert.equal(state.state.commitAndPushCompleted, false);
-    assert.equal(state.state.testsSkipped, false);
-    assert.equal(state.state.testsSkippedReason, "");
-    assert.equal(state.state.history.length, 1);
-    assert.equal(state.state.history[0].taskDescription, "Sample task");
-  });
-});
-
-test("getNextStep treats skipped tests as satisfied", () => {
-  const skippedState = {
-    bugFixed: true,
-    testsCreated: true,
-    testsPassed: true,
-    testsSkipped: true,
-    testsSkippedReason: "Legacy system",
-    documentationCreated: false,
-    readyCheckCompleted: false,
-    commitAndPushCompleted: false,
-    released: false,
-  };
-
-  assert.equal(getNextStep(skippedState), "Create documentation");
-});
-
-test("getNextStep guides workflow progression", () => {
-  const baseState = {
-    bugFixed: false,
-    testsCreated: false,
-    testsPassed: false,
-    documentationCreated: false,
-    readyCheckCompleted: false,
-    commitAndPushCompleted: false,
-    released: false,
-  };
-
-  assert.equal(
-    getNextStep(baseState),
-    "Mark feature/bug as fixed"
-  );
-
-  const afterFix = { ...baseState, bugFixed: true };
-  assert.equal(
-    getNextStep(afterFix),
-    "Create tests"
-  );
-
-  const afterTestsCreated = { ...afterFix, testsCreated: true };
-  assert.equal(getNextStep(afterTestsCreated), "Run tests");
-
-  const afterTests = { ...afterTestsCreated, testsPassed: true };
-  assert.equal(
-    getNextStep(afterTests),
-    "Create documentation"
-  );
-
-  const afterDocs = { ...afterTests, documentationCreated: true };
-  assert.equal(getNextStep(afterDocs), "Run 'check_ready_to_commit'");
-
-  const afterReadyCheck = { ...afterDocs, readyCheckCompleted: true };
-  assert.equal(getNextStep(afterReadyCheck), "Run 'commit_and_push'");
-
-  const afterCommit = { ...afterReadyCheck, commitAndPushCompleted: true };
-  assert.equal(getNextStep(afterCommit), "Run 'perform_release'");
-
-  const afterRelease = { ...afterCommit, released: true };
-  assert.equal(getNextStep(afterRelease), "Complete the task");
-});
-
-test("containsTestFilesInStatus detects modified test files", () => {
-  const statusOutput = [
-    " M src/app.test.js",
-    "A  tests/helpers/util.js",
-    "R  src/old.js -> src/new.spec.ts",
-  ].join("\n");
-
-  assert.equal(containsTestFilesInStatus(statusOutput), true);
-});
-
-test("containsTestFilesInStatus returns false when no test files present", () => {
-  const statusOutput = [
-    " M src/app.js",
-    "A  docs/README.md",
-    "?? assets/logo.png",
-  ].join("\n");
-
-  assert.equal(containsTestFilesInStatus(statusOutput), false);
-});
-
-test("createCommitMessageParts generates test prefixed summary with details", () => {
-  const changes = [
-    { status: "M", path: "src/app.test.js" },
-    { status: "A", path: "tests/helpers/util.js" },
-  ];
-
-  const { summary, body } = createCommitMessageParts(changes);
-
-  assert.equal(summary.startsWith("test:"), true);
-  assert.equal(body.includes("- modified src/app.test.js"), true);
-  assert.equal(body.includes("- added tests/helpers/util.js"), true);
-});
-
-test("createCommitMessageParts respects provided summary when present", () => {
-  const changes = [{ status: "M", path: "docs/guide.md" }];
-  const provided = "docs: update guide";
-
-  const { summary, body } = createCommitMessageParts(changes, provided);
-
-  assert.equal(summary, provided);
-  assert.equal(body.includes("- modified docs/guide.md"), true);
-});
-
-test("determineReleaseTypeFromCommit returns major for breaking change", () => {
-  const message = "feat!: overhaul API\n\nBREAKING CHANGE: new behavior";
-  assert.equal(determineReleaseTypeFromCommit(message), "major");
-});
-
-test("determineReleaseTypeFromCommit returns minor for feat", () => {
-  const message = "feat: add dashboard";
-  assert.equal(determineReleaseTypeFromCommit(message), "minor");
-});
-
-test("determineReleaseTypeFromCommit returns patch for fix", () => {
-  const message = "fix: resolve login issue";
-  assert.equal(determineReleaseTypeFromCommit(message), "patch");
-});
-
-test("determineReleaseTypeFromCommit defaults to patch for other commit types", () => {
-  const message = "chore: update dependencies";
-  assert.equal(determineReleaseTypeFromCommit(message), "patch");
-});
-
-test("workingTreeSummary reports no changes for empty output", () => {
-  const summary = workingTreeSummary("\n  \n");
-  assert.equal(summary.hasChanges, false);
-  assert.deepEqual(summary.lines, []);
-});
-
-test("workingTreeSummary lists trimmed status lines", () => {
-  const statusOutput = " M src/app.js\nA  tests/new.test.js\n";
-  const summary = workingTreeSummary(statusOutput);
-
-  assert.equal(summary.hasChanges, true);
-  assert.deepEqual(summary.lines, ["M src/app.js", "A tests/new.test.js"]);
-});
+import test from "node:test";
+import assert from "node:assert/strict";
+import { mkdtemp, rm } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import {
+  WorkflowState,
+  getNextStep,
+  containsTestFilesInStatus,
+  createCommitMessageParts,
+  determineReleaseTypeFromCommit,
+  workingTreeSummary,
+} from "../index.js";
+
+async function withWorkflowState(callback) {
+  const tempDir = await mkdtemp(path.join(tmpdir(), "workflow-state-"));
+  const stateFile = path.join(tempDir, "state.json");
+  const state = new WorkflowState(stateFile);
+  await state.load();
+
+  try {
+    await callback(state);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+test("WorkflowState persists data across save/load", async () => {
+  await withWorkflowState(async (state) => {
+    state.state.currentPhase = "testing";
+    state.state.taskDescription = "Test persistence";
+    state.state.bugFixed = true;
+    state.state.testsCreated = true;
+    state.state.readyCheckCompleted = true;
+    state.state.released = true;
+    state.state.releaseCommand = "npm run release";
+    state.state.releaseNotes = "Automated release";
+    state.state.commitAndPushCompleted = true;
+    state.state.lastCommitMessage = "test: persistence";
+    state.state.lastPushBranch = "main";
+    state.state.testsSkipped = true;
+    state.state.testsSkippedReason = "Legacy app uses manual QA";
+    await state.save();
+
+    const reloaded = new WorkflowState(state.stateFile);
+    await reloaded.load();
+
+    assert.equal(reloaded.state.currentPhase, "testing");
+    assert.equal(reloaded.state.taskDescription, "Test persistence");
+    assert.equal(reloaded.state.bugFixed, true);
+    assert.equal(reloaded.state.testsCreated, true);
+    assert.equal(reloaded.state.readyCheckCompleted, true);
+    assert.equal(reloaded.state.released, true);
+    assert.equal(reloaded.state.releaseCommand, "npm run release");
+    assert.equal(reloaded.state.releaseNotes, "Automated release");
+    assert.equal(reloaded.state.commitAndPushCompleted, true);
+    assert.equal(reloaded.state.lastCommitMessage, "test: persistence");
+    assert.equal(reloaded.state.lastPushBranch, "main");
+    assert.equal(reloaded.state.testsSkipped, true);
+    assert.equal(
+      reloaded.state.testsSkippedReason,
+      "Legacy app uses manual QA"
+    );
+  });
+});
+
+test("WorkflowState reset keeps history but clears progress", async () => {
+  await withWorkflowState(async (state) => {
+    state.state.currentPhase = "ready";
+    state.state.testsCreated = true;
+    state.state.testsPassed = true;
+    state.state.documentationCreated = true;
+    state.state.readyCheckCompleted = true;
+    state.state.released = true;
+    state.state.commitAndPushCompleted = true;
+    state.state.testsSkipped = true;
+    state.state.testsSkippedReason = "Manual QA";
+    state.addToHistory({ taskDescription: "Sample task" });
+
+    state.reset();
+
+    assert.equal(state.state.currentPhase, "idle");
+    assert.equal(state.state.testsCreated, false);
+    assert.equal(state.state.testsPassed, false);
+    assert.equal(state.state.documentationCreated, false);
+    assert.equal(state.state.readyCheckCompleted, false);
+    assert.equal(state.state.released, false);
+    assert.equal(state.state.commitAndPushCompleted, false);
+    assert.equal(state.state.testsSkipped, false);
+    assert.equal(state.state.testsSkippedReason, "");
+    assert.equal(state.state.history.length, 1);
+    assert.equal(state.state.history[0].taskDescription, "Sample task");
+  });
+});
+
+test("getNextStep treats skipped tests as satisfied", () => {
+  const skippedState = {
+    bugFixed: true,
+    testsCreated: true,
+    testsPassed: true,
+    testsSkipped: true,
+    testsSkippedReason: "Legacy system",
+    documentationCreated: false,
+    readyCheckCompleted: false,
+    commitAndPushCompleted: false,
+    released: false,
+  };
+
+  assert.equal(getNextStep(skippedState), "Create documentation");
+});
+
+test("getNextStep guides workflow progression", () => {
+  const baseState = {
+    bugFixed: false,
+    testsCreated: false,
+    testsPassed: false,
+    documentationCreated: false,
+    readyCheckCompleted: false,
+    commitAndPushCompleted: false,
+    released: false,
+  };
+
+  assert.equal(
+    getNextStep(baseState),
+    "Mark feature/bug as fixed"
+  );
+
+  const afterFix = { ...baseState, bugFixed: true };
+  assert.equal(
+    getNextStep(afterFix),
+    "Create tests"
+  );
+
+  const afterTestsCreated = { ...afterFix, testsCreated: true };
+  assert.equal(getNextStep(afterTestsCreated), "Run tests");
+
+  const afterTests = { ...afterTestsCreated, testsPassed: true };
+  assert.equal(
+    getNextStep(afterTests),
+    "Create documentation"
+  );
+
+  const afterDocs = { ...afterTests, documentationCreated: true };
+  assert.equal(getNextStep(afterDocs), "Run 'check_ready_to_commit'");
+
+  const afterReadyCheck = { ...afterDocs, readyCheckCompleted: true };
+  assert.equal(getNextStep(afterReadyCheck), "Run 'commit_and_push'");
+
+  const afterCommit = { ...afterReadyCheck, commitAndPushCompleted: true };
+  assert.equal(getNextStep(afterCommit), "Run 'perform_release'");
+
+  const afterRelease = { ...afterCommit, released: true };
+  assert.equal(getNextStep(afterRelease), "Complete the task");
+});
+
+test("containsTestFilesInStatus detects modified test files", () => {
+  const statusOutput = [
+    " M src/app.test.js",
+    "A  tests/helpers/util.js",
+    "R  src/old.js -> src/new.spec.ts",
+  ].join("\n");
+
+  assert.equal(containsTestFilesInStatus(statusOutput), true);
+});
+
+test("containsTestFilesInStatus returns false when no test files present", () => {
+  const statusOutput = [
+    " M src/app.js",
+    "A  docs/README.md",
+    "?? assets/logo.png",
+  ].join("\n");
+
+  assert.equal(containsTestFilesInStatus(statusOutput), false);
+});
+
+test("createCommitMessageParts generates test prefixed summary with details", () => {
+  const changes = [
+    { status: "M", path: "src/app.test.js" },
+    { status: "A", path: "tests/helpers/util.js" },
+  ];
+
+  const { summary, body } = createCommitMessageParts(changes);
+
+  assert.equal(summary.startsWith("test:"), true);
+  assert.equal(body.includes("- modified src/app.test.js"), true);
+  assert.equal(body.includes("- added tests/helpers/util.js"), true);
+});
+
+test("createCommitMessageParts respects provided summary when present", () => {
+  const changes = [{ status: "M", path: "docs/guide.md" }];
+  const provided = "docs: update guide";
+
+  const { summary, body } = createCommitMessageParts(changes, provided);
+
+  assert.equal(summary, provided);
+  assert.equal(body.includes("- modified docs/guide.md"), true);
+});
+
+test("determineReleaseTypeFromCommit returns major for breaking change", () => {
+  const message = "feat!: overhaul API\n\nBREAKING CHANGE: new behavior";
+  assert.equal(determineReleaseTypeFromCommit(message), "major");
+});
+
+test("determineReleaseTypeFromCommit returns minor for feat", () => {
+  const message = "feat: add dashboard";
+  assert.equal(determineReleaseTypeFromCommit(message), "minor");
+});
+
+test("determineReleaseTypeFromCommit returns patch for fix", () => {
+  const message = "fix: resolve login issue";
+  assert.equal(determineReleaseTypeFromCommit(message), "patch");
+});
+
+test("determineReleaseTypeFromCommit defaults to patch for other commit types", () => {
+  const message = "chore: update dependencies";
+  assert.equal(determineReleaseTypeFromCommit(message), "patch");
+});
+
+test("workingTreeSummary reports no changes for empty output", () => {
+  const summary = workingTreeSummary("\n  \n");
+  assert.equal(summary.hasChanges, false);
+  assert.deepEqual(summary.lines, []);
+});
+
+test("workingTreeSummary lists trimmed status lines", () => {
+  const statusOutput = " M src/app.js\nA  tests/new.test.js\n";
+  const summary = workingTreeSummary(statusOutput);
+
+  assert.equal(summary.hasChanges, true);
+  assert.deepEqual(summary.lines, ["M src/app.js", "A tests/new.test.js"]);
+});

package/tools/definitions.js

@@ -0,0 +1,211 @@
+export function getToolList() {
+  return [
+    {
+      name: "start_task",
+      description:
+        "Start a new coding task. This is the first step - be conscious about what you're coding.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          description: {
+            type: "string",
+            description: "Clear description of what you're going to code",
+          },
+          type: {
+            type: "string",
+            enum: ["feature", "bugfix", "refactor", "other"],
+            description: "Type of task",
+          },
+        },
+        required: ["description", "type"],
+      },
+    },
+    {
+      name: "mark_bug_fixed",
+      description:
+        "Mark that the bug/feature is fixed. Reminder: Now you MUST create tests!",
+      inputSchema: {
+        type: "object",
+        properties: {
+          summary: {
+            type: "string",
+            description: "Brief summary of what was fixed/implemented",
+          },
+        },
+        required: ["summary"],
+      },
+    },
+    {
+      name: "create_tests",
+      description: "Mark that tests covering the change have been created.",
+      inputSchema: {
+        type: "object",
+        properties: {},
+      },
+    },
+    {
+      name: "skip_tests",
+      description:
+        "Record that tests were intentionally skipped, with a justification.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          reason: {
+            type: "string",
+            description: "Why tests cannot be created or executed",
+          },
+        },
+        required: ["reason"],
+      },
+    },
+    {
+      name: "run_tests",
+      description:
+        "Record test results. NEVER commit if tests fail! Only proceed if all tests are green.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          passed: {
+            type: "boolean",
+            description: "Did all tests pass?",
+          },
+          testCommand: {
+            type: "string",
+            description: "The test command that was run",
+          },
+          details: {
+            type: "string",
+            description: "Test results details",
+          },
+        },
+        required: ["passed", "testCommand"],
+      },
+    },
+    {
+      name: "create_documentation",
+      description:
+        "Mark that documentation has been created/updated. This is required before committing.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          documentationType: {
+            type: "string",
+            enum: ["README", "inline-comments", "API-docs", "changelog", "other"],
+            description: "Type of documentation created",
+          },
+          summary: {
+            type: "string",
+            description: "What was documented",
+          },
+        },
+        required: ["documentationType", "summary"],
+      },
+    },
+    {
+      name: "check_ready_to_commit",
+      description:
+        "Check if all workflow steps are completed and you're ready to commit & push.",
+      inputSchema: {
+        type: "object",
+        properties: {},
+      },
+    },
+    {
+      name: "commit_and_push",
+      description:
+        "Automatically run git add, commit, and push once the ready check passes.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          commitMessage: {
+            type: "string",
+            description: "Commit message to use",
+          },
+          branch: {
+            type: "string",
+            description: "Optional branch name to push to (defaults to current branch)",
+          },
+        },
+        required: [],
+      },
+    },
+    {
+      name: "perform_release",
+      description:
+        "Record release details after committing and pushing your changes.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          command: {
+            type: "string",
+            description: "Release command that was executed",
+          },
+          notes: {
+            type: "string",
+            description: "Optional release notes",
+          },
+        },
+        required: ["command"],
+      },
+    },
+    {
+      name: "complete_task",
+      description:
+        "Mark the task as complete after successful commit & push. Resets workflow for next task.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          commitMessage: {
+            type: "string",
+            description: "The commit message used",
+          },
+        },
+        required: ["commitMessage"],
+      },
+    },
+    {
+      name: "drop_task",
+      description:
+        "Abandon the current task and reset the workflow without completing it.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          reason: {
+            type: "string",
+            description: "Optional explanation for dropping the task",
+          },
+        },
+      },
+    },
+    {
+      name: "get_workflow_status",
+      description: "Get current workflow status and what needs to be done next.",
+      inputSchema: {
+        type: "object",
+        properties: {},
+      },
+    },
+    {
+      name: "view_history",
+      description: "View workflow history of completed tasks.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          limit: {
+            type: "number",
+            description: "Number of recent tasks to show (default: 10)",
+          },
+        },
+      },
+    },
+    {
+      name: "continue_workflow",
+      description:
+        "Get guidance on the next workflow step. Automatically performs the ready check when appropriate.",
+      inputSchema: {
+        type: "object",
+        properties: {},
+      },
+    },
+  ];
+}