@ankurhalder/codebase-snapshot 4.0.0 → 4.0.2

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { J as JsonSummary, M as MarkdownSummary, S as SourceSummary, R as ResolvedSnapshotConfig, a as SnapshotConfig, B as ByteSize, C as CliOptions, F as FileEntry, P as PartMetadata, L as LayerRule, K as KindRule, b as SecretRule, c as SecretFinding, V as ValidationResult, d as Manifest, A as ArtifactSelection, e as SkipRecord } from './types-BdpT_4b8.cjs';
-export { f as BudgetConfig, H as HooksConfig, I as InclusionMode, g as ManifestArtifact, h as ManifestConfigSnapshot, i as ManifestIndexes, j as ManifestTotals, k as Mode, O as OutputFormat, l as PartFileEntry, m as ResolvedArtifacts, n as ResolvedBudgets, o as SecretRuleInput, p as SkipReason, q as SummaryQuality, r as ValidationDrift } from './types-BdpT_4b8.cjs';
+import { J as JsonSummary, M as MarkdownSummary, S as SourceSummary, R as ResolvedSnapshotConfig, a as SnapshotConfig, B as ByteSize, C as CliOptions, F as FileEntry, P as PartMetadata, L as LayerRule, K as KindRule, b as SecretRule, c as SecretFinding, V as ValidationResult, d as Manifest, A as ArtifactSelection, e as SkipRecord } from './types-LSfwsKE-.cjs';
+export { f as BudgetConfig, H as HooksConfig, I as InclusionMode, g as ManifestArtifact, h as ManifestConfigSnapshot, i as ManifestIndexes, j as ManifestTotals, k as Mode, O as OutputFormat, l as PartFileEntry, m as ResolvedArtifacts, n as ResolvedBudgets, o as SecretRuleInput, p as SkipReason, q as SummaryQuality, r as ValidationDrift } from './types-LSfwsKE-.cjs';
 
 /**
  * Strips `//` and block comments the way JSONC does, without touching anything
@@ -457,6 +457,11 @@ interface CollectOptions {
      * Default `false`: they are skipped with `reason: "sensitive-file"`.
      */
     includeSensitiveFiles?: boolean;
+    /**
+     * Secret rules used to scan *paths* (defaults are always applied). Pass
+     * `config.secretRules` so `customPatterns` also protect file names.
+     */
+    secretRules?: readonly SecretRule[];
 }
 interface CollectResult {
     files: string[];
@@ -490,7 +495,7 @@ declare function matchesExclude(relativePath: string, pattern: string): boolean;
 declare function collectFiles(cwd: string, options?: CollectOptions): CollectResult;
 
 declare const GENERATOR_NAME = "@ankurhalder/codebase-snapshot";
-declare const GENERATOR_VERSION = "4.0.0";
+declare const GENERATOR_VERSION = "4.0.2";
 declare const SCHEMA_VERSION = "3.0.0";
 interface GenerateOptions {
     /** Compute the full manifest but write nothing to disk. */
@@ -514,13 +519,13 @@ declare function resolveSafeOutputDirs(config: {
 /**
  * Refuses to replace a directory that this generator did not write.
  *
- * Path checks alone cannot make the swap and the staging wipe safe: `outDir:
- * "src"` is a plausible typo, and a user directory that happens to contain a
- * `.codebase-snapshot` file or a manifest-shaped JSON document is not a
- * snapshot. `tmpDir` is held to the same standard: it is only cleared when it
- * carries our marker and holds nothing but our artifacts.
+ * Path checks alone cannot make the swap safe: `outDir: "src"` is a plausible
+ * typo, and a user directory that happens to contain a `.codebase-snapshot` file
+ * or a manifest-shaped JSON document is not a snapshot. The staging root is
+ * checked separately by {@link assertStagingRootUsable}, because it holds one
+ * directory per run rather than a single snapshot.
  */
-declare function assertReplaceable(target: string, label: "outDir" | "tmpDir"): void;
+declare function assertReplaceable(target: string, label: "outDir" | "tmpDir", secretRules?: readonly SecretRule[]): void;
 /**
  * Generates the snapshot.
  *

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { J as JsonSummary, M as MarkdownSummary, S as SourceSummary, R as ResolvedSnapshotConfig, a as SnapshotConfig, B as ByteSize, C as CliOptions, F as FileEntry, P as PartMetadata, L as LayerRule, K as KindRule, b as SecretRule, c as SecretFinding, V as ValidationResult, d as Manifest, A as ArtifactSelection, e as SkipRecord } from './types-BdpT_4b8.js';
-export { f as BudgetConfig, H as HooksConfig, I as InclusionMode, g as ManifestArtifact, h as ManifestConfigSnapshot, i as ManifestIndexes, j as ManifestTotals, k as Mode, O as OutputFormat, l as PartFileEntry, m as ResolvedArtifacts, n as ResolvedBudgets, o as SecretRuleInput, p as SkipReason, q as SummaryQuality, r as ValidationDrift } from './types-BdpT_4b8.js';
+import { J as JsonSummary, M as MarkdownSummary, S as SourceSummary, R as ResolvedSnapshotConfig, a as SnapshotConfig, B as ByteSize, C as CliOptions, F as FileEntry, P as PartMetadata, L as LayerRule, K as KindRule, b as SecretRule, c as SecretFinding, V as ValidationResult, d as Manifest, A as ArtifactSelection, e as SkipRecord } from './types-LSfwsKE-.js';
+export { f as BudgetConfig, H as HooksConfig, I as InclusionMode, g as ManifestArtifact, h as ManifestConfigSnapshot, i as ManifestIndexes, j as ManifestTotals, k as Mode, O as OutputFormat, l as PartFileEntry, m as ResolvedArtifacts, n as ResolvedBudgets, o as SecretRuleInput, p as SkipReason, q as SummaryQuality, r as ValidationDrift } from './types-LSfwsKE-.js';
 
 /**
  * Strips `//` and block comments the way JSONC does, without touching anything
@@ -457,6 +457,11 @@ interface CollectOptions {
      * Default `false`: they are skipped with `reason: "sensitive-file"`.
      */
     includeSensitiveFiles?: boolean;
+    /**
+     * Secret rules used to scan *paths* (defaults are always applied). Pass
+     * `config.secretRules` so `customPatterns` also protect file names.
+     */
+    secretRules?: readonly SecretRule[];
 }
 interface CollectResult {
     files: string[];
@@ -490,7 +495,7 @@ declare function matchesExclude(relativePath: string, pattern: string): boolean;
 declare function collectFiles(cwd: string, options?: CollectOptions): CollectResult;
 
 declare const GENERATOR_NAME = "@ankurhalder/codebase-snapshot";
-declare const GENERATOR_VERSION = "4.0.0";
+declare const GENERATOR_VERSION = "4.0.2";
 declare const SCHEMA_VERSION = "3.0.0";
 interface GenerateOptions {
     /** Compute the full manifest but write nothing to disk. */
@@ -514,13 +519,13 @@ declare function resolveSafeOutputDirs(config: {
 /**
  * Refuses to replace a directory that this generator did not write.
  *
- * Path checks alone cannot make the swap and the staging wipe safe: `outDir:
- * "src"` is a plausible typo, and a user directory that happens to contain a
- * `.codebase-snapshot` file or a manifest-shaped JSON document is not a
- * snapshot. `tmpDir` is held to the same standard: it is only cleared when it
- * carries our marker and holds nothing but our artifacts.
+ * Path checks alone cannot make the swap safe: `outDir: "src"` is a plausible
+ * typo, and a user directory that happens to contain a `.codebase-snapshot` file
+ * or a manifest-shaped JSON document is not a snapshot. The staging root is
+ * checked separately by {@link assertStagingRootUsable}, because it holds one
+ * directory per run rather than a single snapshot.
  */
-declare function assertReplaceable(target: string, label: "outDir" | "tmpDir"): void;
+declare function assertReplaceable(target: string, label: "outDir" | "tmpDir", secretRules?: readonly SecretRule[]): void;
 /**
  * Generates the snapshot.
  *

package/dist/index.js

@@ -1,3 +1,3 @@
-export { ARTIFACT_NAMES, DEFAULT_ANSWERS, DEFAULT_SECRET_PATTERNS, GENERATOR_NAME, GENERATOR_VERSION, LANGUAGE_PROFILES, MIN_MAX_PART_BYTES, PRESETS, PromptCancelled, SCHEMA_VERSION, anchorForPath, assertReplaceable, assertUsableConfigInput, collectFiles, compareManifests, countLines, defineConfig, detectLanguage, detectPreset, explainPath, fenceForContent, fenceForText, generateProjectTree, generateSnapshot, generateSnapshotAsync, getPreset, globToRegExp, isBinaryBuffer, isBinaryExtension, isBinaryFile, isInteractive, isResolvedConfig, isSensitivePath, listPresetNames, loadConfigFile, loadConfigFileDetailed, loadManifest, markResolvedConfig, matchRule, matchesExclude, normalizeResolvedConfig, parseByteSize, partitionFiles, profileForPath, renderConfig, renderDiffText, renderExplainText, renderMinimalConfig, renumberParts, resolveConfig, resolveSafeOutputDirs, runInit, scanAndRedactSecrets, stripJsonComments, summarizeJson, summarizeMarkdown, summarizeTypeScriptSource, summarizeWithProfile, supportsTypeScriptImports, truncatePreview, truncateToBytes, validateSnapshot } from './chunk-FM4OOQPF.js';
+export { ARTIFACT_NAMES, DEFAULT_ANSWERS, DEFAULT_SECRET_PATTERNS, GENERATOR_NAME, GENERATOR_VERSION, LANGUAGE_PROFILES, MIN_MAX_PART_BYTES, PRESETS, PromptCancelled, SCHEMA_VERSION, anchorForPath, assertReplaceable, assertUsableConfigInput, collectFiles, compareManifests, countLines, defineConfig, detectLanguage, detectPreset, explainPath, fenceForContent, fenceForText, generateProjectTree, generateSnapshot, generateSnapshotAsync, getPreset, globToRegExp, isBinaryBuffer, isBinaryExtension, isBinaryFile, isInteractive, isResolvedConfig, isSensitivePath, listPresetNames, loadConfigFile, loadConfigFileDetailed, loadManifest, markResolvedConfig, matchRule, matchesExclude, normalizeResolvedConfig, parseByteSize, partitionFiles, profileForPath, renderConfig, renderDiffText, renderExplainText, renderMinimalConfig, renumberParts, resolveConfig, resolveSafeOutputDirs, runInit, scanAndRedactSecrets, stripJsonComments, summarizeJson, summarizeMarkdown, summarizeTypeScriptSource, summarizeWithProfile, supportsTypeScriptImports, truncatePreview, truncateToBytes, validateSnapshot } from './chunk-CY3XU5TS.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/{types-BdpT_4b8.d.cts → types-LSfwsKE-.d.cts}

@@ -66,6 +66,7 @@ type SkipReason = "binary" | "read-error" | "not-file"
 /** Excluded by the user's own `excludePatterns` or `include` allow-list. */
  | "excluded";
 interface SkipRecord {
+    /** Path as it may be shown in an artifact: secret spans are masked. */
     path: string;
     reason: SkipReason;
     detail?: string;

package/dist/{types-BdpT_4b8.d.ts → types-LSfwsKE-.d.ts}

@@ -66,6 +66,7 @@ type SkipReason = "binary" | "read-error" | "not-file"
 /** Excluded by the user's own `excludePatterns` or `include` allow-list. */
  | "excluded";
 interface SkipRecord {
+    /** Path as it may be shown in an artifact: secret spans are masked. */
     path: string;
     reason: SkipReason;
     detail?: string;

package/docs/cli.md

@@ -85,9 +85,11 @@ Exit `0` when the snapshot is current, `1` on any drift. It never writes anythin
 codebase-snapshot report [options]
 ```
 
-Prints snapshot health without re-scanning everything: counts, layer breakdown, warnings,
-and the validation verdict. Requires an existing `manifest.json` (exit `1` if missing). Also
-exits `1` when it detects drift.
+Prints what the snapshot says about itself: counts, layer breakdown, warnings, fingerprint.
+It reads `manifest.json` and nothing else, so it is fast on any repository size — a 20 000-file
+snapshot reports in about half a second. Requires an existing `manifest.json` (exit `1` if
+missing); exits `0` otherwise. It does **not** check whether the snapshot is still true — that
+is `validate`, which re-reads the repository and exits `1` on drift.
 
 ### `init`
 

package/docs/troubleshooting.md

@@ -167,7 +167,7 @@ Exit `1` with one line per class of drift:
 **Fix** — re-run `generate`. If it persists, the snapshot directory is being modified by
 something else.
 
-### `report` exits 1
+### `report` exits 1 (only when it cannot read the snapshot)
 
 - `Manifest not found at … Run generate first.` — nothing has been generated yet.
 - `… is not a snapshot manifest: missing \`counts\`` — the file parsed as JSON but is not a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankurhalder/codebase-snapshot",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Production-grade LLM codebase snapshot generator, auditor, and AST partitioner",
   "keywords": [
     "codebase",