@tailor-platform/erp-kit 0.2.2 → 0.4.0

package/templates/workflows/erp-kit-check.yml

@@ -28,10 +28,10 @@ jobs:
       - run: pnpm install --frozen-lockfile
 
       - name: Validate app documentation
-        run: npx @tailor-platform/erp-kit app check --root .
+        run: npx @tailor-platform/erp-kit app check --path .
 
       - name: Validate source-doc correspondence
-        run: npx @tailor-platform/erp-kit app sync-check --root .
+        run: npx @tailor-platform/erp-kit app sync-check --path .
 
       - name: Check licenses
         run: npx @tailor-platform/erp-kit license check --config license.config.json

package/src/commands/module/list.test.ts

@@ -1,57 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { listModules, formatModuleList } from "./list";
-
-describe("listModules", () => {
-  it("returns the built-in modules with counts", () => {
-    const modules = listModules();
-    expect(modules.length).toBeGreaterThan(0);
-
-    const primitives = modules.find((m) => m.name === "primitives");
-    expect(primitives).toBeDefined();
-    expect(primitives!.commands).toBeGreaterThan(0);
-    expect(primitives!.models).toBeGreaterThan(0);
-    expect(primitives!.features).toBeGreaterThan(0);
-  });
-
-  it("returns zero counts for stub modules", () => {
-    const modules = listModules();
-    const inventory = modules.find((m) => m.name === "inventory");
-    expect(inventory).toBeDefined();
-    expect(inventory!.commands).toBe(0);
-    expect(inventory!.models).toBe(0);
-    expect(inventory!.features).toBe(0);
-  });
-
-  it("excludes shared and testing directories", () => {
-    const modules = listModules();
-    const names = modules.map((m) => m.name);
-    expect(names).not.toContain("shared");
-    expect(names).not.toContain("testing");
-  });
-
-  it("returns modules in alphabetical order", () => {
-    const modules = listModules();
-    const names = modules.map((m) => m.name);
-    const sorted = [...names].sort();
-    expect(names).toEqual(sorted);
-  });
-});
-
-describe("formatModuleList", () => {
-  it("formats modules with counts", () => {
-    const output = formatModuleList([
-      { name: "primitives", commands: 14, models: 4, features: 4 },
-      { name: "inventory", commands: 0, models: 0, features: 0 },
-    ]);
-    expect(output).toContain("primitives");
-    expect(output).toContain("14 commands");
-    expect(output).toContain("4 models");
-    expect(output).toContain("4 features");
-    expect(output).toContain("inventory");
-    expect(output).toContain("2 modules");
-  });
-
-  it("handles empty list", () => {
-    expect(formatModuleList([])).toBe("No modules found.");
-  });
-});

package/src/commands/module/list.ts

@@ -1,64 +0,0 @@
-import { readdirSync, existsSync } from "node:fs";
-import { join } from "node:path";
-import chalk from "chalk";
-import { PACKAGE_ROOT } from "../../util";
-
-const MODULES_DIR = join(PACKAGE_ROOT, "src", "modules");
-const EXCLUDED_DIRS = new Set(["shared", "testing"]);
-
-export interface ModuleInfo {
-  name: string;
-  commands: number;
-  models: number;
-  features: number;
-}
-
-function countFiles(dir: string, pattern: RegExp, exclusions: RegExp[]): number {
-  if (!existsSync(dir)) return 0;
-  return readdirSync(dir).filter((f) => pattern.test(f) && !exclusions.some((p) => p.test(f)))
-    .length;
-}
-
-export function listModules(): ModuleInfo[] {
-  if (!existsSync(MODULES_DIR)) return [];
-  return readdirSync(MODULES_DIR, { withFileTypes: true })
-    .filter((d) => d.isDirectory() && !EXCLUDED_DIRS.has(d.name))
-    .map((d) => {
-      const modDir = join(MODULES_DIR, d.name);
-      return {
-        name: d.name,
-        commands: countFiles(join(modDir, "command"), /\.ts$/, [/\.test\.ts$/]),
-        models: countFiles(join(modDir, "db"), /\.ts$/, [/\.test\.ts$/, /^index\.ts$/]),
-        features: countFiles(join(modDir, "docs", "features"), /\.md$/, []),
-      };
-    })
-    .sort((a, b) => a.name.localeCompare(b.name));
-}
-
-export function formatModuleList(modules: ModuleInfo[]): string {
-  if (modules.length === 0) return "No modules found.";
-
-  const lines: string[] = [];
-  lines.push(chalk.bold("Modules:\n"));
-
-  const nameWidth = Math.max(...modules.map((m) => m.name.length), 4);
-
-  for (const mod of modules) {
-    const counts = [
-      `${mod.commands} commands`,
-      `${mod.models} models`,
-      `${mod.features} features`,
-    ].join(", ");
-    lines.push(`  ${mod.name.padEnd(nameWidth)}  ${counts}`);
-  }
-
-  lines.push("");
-  lines.push(`${modules.length} modules`);
-  return lines.join("\n");
-}
-
-export function runModuleList(): number {
-  const modules = listModules();
-  console.log(formatModuleList(modules));
-  return 0;
-}

package/src/commands/scaffold.ts

@@ -1,176 +0,0 @@
-import path from "node:path";
-import fs from "node:fs";
-import { runMdschema } from "../mdschema";
-import { ALL_SCHEMAS } from "../schemas";
-import { PACKAGE_ROOT, readErpKitVersion } from "../util";
-
-export const MODULE_TYPES = ["module", "feature", "command", "model", "query"] as const;
-export const APP_TYPES = ["app", "actors", "business-flow", "story", "screen", "resolver"] as const;
-export const ALL_TYPES = [...MODULE_TYPES, ...APP_TYPES] as const;
-
-export type ScaffoldType = (typeof ALL_TYPES)[number];
-
-const MODULE_DIR_MAP: Record<string, string> = {
-  feature: "docs/features",
-  command: "docs/commands",
-  model: "docs/models",
-  query: "docs/queries",
-};
-
-const APP_DIR_MAP: Record<string, string> = {
-  actors: "docs/actors",
-  "business-flow": "docs/business-flow",
-  screen: "docs/screen",
-  resolver: "docs/resolver",
-};
-
-export function isModuleType(type: string): boolean {
-  return (MODULE_TYPES as readonly string[]).includes(type);
-}
-
-export function resolveScaffoldPath(
-  type: ScaffoldType,
-  parentName: string,
-  name: string | undefined,
-  root: string,
-): string {
-  // Types that map to README.md (no name needed)
-  if (type === "module" || type === "app") {
-    return path.join(root, parentName, "README.md");
-  }
-
-  if (!name) {
-    throw new Error(`Name is required for scaffold type "${type}"`);
-  }
-
-  // business-flow produces a README inside a named directory
-  if (type === "business-flow") {
-    return path.join(root, parentName, "docs/business-flow", name, "README.md");
-  }
-
-  // story accepts "flow/story-name" to place under the correct flow directory
-  if (type === "story") {
-    const parts = name.split("/");
-    if (parts.length !== 2) {
-      throw new Error(
-        `Story name must be "<flow>/<story>" (e.g., "onboarding/admin--create-user")`,
-      );
-    }
-    return path.join(root, parentName, "docs/business-flow", parts[0], "story", `${parts[1]}.md`);
-  }
-
-  // Module sub-types
-  if (MODULE_DIR_MAP[type]) {
-    return path.join(root, parentName, MODULE_DIR_MAP[type], `${name}.md`);
-  }
-
-  // App sub-types
-  if (APP_DIR_MAP[type]) {
-    return path.join(root, parentName, APP_DIR_MAP[type], `${name}.md`);
-  }
-
-  throw new Error(`Unknown scaffold type: ${type}`);
-}
-
-export async function runScaffold(
-  type: ScaffoldType,
-  parentName: string,
-  name: string | undefined,
-  root: string,
-  cwd: string,
-): Promise<number> {
-  const outputPath = resolveScaffoldPath(type, parentName, name, root);
-  const absoluteOutput = path.resolve(cwd, outputPath);
-
-  if (fs.existsSync(absoluteOutput)) {
-    console.error(`File already exists: ${outputPath}`);
-    return 1;
-  }
-
-  const schemaPath = ALL_SCHEMAS[type];
-  if (!schemaPath) {
-    console.error(`No schema found for type: ${type}`);
-    return 2;
-  }
-
-  try {
-    fs.mkdirSync(path.dirname(absoluteOutput), { recursive: true });
-  } catch (err) {
-    console.error(
-      `Failed to create directory: ${err instanceof Error ? err.message : String(err)}`,
-    );
-    return 1;
-  }
-
-  const { exitCode, stdout, stderr } = await runMdschema(
-    ["generate", "--schema", schemaPath, "--output", absoluteOutput],
-    cwd,
-  );
-
-  if (stdout.trim()) console.log(stdout);
-  if (stderr.trim()) console.error(stderr);
-
-  if (exitCode !== 0) return exitCode;
-
-  if (type === "module") {
-    scaffoldModuleSrc(path.dirname(absoluteOutput), parentName);
-  }
-
-  if (type === "app") {
-    scaffoldAppSrc(path.dirname(absoluteOutput), parentName);
-  }
-
-  return exitCode;
-}
-
-// npm renames .gitignore → .npmignore during pack (npm/cli#5756).
-// prepack copies .gitignore → __dot__gitignore to preserve it.
-export function copyTemplateDir(
-  srcDir: string,
-  destDir: string,
-  replacements: Record<string, string>,
-  placeholderFiles: Set<string>,
-): void {
-  for (const entry of fs.readdirSync(srcDir, { withFileTypes: true })) {
-    const srcPath = path.join(srcDir, entry.name);
-    const destName = entry.name === "__dot__gitignore" ? ".gitignore" : entry.name;
-    const destPath = path.join(destDir, destName);
-
-    if (entry.isDirectory()) {
-      fs.mkdirSync(destPath, { recursive: true });
-      copyTemplateDir(srcPath, destPath, replacements, placeholderFiles);
-    } else {
-      fs.mkdirSync(path.dirname(destPath), { recursive: true });
-      if (placeholderFiles.has(entry.name)) {
-        // Replace placeholders (e.g. "template-module" → actual name)
-        let content = fs.readFileSync(srcPath, "utf-8");
-        for (const [from, to] of Object.entries(replacements)) {
-          content = content.replaceAll(from, to);
-        }
-        fs.writeFileSync(destPath, content);
-      } else {
-        fs.copyFileSync(srcPath, destPath);
-      }
-    }
-  }
-}
-
-export function scaffoldModuleSrc(moduleDir: string, moduleName: string): void {
-  const templateDir = path.join(PACKAGE_ROOT, "templates", "scaffold", "module");
-  const replacements = { "template-module": moduleName };
-  const placeholderFiles = new Set(["permissions.ts", "tailor.config.ts"]);
-  copyTemplateDir(templateDir, moduleDir, replacements, placeholderFiles);
-}
-
-export function scaffoldAppSrc(appDir: string, appName: string): void {
-  const templateDir = path.join(PACKAGE_ROOT, "templates", "scaffold", "app");
-  const erpKitVersion = readErpKitVersion();
-  const replacements = {
-    "template-app-frontend": `${appName}-frontend`,
-    "template-app-backend": appName,
-    "template-app": appName,
-    '"workspace:*"': `"${erpKitVersion}"`,
-  };
-  const placeholderFiles = new Set(["package.json", "tailor.config.ts", "index.html"]);
-  copyTemplateDir(templateDir, appDir, replacements, placeholderFiles);
-}