speckeeper 0.2.1 → 0.3.0

package/README.md

@@ -69,21 +69,23 @@ npx speckeeper scaffold --source requirements.md
 
 This generates:
 - `design/_models/` — Model classes with Zod schemas, lint rules, and exporters derived from your flowchart
+- `design/*.ts` — Spec data files using `defineSpecs()` for each model
+- `design/index.ts` — Entry point that aggregates all spec modules via `mergeSpecs()`
 - `design/_checkers/` — External checker skeletons for `implements` edges (e.g. OpenAPI, DDL)
-- `design/_models/index.ts` — Re-exports and `allModels` array
-- `speckeeper.config.ts` — Configuration wired to the generated models
 
 See [Scaffold Mermaid Specification](./docs/scaffold-mermaid-spec.md) for the full input format and built-in node mappings.
 
 ### 3. Fill in your specifications
 
-Edit files in `design/` to add your actual specification data:
+Edit spec data files in `design/` to add your actual specification data. Each file uses `defineSpecs()` to pair Model instances with data:
 
 ```typescript
 // design/requirements.ts
-import type { Requirement } from 'speckeeper';
+import { defineSpecs } from 'speckeeper';
+import type { Requirement } from './_models/requirement';
+import { FunctionalRequirementModel } from './_models/requirement';
 
-export const requirements: Requirement[] = [
+const requirements: Requirement[] = [
   {
     id: 'FR-001',
     name: 'User Authentication',
@@ -96,8 +98,14 @@ export const requirements: Requirement[] = [
     ],
   },
 ];
+
+export default defineSpecs(
+  [FunctionalRequirementModel.instance, requirements],
+);
 ```
 
+`design/index.ts` aggregates all spec files, and `speckeeper.config.ts` imports the result — no manual wiring needed beyond adding your spec file to `design/index.ts`.
+
 ### 4. Run validation
 
 ```bash

package/dist/cli.js

@@ -152,6 +152,12 @@ function findModelTypeBySpecId(specId) {
   }
   return null;
 }
+function registerSpecsFromConfig(specs) {
+  if (!specs) return;
+  for (const entry of specs) {
+    entry.model.register(entry.data);
+  }
+}
 
 // src/cli/build.ts
 async function buildCommand(options) {
@@ -166,6 +172,7 @@ async function buildCommand(options) {
   try {
     console.log(chalk4.blue("  Loading models..."));
     registerModelsFromConfig(config.models || []);
+    registerSpecsFromConfig(config.specs);
     console.log("");
     ensureDir(join(cwd, config.docsDir));
     ensureDir(join(cwd, config.specsDir));
@@ -243,6 +250,7 @@ async function lintCommand(options) {
   try {
     console.log(chalk4.blue("  Loading models..."));
     registerModelsFromConfig(config.models || []);
+    registerSpecsFromConfig(config.specs);
     const models = getAllModels();
     console.log(chalk4.gray(`  Loaded: ${models.length} models`));
     console.log("");
@@ -325,6 +333,7 @@ async function driftCommand(options) {
   try {
     console.log(chalk4.blue("  Loading models..."));
     registerModelsFromConfig(config.models || []);
+    registerSpecsFromConfig(config.specs);
     const results = [];
     const models = getAllModels();
     for (const model of models) {
@@ -416,6 +425,7 @@ async function checkCommand(type, options) {
   try {
     console.log(chalk4.blue("  Loading models..."));
     registerModelsFromConfig(config.models || []);
+    registerSpecsFromConfig(config.specs);
     const results = [];
     const models = getAllModels();
     if (options.verbose) {
@@ -654,6 +664,7 @@ async function impactCommand(targetId, options) {
   try {
     console.log(chalk4.blue("  Loading models..."));
     registerModelsFromConfig(config.models || []);
+    registerSpecsFromConfig(config.specs);
     const store = getSpecStore();
     const targetType = findModelTypeBySpecId(targetId);
     if (!targetType) {
@@ -772,14 +783,14 @@ async function runInit(options = {}) {
   console.log("  Next steps:");
   if (packageJsonCreated) {
     console.log(chalk4.gray("    1. Run `npm install` to install dependencies"));
-    console.log(chalk4.gray("    2. Edit design/_models/ to customize your models"));
-    console.log(chalk4.gray("    3. Add specifications in design/"));
+    console.log(chalk4.gray("    2. Add spec data in design/*.ts using defineSpecs()"));
+    console.log(chalk4.gray("    3. Import new spec files in design/index.ts"));
     console.log(chalk4.gray("    4. Run `npx speckeeper lint` to validate"));
   } else {
     console.log(chalk4.gray("    1. Add speckeeper and zod to your package.json dependencies"));
     console.log(chalk4.gray('    2. Ensure "type": "module" is set in package.json'));
-    console.log(chalk4.gray("    3. Edit design/_models/ to customize your models"));
-    console.log(chalk4.gray("    4. Add specifications in design/"));
+    console.log(chalk4.gray("    3. Add spec data in design/*.ts using defineSpecs()"));
+    console.log(chalk4.gray("    4. Import new spec files in design/index.ts"));
     console.log(chalk4.gray("    5. Run `npx speckeeper lint` to validate"));
   }
 }
@@ -2271,14 +2282,17 @@ function generateSpecDataFile(node) {
  *
  * Generated by speckeeper scaffold \u2014 add your specs below.
  */
+import { defineSpecs } from 'speckeeper';
 import type { ${typeName} } from './_models/${fileName}';
 import { ${className} } from './_models/${fileName}';
 
-export const ${varName}: ${typeName}[] = [
+const ${varName}: ${typeName}[] = [
   // { id: '${templateInfo.defaultIdPrefix}-001', name: '...', description: '...' },
 ];
 
-${className}.instance.register(${varName});
+export default defineSpecs(
+  [${className}.instance, ${varName}],
+);
 `;
   return {
     relativePath: `${fileName}.ts`,
@@ -2288,6 +2302,34 @@ ${className}.instance.register(${varName});
 function toCamelCase3(pascalCase) {
   return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
 }
+function generateDesignIndex(speckeeperNodes) {
+  const generated = /* @__PURE__ */ new Set();
+  const specFiles = [];
+  for (const node of speckeeperNodes) {
+    const templateInfo = resolveModelTemplate(node.id);
+    const key = templateInfo.templateName === "base" ? `base:${node.id}` : templateInfo.templateName;
+    if (generated.has(key)) continue;
+    generated.add(key);
+    specFiles.push({
+      varName: toCamelCase3(templateInfo.modelName),
+      fileName: templateInfo.fileName
+    });
+  }
+  const imports = specFiles.map((f) => `import ${f.varName} from './${f.fileName}';`).join("\n");
+  const args = specFiles.map((f) => f.varName).join(", ");
+  const content = `/**
+ * Design entry point \u2014 generated by speckeeper scaffold
+ */
+import { mergeSpecs } from 'speckeeper';
+${imports}
+
+export default mergeSpecs(${args});
+`;
+  return {
+    relativePath: "index.ts",
+    content
+  };
+}
 function generateAllModelFiles(speckeeperNodes, resolvedEdges) {
   const files = [];
   const generated = /* @__PURE__ */ new Set();
@@ -2301,6 +2343,7 @@ function generateAllModelFiles(speckeeperNodes, resolvedEdges) {
     files.push(generateModelFile(node));
     files.push(generateSpecDataFile(node));
   }
+  files.push(generateDesignIndex(speckeeperNodes));
   return files;
 }