@cronn/lib-file-snapshots 0.16.0 → 0.18.0

package/dist/index.d.ts

@@ -103,7 +103,14 @@ interface ValidationFileMatcherConfig {
      * The serializer to use for the snapshot
      */
     serializer: SnapshotSerializer;
+    /**
+     * Whether to update golden masters with the actual result.
+     *
+     * @default "missing"
+     */
+    updateSnapshots?: UpdateSnapshotsType;
 }
+type UpdateSnapshotsType = "all" | "missing" | "none";
 interface ValidationFileMatcherResult {
     actual: string;
     expected: string;
@@ -120,16 +127,19 @@ interface FilePathResolverParams {
 }
 
 declare class ValidationFileMatcher {
+    private readonly updateSnapshots;
     private readonly serializer;
     private readonly filePaths;
-    private readonly validationFile;
+    private validationFile;
     constructor(config: ValidationFileMatcherConfig);
     get isValidationFileMissing(): boolean;
+    get isUpdate(): boolean;
     matchFileSnapshot(actual: unknown): ValidationFileMatcherResult;
     private buildFilePaths;
     private readValidationFile;
     private createMatcherResult;
     private writeFileSnapshots;
+    private resolveExpected;
 }
 
 declare function resolveNameAsFile(params: FilePathResolverParams): string;
@@ -142,4 +152,4 @@ declare function isArray(value: unknown): value is Array<unknown>;
 type PlainObject = Record<PropertyKey, unknown>;
 declare function isPlainObject(value: unknown): value is PlainObject;
 
-export { type FilePathResolver, type FilePathResolverParams, type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type PlainObject, type SnapshotSerializer, type TextNormalizer, TextSerializer, ValidationFileMatcher, type ValidationFileMatcherResult, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };
+export { type FilePathResolver, type FilePathResolverParams, type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type PlainObject, type SnapshotSerializer, type TextNormalizer, TextSerializer, type UpdateSnapshotsType, ValidationFileMatcher, type ValidationFileMatcherResult, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };

package/dist/index.js

@@ -1,5 +1,6 @@
 // src/utils/file.ts
 import fs from "fs";
+import os from "os";
 import path from "path";
 var NEW_LINE_SEPARATOR = "\n";
 var EMOJI_REGEXP = /(?!(\*|#|\d))[\p{Extended_Pictographic}\p{Emoji_Component}]|[\u0030-\u0039]\ufe0f?[\u20e3]|[\u002A\u0023]?\ufe0f?[\u20e3]/gu;
@@ -7,7 +8,11 @@ function normalizeFileName(testName) {
   return testName.replaceAll(EMOJI_REGEXP, "").replaceAll(/[+*%~<>?!$#'"`|\\/()[\]{}]/g, "").replaceAll(/[\s.:,;]+/g, "_").replaceAll(/_{2,}/g, "_");
 }
 function readSnapshotFile(path4) {
-  return fs.readFileSync(path4, { encoding: "utf8" });
+  const contents = fs.readFileSync(path4, { encoding: "utf8" });
+  if (os.EOL === NEW_LINE_SEPARATOR) {
+    return contents;
+  }
+  return contents.replace(new RegExp(os.EOL, "g"), NEW_LINE_SEPARATOR);
 }
 function writeSnapshotFile(file, data) {
   mkdirRecursive(path.dirname(file));
@@ -245,10 +250,12 @@ var TextSerializer = class {
 import * as fs2 from "fs";
 import * as path2 from "path";
 var ValidationFileMatcher = class {
+  updateSnapshots;
   serializer;
   filePaths;
   validationFile;
   constructor(config) {
+    this.updateSnapshots = config.updateSnapshots ?? "missing";
     this.serializer = config.serializer;
     this.filePaths = this.buildFilePaths(config);
     this.validationFile = this.readValidationFile();
@@ -256,20 +263,18 @@ var ValidationFileMatcher = class {
   get isValidationFileMissing() {
     return this.validationFile === void 0;
   }
+  get isUpdate() {
+    return this.updateSnapshots === "all" || this.isValidationFileMissing && this.updateSnapshots === "missing";
+  }
   matchFileSnapshot(actual) {
     if (!this.serializer.canSerialize(actual)) {
       throw new Error(`Cannot serialize value of type ${typeof actual}`);
     }
     const serializedActual = this.serializer.serialize(actual);
-    if (this.validationFile === void 0) {
-      return this.createMatcherResult({
-        actual: serializedActual,
-        expected: addMissingFileMarker(serializedActual)
-      });
-    }
+    const expected = this.resolveExpected(serializedActual);
     return this.createMatcherResult({
       actual: serializedActual,
-      expected: this.validationFile
+      expected
     });
   }
   buildFilePaths(config) {
@@ -304,9 +309,17 @@ does not match validation file '${validationFilePath}'`,
     const { actual, expected } = matcherResult;
     const { outputFilePath, validationFilePath } = this.filePaths;
     writeSnapshotFile(outputFilePath, actual);
-    if (this.isValidationFileMissing) {
-      writeSnapshotFile(validationFilePath, expected);
+    if (this.isUpdate) {
+      const validationFileData = this.isValidationFileMissing ? expected : actual;
+      writeSnapshotFile(validationFilePath, validationFileData);
+      this.validationFile = validationFileData;
+    }
+  }
+  resolveExpected(actual) {
+    if (this.validationFile === void 0) {
+      return addMissingFileMarker(actual);
     }
+    return this.validationFile;
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
@@ -17,8 +17,19 @@
   },
   "homepage": "https://github.com/cronn/file-snapshots",
   "engines": {
-    "node": ">=22.18",
-    "pnpm": ">=10"
+    "node": "^20 || ^22 || >=24"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": ">=24.11 <25",
+      "onFail": "error"
+    },
+    "packageManager": {
+      "name": "pnpm",
+      "version": ">=10.27 <11",
+      "onFail": "error"
+    }
   },
   "type": "module",
   "exports": {
@@ -32,17 +43,17 @@
     "dist"
   ],
   "devDependencies": {
-    "@trivago/prettier-plugin-sort-imports": "5.2.2",
-    "@types/node": "22.18.6",
-    "@vitest/coverage-istanbul": "3.2.4",
-    "eslint": "9.36.0",
+    "@trivago/prettier-plugin-sort-imports": "6.0.2",
+    "@types/node": "24.10.7",
+    "@vitest/coverage-v8": "4.0.17",
+    "eslint": "9.39.2",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-unused-imports": "4.2.0",
-    "prettier": "3.6.2",
-    "tsup": "8.5.0",
-    "typescript": "5.9.2",
-    "typescript-eslint": "8.44.0",
-    "vitest": "3.2.4",
+    "eslint-plugin-unused-imports": "4.3.0",
+    "prettier": "3.7.4",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.53.0",
+    "vitest": "4.0.17",
     "@cronn/shared-configs": "0.0.0"
   },
   "scripts": {