@tailor-platform/erp-kit 0.2.1 → 0.3.0

package/src/commands/module/generate.ts

@@ -2,34 +2,54 @@ import path from "node:path";
 import { defineCommand, arg } from "politty";
 import { z } from "zod";
 import { runGenerateCode } from "../../generator/generate-code";
+import { runGenerateDoc, MODULE_DOC_TYPES, type DocType } from "../generate-doc";
 
 const cwd = process.cwd();
 
-const codeCommand = defineCommand({
-  name: "code",
-  description: "Generate errors, permissions, command shells, and query shells from docs",
-  args: z.object({
-    root: arg(z.string(), {
-      alias: "r",
-      description: "Path to modules directory",
+const pathArgs = z.object({
+  path: arg(z.string(), {
+    alias: "p",
+    description: "Path to the module directory",
+  }),
+});
+
+const docCommand = defineCommand({
+  name: "doc",
+  description: "Create a documentation file from a schema template",
+  args: pathArgs.extend({
+    type: arg(z.enum(MODULE_DOC_TYPES as unknown as [string, ...string[]]), {
+      positional: true,
+      description: `Doc type (${MODULE_DOC_TYPES.join(", ")})`,
     }),
-    module: arg(z.string(), {
+    name: arg(z.string().optional(), {
       positional: true,
-      description: "Module name (e.g., primitives, item-management)",
+      description: "Item name (required for all types)",
     }),
   }),
+  run: async (args) => {
+    const exitCode = await runGenerateDoc(args.type as DocType, args.name, args.path, cwd);
+    process.exit(exitCode);
+  },
+});
+
+const codeCommand = defineCommand({
+  name: "code",
+  description: "Generate boilerplate, implementation stubs, and generated code from docs",
+  args: pathArgs,
   run: (args) => {
-    const modulePath = path.resolve(cwd, args.root, args.module);
-    console.log(`Generating code for ${args.module}...`);
-    const exitCode = runGenerateCode(modulePath, args.module);
+    const modulePath = path.resolve(cwd, args.path);
+    const moduleName = path.basename(modulePath);
+    console.log(`Generating code for ${moduleName}...`);
+    const exitCode = runGenerateCode(modulePath, moduleName);
     process.exit(exitCode);
   },
 });
 
 export const generateCommand = defineCommand({
   name: "generate",
-  description: "Generate code from model definitions and docs",
+  description: "Generate docs and code for a module",
   subCommands: {
+    doc: docCommand,
     code: codeCommand,
   },
 });

package/src/commands/module/index.ts

@@ -1,16 +1,16 @@
 import { z } from "zod";
 import { defineCommand, arg } from "politty";
 import { runCheck } from "../check";
+import { runInitModuleWithReadme } from "../init-module";
 import { runSyncCheck, formatSyncCheckReport } from "../sync-check";
-import { runScaffold, MODULE_TYPES, type ScaffoldType } from "../scaffold";
-import { runModuleList } from "./list";
 import { generateCommand } from "./generate";
+import { runModuleList } from "./list";
 
 const cwd = process.cwd();
 
-const rootArgs = z.object({
-  root: arg(z.string(), {
-    alias: "r",
+const pathArgs = z.object({
+  path: arg(z.string(), {
+    alias: "p",
     description: "Path to modules directory",
   }),
 });
@@ -27,9 +27,9 @@ const listCommand = defineCommand({
 const checkCommand = defineCommand({
   name: "check",
   description: "Validate module docs against schemas",
-  args: rootArgs,
+  args: pathArgs,
   run: async (args) => {
-    const exitCode = await runCheck({ modulesRoot: args.root }, cwd);
+    const exitCode = await runCheck({ modulesRoot: args.path }, cwd);
     process.exit(exitCode);
   },
 });
@@ -37,39 +37,29 @@ const checkCommand = defineCommand({
 const syncCheckCommand = defineCommand({
   name: "sync-check",
   description: "Validate source <-> doc correspondence",
-  args: rootArgs,
+  args: pathArgs,
   run: async (args) => {
-    const result = await runSyncCheck({ modulesRoot: args.root }, cwd);
+    const result = await runSyncCheck({ modulesRoot: args.path }, cwd);
     console.log(formatSyncCheckReport(result));
     process.exit(result.exitCode);
   },
 });
 
-const scaffoldCommand = defineCommand({
-  name: "scaffold",
-  description: "Generate module doc from schema template",
-  args: rootArgs.extend({
-    type: arg(z.enum(MODULE_TYPES as unknown as [string, ...string[]]), {
-      positional: true,
-      description: `Scaffold type (${MODULE_TYPES.join(", ")})`,
-    }),
-    parent: arg(z.string(), {
+const initCommand = defineCommand({
+  name: "init",
+  description: "Bootstrap a new module with directory structure and README",
+  args: z.object({
+    name: arg(z.string(), {
       positional: true,
       description: "Module name",
     }),
-    name: arg(z.string().optional(), {
+    dir: arg(z.string(), {
       positional: true,
-      description: "Item name (required for feature, command, model)",
+      description: "Parent directory where the module will be created",
     }),
   }),
   run: async (args) => {
-    const exitCode = await runScaffold(
-      args.type as ScaffoldType,
-      args.parent,
-      args.name,
-      args.root,
-      cwd,
-    );
+    const exitCode = await runInitModuleWithReadme(args.name, args.dir, cwd);
     process.exit(exitCode);
   },
 });
@@ -81,7 +71,7 @@ export const moduleCommand = defineCommand({
     list: listCommand,
     check: checkCommand,
     "sync-check": syncCheckCommand,
-    scaffold: scaffoldCommand,
+    init: initCommand,
     generate: generateCommand,
   },
 });

package/src/commands/parse-doc-test-cases.ts

@@ -0,0 +1,55 @@
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { toString } from "mdast-util-to-string";
+import type { Heading, List, RootContent } from "mdast";
+
+function isHeading(node: RootContent): node is Heading {
+  return node.type === "heading";
+}
+
+function isList(node: RootContent): node is List {
+  return node.type === "list";
+}
+
+/**
+ * Parse test case descriptions from the `## Test Cases` section of a Markdown doc.
+ * Uses mdast to traverse the AST instead of string matching.
+ */
+export function parseTestCasesFromDoc(markdown: string): string[] {
+  const tree = fromMarkdown(markdown);
+  const cases: string[] = [];
+  let collecting = false;
+
+  for (const node of tree.children) {
+    if (isHeading(node)) {
+      if (collecting) break;
+      if (node.depth === 2 && toString(node) === "Test Cases") {
+        collecting = true;
+        continue;
+      }
+    }
+    if (collecting && isList(node)) {
+      for (const item of node.children) {
+        const text = toString(item).trim();
+        if (text) {
+          cases.push(text);
+        }
+      }
+    }
+  }
+
+  return cases;
+}
+
+/**
+ * Parse `it("...")` descriptions from a test file using regex.
+ * Test files are not Markdown, so regex is appropriate here.
+ */
+export function parseItDescriptionsFromTest(content: string): string[] {
+  const descriptions: string[] = [];
+  const regex = /\bit\(\s*["'`]([^"'`]+)["'`]/g;
+  let match: RegExpExecArray | null;
+  while ((match = regex.exec(content)) !== null) {
+    descriptions.push(match[1]);
+  }
+  return descriptions;
+}

package/src/commands/sync-check.test.ts

@@ -3,6 +3,7 @@ import os from "node:os";
 import fs from "node:fs";
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { runSyncCheck, checkStaleness } from "./sync-check";
+import { parseTestCasesFromDoc, parseItDescriptionsFromTest } from "./parse-doc-test-cases";
 
 describe("runSyncCheck", () => {
   let tmpDir: string;
@@ -178,6 +179,178 @@ describe("runSyncCheck", () => {
   });
 });
 
+describe("parseTestCasesFromDoc", () => {
+  it("extracts test cases from ## Test Cases section", () => {
+    const content = `# CreateProduct
+
+## Error Scenarios
+
+- **DUPLICATE_CODE**: A product with the same code already exists
+
+## Test Cases
+
+- returns error when code is empty
+- creates product in DRAFT status
+- passes custom fields through
+`;
+    const cases = parseTestCasesFromDoc(content);
+    expect(cases).toEqual([
+      "returns error when code is empty",
+      "creates product in DRAFT status",
+      "passes custom fields through",
+    ]);
+  });
+
+  it("returns empty array when no Test Cases section", () => {
+    const content = `# CreateProduct\n\n## Overview\n\nSome text.`;
+    expect(parseTestCasesFromDoc(content)).toEqual([]);
+  });
+
+  it("stops at next ## heading", () => {
+    const content = `## Test Cases
+
+- case one
+- case two
+
+## Other Section
+
+- not a test case
+`;
+    expect(parseTestCasesFromDoc(content)).toEqual(["case one", "case two"]);
+  });
+});
+
+describe("parseItDescriptionsFromTest", () => {
+  it("extracts it() descriptions from test file", () => {
+    const content = `
+describe("createProduct", () => {
+  it("returns error when code is empty", async () => {});
+  it("creates product in DRAFT status", async () => {});
+  it('passes custom fields through', async () => {});
+});`;
+    const descriptions = parseItDescriptionsFromTest(content);
+    expect(descriptions).toEqual([
+      "returns error when code is empty",
+      "creates product in DRAFT status",
+      "passes custom fields through",
+    ]);
+  });
+
+  it("returns empty array when no it() blocks", () => {
+    expect(parseItDescriptionsFromTest("const x = 1;")).toEqual([]);
+  });
+});
+
+describe("runSyncCheck test-case sync", () => {
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "sync-check-tc-"));
+  });
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it("reports missing-test-case when doc has case not in test", async () => {
+    const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
+    const testDir = path.join(tmpDir, "modules", "foo", "command");
+    fs.mkdirSync(docDir, { recursive: true });
+    fs.mkdirSync(testDir, { recursive: true });
+
+    fs.writeFileSync(
+      path.join(docDir, "CreateOrder.md"),
+      "# CreateOrder\n\n## Test Cases\n\n- creates order\n- validates input\n",
+    );
+    fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
+    fs.writeFileSync(
+      path.join(testDir, "createOrder.test.ts"),
+      'describe("createOrder", () => { it("creates order", async () => {}); });',
+    );
+
+    const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
+    expect(result.errors).toContainEqual(
+      expect.objectContaining({
+        type: "missing-test-case",
+        category: "command-test-case",
+        expectedBasename: "validates input",
+      }),
+    );
+  });
+
+  it("reports extra-test-case when test has case not in doc", async () => {
+    const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
+    const testDir = path.join(tmpDir, "modules", "foo", "command");
+    fs.mkdirSync(docDir, { recursive: true });
+    fs.mkdirSync(testDir, { recursive: true });
+
+    fs.writeFileSync(
+      path.join(docDir, "CreateOrder.md"),
+      "# CreateOrder\n\n## Test Cases\n\n- creates order\n",
+    );
+    fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
+    fs.writeFileSync(
+      path.join(testDir, "createOrder.test.ts"),
+      'describe("createOrder", () => { it("creates order", async () => {}); it("extra case", async () => {}); });',
+    );
+
+    const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
+    expect(result.errors).toContainEqual(
+      expect.objectContaining({
+        type: "extra-test-case",
+        category: "command-test-case",
+        expectedBasename: "extra case",
+      }),
+    );
+  });
+
+  it("returns 0 when doc test cases match test it() descriptions", async () => {
+    const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
+    const testDir = path.join(tmpDir, "modules", "foo", "command");
+    fs.mkdirSync(docDir, { recursive: true });
+    fs.mkdirSync(testDir, { recursive: true });
+
+    fs.writeFileSync(
+      path.join(docDir, "CreateOrder.md"),
+      "# CreateOrder\n\n## Test Cases\n\n- creates order\n- validates input\n",
+    );
+    fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
+    fs.writeFileSync(
+      path.join(testDir, "createOrder.test.ts"),
+      'describe("createOrder", () => { it("creates order", async () => {}); it("validates input", async () => {}); });',
+    );
+
+    const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
+    const tcErrors = result.errors.filter(
+      (e) => e.type === "missing-test-case" || e.type === "extra-test-case",
+    );
+    expect(tcErrors).toHaveLength(0);
+  });
+
+  it("skips test-case check when doc has no Test Cases section", async () => {
+    const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
+    const testDir = path.join(tmpDir, "modules", "foo", "command");
+    fs.mkdirSync(docDir, { recursive: true });
+    fs.mkdirSync(testDir, { recursive: true });
+
+    fs.writeFileSync(
+      path.join(docDir, "CreateOrder.md"),
+      "# CreateOrder\n\n## Overview\n\nSome text.\n",
+    );
+    fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
+    fs.writeFileSync(
+      path.join(testDir, "createOrder.test.ts"),
+      'describe("createOrder", () => { it("creates order", async () => {}); });',
+    );
+
+    const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
+    const tcErrors = result.errors.filter(
+      (e) => e.type === "missing-test-case" || e.type === "extra-test-case",
+    );
+    expect(tcErrors).toHaveLength(0);
+  });
+});
+
 describe("checkStaleness", () => {
   it("reports stale when doc mtime > generated mtime", () => {
     const errors = checkStaleness(

package/src/commands/sync-check.ts

@@ -1,6 +1,8 @@
 import path from "node:path";
+import fs from "node:fs";
 import fg from "fast-glob";
 import chalk from "chalk";
+import { parseTestCasesFromDoc, parseItDescriptionsFromTest } from "./parse-doc-test-cases";
 
 interface CategoryConfig {
   name: string;
@@ -10,7 +12,7 @@ interface CategoryConfig {
 }
 
 export interface CheckError {
-  type: "missing-doc" | "orphaned-doc";
+  type: "missing-doc" | "orphaned-doc" | "missing-test-case" | "extra-test-case";
   category: string;
   sourcePath?: string;
   docPath?: string;
@@ -129,6 +131,11 @@ export async function runSyncCheck(
     totalDocs += docBasenames.size;
   }
 
+  if (config.modulesRoot) {
+    const testCaseErrors = await runTestCaseSyncCheck(config.modulesRoot, cwd);
+    errors.push(...testCaseErrors);
+  }
+
   return {
     exitCode: errors.length > 0 ? 1 : 0,
     errors,
@@ -140,6 +147,90 @@ export async function runSyncCheck(
   };
 }
 
+interface TestCaseCategoryConfig {
+  name: string;
+  docPattern: string;
+  testDir: string;
+}
+
+function testCaseCategories(root: string): TestCaseCategoryConfig[] {
+  return [
+    {
+      name: "command-test-case",
+      docPattern: `${root}/*/docs/commands/*.md`,
+      testDir: "command",
+    },
+    {
+      name: "query-test-case",
+      docPattern: `${root}/*/docs/queries/*.md`,
+      testDir: "query",
+    },
+  ];
+}
+
+function toCamelCase(pascalCase: string): string {
+  return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
+}
+
+async function runTestCaseSyncCheck(root: string, cwd: string): Promise<CheckError[]> {
+  const errors: CheckError[] = [];
+  const categories = testCaseCategories(root);
+
+  for (const category of categories) {
+    const docPaths = await fg(category.docPattern, { cwd });
+
+    for (const docPath of docPaths) {
+      const docFullPath = path.join(cwd, docPath);
+      const docContent = fs.readFileSync(docFullPath, "utf-8");
+      const docTestCases = parseTestCasesFromDoc(docContent);
+
+      if (docTestCases.length === 0) continue;
+
+      const docBasename = path.basename(docPath, ".md");
+      const docsIndex = docPath.indexOf("/docs/");
+      if (docsIndex === -1) continue;
+      const modulePath = docPath.substring(0, docsIndex);
+      const testFileName = `${toCamelCase(docBasename)}.test.ts`;
+      const testPath = path.join(modulePath, category.testDir, testFileName);
+      const testFullPath = path.join(cwd, testPath);
+
+      if (!fs.existsSync(testFullPath)) continue;
+
+      const testContent = fs.readFileSync(testFullPath, "utf-8");
+      const itDescriptions = parseItDescriptionsFromTest(testContent);
+
+      const docSet = new Set(docTestCases);
+      const testSet = new Set(itDescriptions);
+
+      for (const docCase of docSet) {
+        if (!testSet.has(docCase)) {
+          errors.push({
+            type: "missing-test-case",
+            category: category.name,
+            docPath,
+            sourcePath: testPath,
+            expectedBasename: docCase,
+          });
+        }
+      }
+
+      for (const testCase of testSet) {
+        if (!docSet.has(testCase)) {
+          errors.push({
+            type: "extra-test-case",
+            category: category.name,
+            docPath,
+            sourcePath: testPath,
+            expectedBasename: testCase,
+          });
+        }
+      }
+    }
+  }
+
+  return errors;
+}
+
 export interface StalenessError {
   type: "stale-generation";
   docPath: string;
@@ -188,11 +279,21 @@ export function formatSyncCheckReport(result: SyncCheckResult): string {
         if (error.type === "missing-doc") {
           lines.push(`  ${chalk.red(error.sourcePath)}`);
           lines.push(`    ${chalk.yellow("Missing documentation for:")} ${error.expectedBasename}`);
-        } else {
+        } else if (error.type === "orphaned-doc") {
           lines.push(`  ${chalk.red(error.docPath)}`);
           lines.push(
             `    ${chalk.yellow("Orphaned documentation:")} no source file for ${error.expectedBasename}`,
           );
+        } else if (error.type === "missing-test-case") {
+          lines.push(`  ${chalk.red(error.sourcePath)}`);
+          lines.push(
+            `    ${chalk.yellow("Missing test case:")} "${error.expectedBasename}" is in doc but not in test`,
+          );
+        } else if (error.type === "extra-test-case") {
+          lines.push(`  ${chalk.red(error.sourcePath)}`);
+          lines.push(
+            `    ${chalk.yellow("Extra test case:")} "${error.expectedBasename}" is in test but not in doc`,
+          );
         }
         lines.push("");
       }

package/src/commands/update.test.ts

@@ -0,0 +1,87 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import { runUpdate } from "./update";
+
+describe("runUpdate", () => {
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "update-test-"));
+  });
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it("updates skills and workflows by default", () => {
+    const exitCode = runUpdate(tmpDir, []);
+    expect(exitCode).toBe(0);
+
+    const skillPath = path.join(
+      tmpDir,
+      ".agents",
+      "skills",
+      "erp-kit-module-1-requirements",
+      "SKILL.md",
+    );
+    expect(fs.existsSync(skillPath)).toBe(true);
+
+    const wfPath = path.join(tmpDir, ".github", "workflows", "erp-kit-check.yml");
+    expect(fs.existsSync(wfPath)).toBe(true);
+  });
+
+  it("updates only skills when specified", () => {
+    const exitCode = runUpdate(tmpDir, ["skills"]);
+    expect(exitCode).toBe(0);
+
+    const skillPath = path.join(
+      tmpDir,
+      ".agents",
+      "skills",
+      "erp-kit-module-1-requirements",
+      "SKILL.md",
+    );
+    expect(fs.existsSync(skillPath)).toBe(true);
+
+    const wfPath = path.join(tmpDir, ".github", "workflows", "erp-kit-check.yml");
+    expect(fs.existsSync(wfPath)).toBe(false);
+  });
+
+  it("updates only workflows when specified", () => {
+    const exitCode = runUpdate(tmpDir, ["workflows"]);
+    expect(exitCode).toBe(0);
+
+    const skillsDest = path.join(tmpDir, ".agents", "skills");
+    expect(fs.existsSync(skillsDest)).toBe(false);
+
+    const wfPath = path.join(tmpDir, ".github", "workflows", "erp-kit-check.yml");
+    expect(fs.existsSync(wfPath)).toBe(true);
+  });
+
+  it("removes stale skills and replaces with current", () => {
+    const staleDir = path.join(tmpDir, ".agents", "skills", "erp-kit-old-skill");
+    fs.mkdirSync(staleDir, { recursive: true });
+    fs.writeFileSync(path.join(staleDir, "SKILL.md"), "# Stale");
+    runUpdate(tmpDir, ["skills"]);
+    expect(fs.existsSync(staleDir)).toBe(false);
+  });
+
+  it("overwrites existing workflows", () => {
+    const wfDir = path.join(tmpDir, ".github", "workflows");
+    fs.mkdirSync(wfDir, { recursive: true });
+    fs.writeFileSync(path.join(wfDir, "erp-kit-check.yml"), "# Old");
+    runUpdate(tmpDir, ["workflows"]);
+    const content = fs.readFileSync(path.join(wfDir, "erp-kit-check.yml"), "utf-8");
+    expect(content).toContain("@tailor-platform/erp-kit");
+  });
+
+  it("never touches config files", () => {
+    const configPath = path.join(tmpDir, "license.config.json");
+    fs.writeFileSync(configPath, '{"groups": ["notice"]}');
+    runUpdate(tmpDir, []);
+    const config = JSON.parse(fs.readFileSync(configPath, "utf-8")) as { groups: string[] };
+    expect(config.groups).toEqual(["notice"]);
+  });
+});

package/src/commands/update.ts

@@ -0,0 +1,41 @@
+import chalk from "chalk";
+import { copySkills, copyWorkflows } from "./lib/distribute";
+
+export const VALID_RESOURCES = ["skills", "workflows"] as const;
+export type Resource = (typeof VALID_RESOURCES)[number];
+
+export function runUpdate(cwd: string, resources: string[]): number {
+  console.log(chalk.bold("erp-kit update\n"));
+
+  const selected: Set<Resource> =
+    resources.length === 0
+      ? new Set(VALID_RESOURCES)
+      : new Set(
+          resources.filter((r): r is Resource =>
+            (VALID_RESOURCES as readonly string[]).includes(r),
+          ),
+        );
+
+  if (selected.size === 0) {
+    console.error(chalk.red(`Invalid resource. Valid: ${VALID_RESOURCES.join(", ")}`));
+    return 1;
+  }
+
+  if (selected.has("skills")) {
+    const result = copySkills(cwd);
+    if (result.removed > 0) {
+      console.log(chalk.green(`  Removed ${result.removed} stale erp-kit-* skills`));
+    }
+    console.log(chalk.green(`  Copied ${result.copied} skill files to .agents/skills/`));
+  }
+
+  if (selected.has("workflows")) {
+    const result = copyWorkflows(cwd);
+    if (result.copied > 0) {
+      console.log(chalk.green(`  Copied ${result.copied} workflow(s) to .github/workflows/`));
+    }
+  }
+
+  console.log(chalk.bold.green("\nDone!"));
+  return 0;
+}