create-sdd-project 0.16.10 → 0.17.0

package/lib/doctor.js

@@ -79,6 +79,9 @@ function runDoctor(cwd) {
   // 14. AGENTS.md Standards References (v0.16.10)
   results.push(checkAgentsMdStandardsRefs(cwd));
 
+  // 15. .sdd-meta.json structural integrity (v0.17.0)
+  results.push(checkMetaJson(cwd, aiTools, projectType));
+
   return results;
 }
 
@@ -1013,6 +1016,151 @@ function checkAgentsMdStandardsRefs(cwd) {
   };
 }
 
+/**
+ * Check #15 (v0.17.0): .sdd-meta.json structural integrity.
+ *
+ * v0.17.0 introduces content-addressable hashing via .sdd-meta.json to
+ * track "the last time the tool wrote this file". The upgrade path uses
+ * the hashes to answer "did the user edit since last tool-write" without
+ * comparing against the new template's adapted output (which would drift
+ * across versions — the Codex P1 from v0.16.10 cross-model review).
+ *
+ * This doctor check validates the METADATA STRUCTURE ONLY:
+ *   - Valid JSON
+ *   - schemaVersion ≤ current
+ *   - hashes is a sensible object shape
+ *   - Every hash value matches sha256:<64 hex>
+ *   - Every key that's NOT in the expected set is flagged as orphan
+ *
+ * It does NOT validate hashes against current on-disk content (Codex M3
+ * from plan v1.0 review). Hash mismatches are the EXPECTED result of
+ * legitimate user customization; reporting them here would generate
+ * permanent noise and bury real integrity issues.
+ *
+ * Severity:
+ *   - File absent → PASS with informational message (pre-v0.17.0 project)
+ *   - Present and valid → PASS
+ *   - Parse/shape errors → WARN (not FAIL — upgrade still falls back safely)
+ *   - Orphan entries → WARN (non-fatal, upgrade prunes them next run)
+ */
+function checkMetaJson(cwd, aiTools, projectType) {
+  const metaPath = path.join(cwd, '.sdd-meta.json');
+  if (!fs.existsSync(metaPath)) {
+    return {
+      status: PASS,
+      message: 'Provenance metadata: not present (pre-v0.17.0 project or fresh install)',
+      details: [],
+    };
+  }
+
+  let raw;
+  try {
+    raw = fs.readFileSync(metaPath, 'utf8');
+  } catch (e) {
+    return {
+      status: WARN,
+      message: '.sdd-meta.json: unreadable',
+      details: [e.code || e.message],
+    };
+  }
+
+  let parsed;
+  try {
+    parsed = JSON.parse(raw);
+  } catch (e) {
+    return {
+      status: WARN,
+      message: '.sdd-meta.json: invalid JSON',
+      details: [e.message, 'Next upgrade will regenerate it via the fallback path.'],
+    };
+  }
+
+  if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
+    return {
+      status: WARN,
+      message: '.sdd-meta.json: root is not an object',
+      details: ['Next upgrade will regenerate it.'],
+    };
+  }
+
+  // Validate schemaVersion. Absent = v1 (forward-compat). Newer than
+  // supported = still WARN (fallback path handles it).
+  const {
+    CURRENT_SCHEMA_VERSION,
+    expectedSmartDiffTrackedPaths,
+  } = require('./meta');
+  const schemaVersion = parsed.schemaVersion ?? 1;
+  if (typeof schemaVersion !== 'number' || schemaVersion < 1) {
+    return {
+      status: WARN,
+      message: `.sdd-meta.json: invalid schemaVersion ${schemaVersion}`,
+      details: [],
+    };
+  }
+  if (schemaVersion > CURRENT_SCHEMA_VERSION) {
+    return {
+      status: WARN,
+      message: `.sdd-meta.json: schemaVersion ${schemaVersion} newer than supported ${CURRENT_SCHEMA_VERSION}`,
+      details: ['Upgrade the sdd-devflow CLI to the latest version.'],
+    };
+  }
+
+  const hashes = parsed.hashes;
+  if (typeof hashes !== 'object' || hashes === null || Array.isArray(hashes)) {
+    return {
+      status: WARN,
+      message: '.sdd-meta.json: hashes field is not an object',
+      details: ['Next upgrade will regenerate it.'],
+    };
+  }
+
+  // Validate each entry's shape.
+  const HASH_RE = /^sha256:[0-9a-f]{64}$/;
+  const issues = [];
+  for (const [k, v] of Object.entries(hashes)) {
+    if (typeof k !== 'string') {
+      issues.push(`invalid key: ${typeof k}`);
+      continue;
+    }
+    // Reject absolute paths and `..` traversal.
+    if (k.startsWith('/') || k.includes('..')) {
+      issues.push(`suspicious key: ${k}`);
+      continue;
+    }
+    if (typeof v !== 'string' || !HASH_RE.test(v)) {
+      issues.push(`invalid hash for ${k}`);
+    }
+  }
+
+  if (issues.length > 0) {
+    return {
+      status: WARN,
+      message: `.sdd-meta.json: ${issues.length} shape issue${issues.length > 1 ? 's' : ''}`,
+      details: [...issues.slice(0, 5), 'Next upgrade will regenerate affected entries.'],
+    };
+  }
+
+  // Detect orphan entries (keys not expected for the current tool/type).
+  const expected = expectedSmartDiffTrackedPaths(aiTools, projectType);
+  const orphans = Object.keys(hashes).filter((k) => !expected.has(k));
+  if (orphans.length > 0) {
+    return {
+      status: WARN,
+      message: `.sdd-meta.json: ${orphans.length} orphan entr${orphans.length > 1 ? 'ies' : 'y'}`,
+      details: [
+        ...orphans.slice(0, 5).map((o) => `Orphan: ${o}`),
+        'Non-fatal — next upgrade will prune these automatically.',
+      ],
+    };
+  }
+
+  return {
+    status: PASS,
+    message: `Provenance metadata: valid (${Object.keys(hashes).length} tracked files)`,
+    details: [],
+  };
+}
+
 module.exports = {
   runDoctor,
   printResults,

package/lib/generator.js

@@ -10,6 +10,7 @@ const {
   BACKEND_AGENTS,
 } = require('./config');
 const { adaptAgentContentForProjectType } = require('./adapt-agents');
+const { writeMeta, computeInstallHashes } = require('./meta');
 
 function generate(config) {
   const templateDir = path.join(__dirname, '..', 'template');
@@ -95,6 +96,13 @@ function generate(config) {
   const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8'));
   fs.writeFileSync(path.join(dest, '.sdd-version'), pkg.version + '\n', 'utf8');
 
+  // v0.17.0: write provenance hashes. Captures whatever generator.js's
+  // pipeline produced (lighter than init-generator — adaptAgentsForStack
+  // only, no stack-adaptations module). First upgrade re-adapts via the
+  // scanner-driven pipeline; the hash answers "did the user edit since
+  // install" precisely regardless of which pipeline wrote the content.
+  writeMeta(dest, computeInstallHashes(dest, config.aiTools, config.projectType));
+
   // Show notes
   const notes = collectNotes(config);
   if (notes.length > 0) {

package/lib/init-generator.js

@@ -8,6 +8,8 @@ const {
   BACKEND_AGENTS,
 } = require('./config');
 const { adaptAgentContentForProjectType } = require('./adapt-agents');
+const { applyStackAdaptations } = require('./stack-adaptations');
+const { writeMeta, computeInstallHashes } = require('./meta');
 
 /**
  * Install SDD DevFlow into an existing project.
@@ -252,6 +254,24 @@ function generateInit(config) {
   const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8'));
   fs.writeFileSync(path.join(dest, '.sdd-version'), pkg.version + '\n', 'utf8');
 
+  // v0.17.0: write provenance hashes. Computed AFTER all adaptations
+  // so the hashes reflect the exact post-install content on disk. The
+  // next `--upgrade` uses these hashes to answer "did the user edit
+  // this file?" precisely, avoiding cross-version false-positive
+  // preserve warnings (Codex P1 from v0.16.10 plan review).
+  //
+  // Codex round 2 P1 fix: exclude pre-existing files that --init skipped.
+  // Those belong to the user, not to SDD DevFlow, and must NOT be marked
+  // as tool-canonical — otherwise the next upgrade would hash-match the
+  // user's content and silently overwrite it. `skipped` already contains
+  // the relative paths of files that were skipped due to pre-existence;
+  // convert them to POSIX form and pass as the exclude set.
+  const skippedPosix = new Set(skipped.map((p) => p.split('\\').join('/')));
+  writeMeta(
+    dest,
+    computeInstallHashes(dest, config.aiTools, config.projectType, skippedPosix)
+  );
+
   // Done
   console.log(`\nDone! Next steps:`);
   console.log(`  git add -A && git commit -m "chore: add SDD DevFlow to existing project"`);
@@ -343,163 +363,22 @@ function regexReplaceInFile(filePath, replacements) {
 }
 
 function adaptCopiedFiles(dest, scan, config) {
-  const orm = scan.backend.orm || 'your ORM';
-  const db = scan.backend.db || 'your database';
-
-  // Common Zod → generic validation replacements (all agents + skills)
-  // Phase 1: Replace "Zod" with "validation" (most specific first)
-  const zodReplacements = [
-    ['Zod data schemas', 'validation schemas'],
-    ['Zod schemas', 'validation schemas'],
-  ];
-  // Phase 2: Clean up shared/src/schemas/ path (Zod-specific convention)
-  // Applied AFTER phase 1, so these match the post-replacement text
-  const schemaPathReplacements = [
-    ['validation schemas in `shared/src/schemas/` if applicable', 'validation schemas if applicable'],
-    ['validation schemas in `shared/src/schemas/` (if shared workspace exists)', 'validation schemas (if shared workspace exists)'],
-    ['validation schemas in `shared/src/schemas/`', 'validation schemas'],
-    ['validation schemas (`shared/src/schemas/`)', 'validation schemas'],
-    ['`shared/src/schemas/` (if exists) for current validation schemas', 'project validation schemas'],
-    // Gemini spec-creator: no "Zod" prefix, standalone path reference
-    ['and `shared/src/schemas/` (if exists)', ''],
-    ['schemas vs `shared/src/schemas/`', 'validation schemas up to date'],
-  ];
-
-  // ORM/DB replacements for backend agents
-  let ormReplacements = [];
-  if (scan.backend.orm && scan.backend.orm !== 'Prisma') {
-    ormReplacements = [
-      ['Prisma ORM, and PostgreSQL', `${orm}${db !== 'your database' ? `, and ${db}` : ''}`],
-      ['Repository implementations (Prisma)', `Repository implementations (${orm})`],
-    ];
-  } else if (!scan.backend.orm) {
-    // No ORM detected — remove Prisma references with generic text
-    const dbLabel = db !== 'your database' ? `, and ${db}` : '';
-    ormReplacements = [
-      ['Prisma ORM, and PostgreSQL', dbLabel ? dbLabel.slice(6) : 'your database'],
-      ['Repository implementations (Prisma)', 'Repository implementations'],
-    ];
-  }
-
-  // Apply to all AI tool directories
-  const toolDirs = [];
-  if (config.aiTools !== 'gemini') toolDirs.push('.claude');
-  if (config.aiTools !== 'claude') toolDirs.push('.gemini');
-
-  for (const dir of toolDirs) {
-    // Backend agents: Zod + ORM replacements
-    if (scan.backend.validation !== 'Zod') {
-      const backendAgentReplacements = [...zodReplacements, ...ormReplacements];
-      replaceInCopiedFile(dest, `${dir}/agents/backend-developer.md`, backendAgentReplacements);
-      replaceInCopiedFile(dest, `${dir}/agents/backend-planner.md`, backendAgentReplacements);
-      // Phase 2: clean up shared/src/schemas/ paths
-      replaceInCopiedFile(dest, `${dir}/agents/backend-developer.md`, schemaPathReplacements);
-      replaceInCopiedFile(dest, `${dir}/agents/backend-planner.md`, schemaPathReplacements);
-    } else if (ormReplacements.length > 0) {
-      // Zod detected but different ORM — only ORM replacements
-      replaceInCopiedFile(dest, `${dir}/agents/backend-developer.md`, ormReplacements);
-      replaceInCopiedFile(dest, `${dir}/agents/backend-planner.md`, ormReplacements);
-    }
-
-    // Multi-purpose agents: Zod replacements only
-    if (scan.backend.validation !== 'Zod') {
-      const allZodReplacements = [...zodReplacements, ...schemaPathReplacements];
-      replaceInCopiedFile(dest, `${dir}/agents/spec-creator.md`, allZodReplacements);
-      replaceInCopiedFile(dest, `${dir}/agents/production-code-validator.md`, allZodReplacements);
-      replaceInCopiedFile(dest, `${dir}/agents/database-architect.md`, allZodReplacements);
-    }
-
-    // Skills: Zod + schema path replacements
-    if (scan.backend.validation !== 'Zod') {
-      const allZodReplacements = [...zodReplacements, ...schemaPathReplacements];
-      replaceInCopiedFile(dest, `${dir}/skills/development-workflow/SKILL.md`, allZodReplacements);
-      replaceInCopiedFile(dest, `${dir}/skills/development-workflow/references/ticket-template.md`, allZodReplacements);
-    }
-  }
-
-  // Architecture adaptation: DDD-specific content in backend agents
-  const arch = scan.srcStructure ? scan.srcStructure.pattern : 'ddd';
-  if (arch !== 'ddd') {
-    for (const dir of toolDirs) {
-      // backend-planner: adapt header, exploration paths, implementation order, rules
-      regexReplaceInFile(path.join(dest, dir, 'agents', 'backend-planner.md'), [
-        // Header: remove DDD reference (Claude verbose format)
-        ['specializing in Domain-Driven Design (DDD) layered architecture with deep knowledge of',
-          'specializing in layered architecture with deep knowledge of'],
-        // Header: remove DDD reference (Gemini condensed format)
-        ['(DDD architecture)', '(layered architecture)'],
-        // Exploration: replace DDD-specific paths with generic (number-agnostic)
-        [/\d+\. Read `shared\/src\/schemas\/` \(if exists\) for current .* (?:data )?schemas\n/, ''],
-        [/\d+\. Explore existing domain entities, services, validators, repositories\n/,
-          '5. Explore the codebase for existing patterns, layer structure, and reusable code\n'],
-        [/\d+\. Explore `backend\/src\/infrastructure\/` for existing repositories\n/, ''],
-        // Implementation Order (Claude format)
-        ['following DDD layer order: Domain > Application > Infrastructure > Presentation > Tests',
-          'following the layer order defined in backend-standards.mdc'],
-        // Implementation Order (Gemini format)
-        ['Implementation Order (Domain > Application > Infrastructure > Presentation > Tests)',
-          'Implementation Order (see backend-standards.mdc for layer order)'],
-        // Rules (Claude format)
-        ['Follow DDD layer separation: Domain > Application > Infrastructure > Presentation',
-          'Follow the layer separation defined in backend-standards.mdc'],
-      ]);
-      // backend-developer: adapt frontmatter, header, exploration, implementation order, rules
-      regexReplaceInFile(path.join(dest, dir, 'agents', 'backend-developer.md'), [
-        // Frontmatter (Claude format)
-        ['follows DDD layered architecture',
-          'follows layered architecture'],
-        // Header (Claude format)
-        ['specializing in Domain-Driven Design (DDD) with',
-          'specializing in layered architecture with'],
-        // Header (Gemini condensed format)
-        ['(DDD architecture)', '(layered architecture)'],
-        // Exploration: remove shared/src/schemas reference (number-agnostic)
-        [/\d+\. Read `shared\/src\/schemas\/` \(if exists\) for current .* (?:data )?schemas\n/, ''],
-        // Implementation Order (Claude format): replace DDD layers
-        ['Follow the DDD layer order from the plan:',
-          'Follow the layer order from the plan (see backend-standards.mdc for project layers):'],
-        [/\d+\. \*\*Domain Layer\*\*: Entities, value objects, repository interfaces, domain errors\n/,
-          '1. **Data Layer**: Models, database operations, data access\n'],
-        [/\d+\. \*\*Application Layer\*\*: Services, validators, DTOs\n/,
-          '2. **Business Logic Layer**: Controllers, services, external integrations\n'],
-        [/\d+\. \*\*Infrastructure Layer\*\*: Repository implementations \([^)]*\), external integrations\n/,
-          '3. **Presentation Layer**: Routes, handlers, middleware\n'],
-        [/\d+\. \*\*Presentation Layer\*\*: Controllers, routes, middleware\n/,
-          '4. **Integration Layer**: Wiring, configuration, server registration\n'],
-        // Implementation Order (Gemini format)
-        ['Follow DDD layer order: Domain > Application > Infrastructure > Presentation.',
-          'Follow the layer order defined in backend-standards.mdc.'],
-        // Rules (Claude format)
-        ['**ALWAYS** follow DDD layer separation',
-          '**ALWAYS** follow the layer separation defined in backend-standards.mdc'],
-        ['**ALWAYS** handle errors with custom domain error classes',
-          '**ALWAYS** handle errors following the patterns in backend-standards.mdc'],
-        // Rules (Gemini format)
-        ['ALWAYS handle errors with domain error classes',
-          'ALWAYS handle errors following the patterns in backend-standards.mdc'],
-        // Documentation: remove shared/src/schemas mandatory update
-        [/- (?:\*\*MANDATORY\*\*: )?If modifying a DB schema → update .* schemas in `shared\/src\/schemas\/` BEFORE continuing\n/, ''],
-      ]);
-    }
-  }
-
-  // Agent/skill content: remove frontend/backend-specific references for single-stack projects
+  // v0.17.0: delegate stack-specific adaptations (Zod → validation,
+  // ORM swap, DDD → layered, documentation-standards.mdc project-type
+  // pruning) to the shared module in lib/stack-adaptations.js. This
+  // makes the exact same transformation available to upgrade-generator.js
+  // for the hash-based smart-diff replacement path.
+  //
+  // The in-memory variant (applyStackAdaptationsToContent) is also used
+  // by the upgrade fallback path to construct the "what init would have
+  // written" comparison target when .sdd-meta.json is missing (Gemini M1
+  // fix from plan v1.0 cross-model review).
+  applyStackAdaptations(dest, scan, config, null);
+
+  // Remove frontend/backend-specific references for single-stack
+  // projects. Separate from stack adaptations — this is project-type
+  // pruning, not stack substitution.
   adaptAgentContentForProjectType(dest, config, regexReplaceInFile);
-
-  // documentation-standards.mdc: remove irrelevant rows based on project type
-  const docStdPath = path.join(dest, 'ai-specs', 'specs', 'documentation-standards.mdc');
-  if (fs.existsSync(docStdPath)) {
-    let content = fs.readFileSync(docStdPath, 'utf8');
-    if (config.projectType === 'backend') {
-      content = content.replace(/\| `ai-specs\/specs\/frontend-standards\.mdc` \|[^\n]*\n/, '');
-      content = content.replace(/\| `docs\/specs\/ui-components\.md` \|[^\n]*\n/, '');
-      content = content.replace(/   - UI component changes → `docs\/specs\/ui-components\.md`\n/, '');
-    } else if (config.projectType === 'frontend') {
-      content = content.replace(/\| `ai-specs\/specs\/backend-standards\.mdc` \|[^\n]*\n/, '');
-      content = content.replace(/\| `docs\/specs\/api-spec\.yaml` \|[^\n]*\n/, '');
-    }
-    fs.writeFileSync(docStdPath, content, 'utf8');
-  }
 }
 
 // --- Standards Adaptation ---
@@ -762,7 +641,14 @@ function adaptAgentsMd(template, config, scan) {
     return norm !== 'docs' && norm !== 'ai-specs';
   });
   if (meaningfulDirs.length > 0) {
-    const tree = rootDirs.map((d) => `├── ${d.replace(/\/$/, '/')}   `).join('\n');
+    // v0.17.0: use meaningfulDirs (not rootDirs) to build the tree. The
+    // SDD-infrastructure dirs (ai-specs/, docs/) get installed BY init
+    // itself, so at install time they're absent from the scan but at
+    // upgrade time they're present. Using rootDirs would produce
+    // different content in each scan → hash drift → false-positive
+    // preserve warnings on every upgrade. Using meaningfulDirs stabilizes
+    // the output across install and upgrade for the same project.
+    const tree = meaningfulDirs.map((d) => `├── ${d.replace(/\/$/, '/')}   `).join('\n');
     const treeBlock = `\`\`\`\nproject/\n${tree}\n└── docs/        ← Documentation\n\`\`\``;
     content = content.replace(
       /<!-- CONFIG: Adjust directories[^>]*-->\n+```\nproject\/\n[\s\S]*?```/,
@@ -1069,9 +955,25 @@ function appendGitignore(dest, skipped) {
   const sddEntries = '\n# SDD DevFlow\ndocs/tickets/*.md\n!docs/tickets/.gitkeep\n';
 
   if (fs.existsSync(gitignorePath)) {
-    const content = fs.readFileSync(gitignorePath, 'utf8');
+    let content = fs.readFileSync(gitignorePath, 'utf8');
+    let appended = false;
     if (!content.includes('SDD DevFlow')) {
-      fs.appendFileSync(gitignorePath, sddEntries, 'utf8');
+      content = content.trimEnd() + sddEntries;
+      appended = true;
+    }
+    // v0.17.0: ensure .sdd-meta.json + .sdd-backup/ are ignored (local-only
+    // metadata). Codex round 2 P2 fix — --init must also append these
+    // entries idempotently, matching the upgrade path.
+    if (!/^\s*\/?\.sdd-backup\/?\s*$/m.test(content)) {
+      content = content.trimEnd() + '\n\n# sdd-devflow upgrade backups (ignored — kept locally for recovery only)\n.sdd-backup/\n';
+      appended = true;
+    }
+    if (!/^\s*\/?\.sdd-meta\.json\s*$/m.test(content)) {
+      content = content.trimEnd() + '\n\n# sdd-devflow provenance tracking (local-only, content-addressable hashes)\n.sdd-meta.json\n';
+      appended = true;
+    }
+    if (appended) {
+      fs.writeFileSync(gitignorePath, content, 'utf8');
       step('Appended SDD entries to .gitignore');
     }
   } else {