@ankurhalder/codebase-snapshot 2.0.0 → 2.1.1

package/dist/cli.d.cts

@@ -1,4 +1,4 @@
-import { O as OutputFormat } from './types-S-5eRuRc.cjs';
+import { O as OutputFormat } from './types-CJqkePM4.cjs';
 
 type Command = "generate" | "validate" | "report" | "init" | "explain" | "diff";
 /** A user-input problem: printed without a stack trace, exits 2. */
@@ -11,6 +11,14 @@ interface ParsedInvocation {
     format: OutputFormat;
     dryRun: boolean;
     watch: boolean;
+    preset?: string;
+    /** The size exactly as typed, so the generated config can keep `120k`. */
+    maxPartBytesRaw?: string;
+    include?: string;
+    exclude?: string;
+    yes: boolean;
+    minimal: boolean;
+    force: boolean;
     cwd: string;
     outDir?: string;
     includeMonolith?: boolean;

package/dist/cli.d.ts

@@ -1,4 +1,4 @@
-import { O as OutputFormat } from './types-S-5eRuRc.js';
+import { O as OutputFormat } from './types-CJqkePM4.js';
 
 type Command = "generate" | "validate" | "report" | "init" | "explain" | "diff";
 /** A user-input problem: printed without a stack trace, exits 2. */
@@ -11,6 +11,14 @@ interface ParsedInvocation {
     format: OutputFormat;
     dryRun: boolean;
     watch: boolean;
+    preset?: string;
+    /** The size exactly as typed, so the generated config can keep `120k`. */
+    maxPartBytesRaw?: string;
+    include?: string;
+    exclude?: string;
+    yes: boolean;
+    minimal: boolean;
+    force: boolean;
     cwd: string;
     outDir?: string;
     includeMonolith?: boolean;

package/dist/cli.js

@@ -1,4 +1,4 @@
-import { parseByteSize, GENERATOR_VERSION, ARTIFACT_NAMES, MIN_MAX_PART_BYTES, loadConfigFileDetailed, resolveConfig, validateSnapshot, explainPath, compareManifests, loadManifest, renderDiffText, generateSnapshot, GENERATOR_NAME, supportsTypeScriptImports, renderExplainText } from './chunk-RGDVLQTT.js';
+import { parseByteSize, GENERATOR_VERSION, ARTIFACT_NAMES, getPreset, unknownPresetMessage, MIN_MAX_PART_BYTES, loadConfigFileDetailed, resolveConfig, validateSnapshot, explainPath, compareManifests, loadManifest, renderDiffText, generateSnapshot, GENERATOR_NAME, runInit, PromptCancelled, renderExplainText } from './chunk-SUOJL5EX.js';
 import * as fs from 'fs';
 import * as path from 'path';
 import { parseArgs } from 'util';
@@ -35,6 +35,12 @@ var CLI_OPTIONS = {
   mode: { type: "string" },
   "dry-run": { type: "boolean" },
   watch: { type: "boolean" },
+  preset: { type: "string" },
+  include: { type: "string" },
+  exclude: { type: "string" },
+  yes: { type: "boolean" },
+  minimal: { type: "boolean" },
+  force: { type: "boolean" },
   help: { type: "boolean", short: "h" },
   version: { type: "boolean", short: "v" }
 };
@@ -72,6 +78,14 @@ Options:
   --format <text|json>          CLI output format (default: text)
   --dry-run                     Compute the snapshot without writing anything
   --watch                       Re-generate whenever the repository changes
+
+  init only:
+  --preset <name>               Force a project preset instead of detecting one
+  --include <globs>             Comma-separated allow-list
+  --exclude <globs>             Comma-separated exclude patterns
+  --minimal                     Write only the settings that differ from defaults
+  --yes                         Accept every default without prompting
+  --force                       Overwrite an existing config
   -h, --help                    Display this help message
   -v, --version                 Display version
 
@@ -128,9 +142,32 @@ function parseCliArgs(argv) {
       strict: true
     });
   } catch (err) {
-    throw new UsageError(err.message);
+    const message = err.message;
+    const ambiguous = /^Option '(--[^']+)' argument is ambiguous/i.exec(message);
+    if (ambiguous) {
+      throw new UsageError(
+        `${ambiguous[1]} received a value that looks like another flag (for example a negative number). Use the "--option=value" form, and note that sizes must be positive.`
+      );
+    }
+    throw new UsageError(message);
   }
   const values = parsed.values;
+  for (const [name, spec] of Object.entries(CLI_OPTIONS)) {
+    if (spec.type !== "string") continue;
+    const raw = values[name];
+    if (raw !== void 0 && String(raw).trim() === "") {
+      throw new UsageError(`--${name} requires a value (received an empty string).`);
+    }
+  }
+  if (values.cwd !== void 0) {
+    const target = String(values.cwd);
+    if (!fs.existsSync(target)) {
+      throw new UsageError(`--cwd directory does not exist: ${target}`);
+    }
+    if (!fs.statSync(target).isDirectory()) {
+      throw new UsageError(`--cwd is not a directory: ${target}`);
+    }
+  }
   if (values.help) {
     process.stdout.write(`${USAGE}
 `);
@@ -196,12 +233,37 @@ function parseCliArgs(argv) {
   } else if (rawSkip !== void 0) {
     skipArtifacts = parseArtifactList(String(rawSkip), "--skip-artifacts");
   }
+  if (command !== "init") {
+    const initOnly = [];
+    if (values.preset !== void 0) initOnly.push("--preset");
+    if (values.include !== void 0) initOnly.push("--include");
+    if (values.exclude !== void 0) initOnly.push("--exclude");
+    if (values.yes === true) initOnly.push("--yes");
+    if (values.minimal === true) initOnly.push("--minimal");
+    if (values.force === true) initOnly.push("--force");
+    if (initOnly.length > 0) {
+      throw new UsageError(
+        `${initOnly.join(", ")} ${initOnly.length === 1 ? "is" : "are"} only valid with \`init\`. To scope \`${command}\`, set include/excludePatterns/preset in snapshot.config.ts (or run \`snap init\` to generate one).`
+      );
+    }
+  }
+  if (command === "init" && values.preset !== void 0) {
+    const requested = String(values.preset);
+    if (!getPreset(requested)) throw new UsageError(unknownPresetMessage(requested));
+  }
   return {
     command,
     args,
     format: rawFormat,
     dryRun: values["dry-run"] === true,
     watch: values.watch === true,
+    preset: values.preset === void 0 ? void 0 : String(values.preset),
+    maxPartBytesRaw: values["max-part-bytes"] === void 0 ? void 0 : String(values["max-part-bytes"]),
+    include: values.include === void 0 ? void 0 : String(values.include),
+    exclude: values.exclude === void 0 ? void 0 : String(values.exclude),
+    yes: values.yes === true,
+    minimal: values.minimal === true,
+    force: values.force === true,
     cwd: values.cwd === void 0 ? process.cwd() : path.resolve(String(values.cwd)),
     outDir: values["out-dir"] === void 0 ? void 0 : String(values["out-dir"]),
     includeMonolith: values["include-monolith"] === true ? true : void 0,
@@ -242,32 +304,65 @@ function emit(format, payload, textRenderer) {
   }
   textRenderer();
 }
-function runInit(cwd) {
-  const targetName = supportsTypeScriptImports() ? "snapshot.config.ts" : "snapshot.config.mjs";
-  const targetPath = path.join(cwd, targetName);
-  if (fs.existsSync(targetPath)) {
-    warn(`\u274C ${targetName} already exists in ${cwd}.`);
-    return 1;
+function splitList(value) {
+  if (value === void 0) return void 0;
+  return value.split(",").map((entry) => entry.trim()).filter(Boolean);
+}
+function describeManifestShapeProblem(manifest) {
+  if (!manifest || typeof manifest !== "object" || Array.isArray(manifest)) {
+    return "not a JSON object";
   }
-  const importPath = JSON.stringify(GENERATOR_NAME);
-  const starter = `import { defineConfig } from ${importPath};
-
-export default defineConfig({
-  branch: "main",
-  outDir: "snapshot",
-  maxPartBytes: 300 * 1024,
-  largeFileBytes: 200 * 1024,
-  excludePatterns: [],
-});
-`;
-  fs.writeFileSync(targetPath, starter, "utf8");
-  info(`\u2705 Created ${targetName} in ${cwd}`);
-  if (targetName.endsWith(".mjs")) {
-    info(
-      "   (a .ts config needs Node >= 22.6 to import natively; this Node writes a .mjs instead)"
-    );
+  const candidate = manifest;
+  const counts = candidate.counts;
+  if (!counts || typeof counts !== "object") return "missing `counts`";
+  for (const key of ["totalFiles", "totalLines", "totalSizeBytes", "partsCount"]) {
+    if (typeof counts[key] !== "number") return `missing numeric \`counts.${key}\``;
+  }
+  if (!candidate.layers || typeof candidate.layers !== "object") return "missing `layers`";
+  if (!Array.isArray(candidate.files)) return "missing `files` array";
+  return null;
+}
+async function runInitCommand(invocation) {
+  try {
+    const result = await runInit({
+      cwd: invocation.cwd,
+      preset: invocation.preset,
+      maxPartBytes: invocation.maxPartBytesRaw ?? invocation.maxPartBytes,
+      include: splitList(invocation.include),
+      exclude: splitList(invocation.exclude),
+      skipArtifacts: invocation.skipArtifacts,
+      includeSensitiveFiles: invocation.includeSensitiveFiles,
+      yes: invocation.yes,
+      minimal: invocation.minimal,
+      force: invocation.force,
+      dryRun: invocation.dryRun
+    });
+    if (invocation.format === "json") {
+      process.stdout.write(`${JSON.stringify(result, null, 2)}
+`);
+      return 0;
+    }
+    if (!result.written) {
+      info(result.configText);
+      return 0;
+    }
+    info(`\u2705 Created ${path.basename(result.configPath)} (preset: ${result.preset})`);
+    if (result.scripts.length > 0) info(`   Added npm scripts: ${result.scripts.join(", ")}`);
+    if (result.gitignoreEntries.length > 0) {
+      info(`   Added to .gitignore: ${result.gitignoreEntries.join(", ")}`);
+    }
+    for (const note of result.notes) info(`   \u26A0 ${note}`);
+    info("");
+    info("   Next:  npm run snapshot");
+    return 0;
+  } catch (err) {
+    if (err instanceof PromptCancelled) {
+      warn("\u274C Cancelled.");
+      return 1;
+    }
+    warn(`\u274C ${err.message}`);
+    return 1;
   }
-  return 0;
 }
 function renderValidateText(result) {
   if (result.valid) {
@@ -290,6 +385,9 @@ function renderValidateText(result) {
     for (const missing of result.drift.missingOnDisk.slice(0, 20)) {
       warn(`  - deleted: ${missing}`);
     }
+    for (const mismatch of result.drift.totalsMismatches.slice(0, 20)) {
+      warn(`  - counts: ${mismatch}`);
+    }
   }
   for (const warning of result.warnings) warn(`  \u26A0 ${warning}`);
 }
@@ -309,10 +407,14 @@ ${USAGE}
     throw err;
   }
   if (invocation.command === "init") {
-    return runInit(invocation.cwd);
+    return await runInitCommand(invocation);
   }
   const loaded = await loadConfigFileDetailed(invocation.cwd);
   for (const warning of loaded.warnings) warn(`\u26A0 Config: ${warning}`);
+  if (loaded.errors.length > 0) {
+    warn("\u274C The config file could not be read. Fix it, or delete it to use the defaults.");
+    return 1;
+  }
   if (loaded.file) info(`\u2699  Using config ${path.relative(process.cwd(), loaded.file) || loaded.file}`);
   const resolved = resolveConfig(
     loaded.config,
@@ -337,7 +439,7 @@ ${USAGE}
     return result.valid ? 0 : 1;
   }
   if (invocation.command === "report") {
-    const manifestPath = path.join(resolved.cwd, resolved.outDir, "manifest.json");
+    const manifestPath = path.resolve(resolved.cwd, resolved.outDir, "manifest.json");
     if (!fs.existsSync(manifestPath)) {
       warn(`\u274C Manifest not found at ${manifestPath}. Run generate first.`);
       return 1;
@@ -349,6 +451,11 @@ ${USAGE}
       warn(`\u274C Could not read ${manifestPath}: ${err.message}`);
       return 1;
     }
+    const shapeError = describeManifestShapeProblem(manifest);
+    if (shapeError) {
+      warn(`\u274C ${manifestPath} is not a snapshot manifest: ${shapeError}`);
+      return 1;
+    }
     const validation = validateSnapshot(resolved);
     emit(invocation.format, { manifest, validation }, () => {
       info(`
@@ -411,9 +518,23 @@ ${USAGE}
       info(
         `   - Total size:    ${(manifest.counts.totalSizeBytes / (1024 * 1024)).toFixed(2)} MB`
       );
-      info(`   - Parts written: ${manifest.counts.partsCount} under ${resolved.outDir}/parts/`);
-      info(`   - Reports:       ${resolved.outDir}/reports/ (project-tree, navigation, audit)`);
-      info(`   - Manifest:      ${resolved.outDir}/manifest.json`);
+      const { artifacts } = resolved;
+      if (artifacts.parts) {
+        info(`   - Parts written: ${manifest.counts.partsCount} under ${resolved.outDir}/parts/`);
+      }
+      const reports = [
+        artifacts.projectTree && "project-tree",
+        artifacts.navigation && "navigation",
+        artifacts.audit && "audit"
+      ].filter(Boolean);
+      if (reports.length > 0) {
+        info(`   - Reports:       ${resolved.outDir}/reports/ (${reports.join(", ")})`);
+      }
+      if (artifacts.manifest) info(`   - Manifest:      ${resolved.outDir}/manifest.json`);
+      if (artifacts.monolith) info(`   - Monolith:      ${resolved.outDir}/full-codebase.{json,md}`);
+      if (reports.length === 0 && !artifacts.parts && !artifacts.manifest && !artifacts.monolith) {
+        info(`   - Artifacts:     all disabled (only the ownership marker was written)`);
+      }
       info(`   - Fingerprint:   ${manifest.fingerprint}`);
       info(`   - Integrity:     ${manifest.validation.status}`);
       if (manifest.warnings.length > 0) {
@@ -430,6 +551,14 @@ ${USAGE}
     }
     return manifest.validation.status === "passed" ? 0 : 1;
   } catch (err) {
+    const code = err.code;
+    if (code === "EPERM" || code === "EACCES") {
+      warn(
+        `\u274C Cannot write the snapshot: permission denied under ${resolved.outDir}. Check the directory's permissions or choose another --out-dir.`
+      );
+      warn(`   (${err.message})`);
+      return 1;
+    }
     warn(`\u274C Failed to generate snapshot: ${err.message}`);
     return 1;
   }