@cronn/lib-file-snapshots 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -24,13 +24,6 @@ interface SnapshotSerializerResult {
     fileExtension: string;
 }
 
-declare class CompositeSerializer implements SnapshotSerializer {
-    private readonly serializers;
-    constructor(serializers: SnapshotSerializer[]);
-    canSerialize(value: unknown): boolean;
-    serialize(value: unknown): SnapshotSerializerResult;
-}
-
 interface JsonSerializerOptions {
     /**
      * Serializes `undefined` properties in objects. By default, they are omitted.
@@ -63,13 +56,6 @@ declare class TextSerializer implements SnapshotSerializer {
 }
 
 interface ValidationFileMatcherConfig {
-    /**
-     * Base directory for tests
-     *
-     * The paths of snapshot files will be relative to this directory.
-     * @default "."
-     */
-    baseDir?: string;
     /**
      * Directory in which golden masters are stored
      *
@@ -85,21 +71,23 @@ interface ValidationFileMatcherConfig {
 }
 interface MatchValidationFileOptions {
     /**
-     * The full name of the test, including the names of nested describe blocks
+     * The full path to the current test file
      *
-     * @example ["test feature", "when x, then y"]
+     * @example "src/tests/feature.test.ts"
      */
-    testName: string[];
+    testPath: string;
     /**
-     * The directory in which the current test is located
+     * The full path of titles describing the current test, including nested blocks
+     *
+     * @example ["test A", "when x, then y"]
      */
-    testDir: string;
+    titlePath: string[];
     /**
-     * Appends `fileSuffix` to the generated snapshot file
+     * Unique name of the file snapshot
      *
-     * Should be used whenever having multiple snapshot assertions in a single `test`.
+     * Used to distinguish multiple file snapshots within the same `test`.
      */
-    fileSuffix?: string;
+    name?: string;
     /**
      * The serializer to use for the snapshot
      */
@@ -110,10 +98,10 @@ interface ValidationFileMatcherResult {
     expected: string;
     actualFile: string;
     validationFile: string;
+    message: () => string;
 }
 
 declare class ValidationFileMatcher {
-    private readonly baseDir;
     private readonly validationDir;
     private readonly outputDir;
     constructor(config?: ValidationFileMatcherConfig);
@@ -122,4 +110,4 @@ declare class ValidationFileMatcher {
     private writeFileSnapshots;
 }
 
-export { CompositeSerializer, JsonSerializer, TextSerializer, ValidationFileMatcher };
+export { JsonSerializer, type SnapshotSerializer, TextSerializer, ValidationFileMatcher };

package/dist/index.js

@@ -1,24 +1,3 @@
-// src/serializers/composite-serializer.ts
-var CompositeSerializer = class {
-  serializers;
-  constructor(serializers) {
-    this.serializers = serializers;
-  }
-  canSerialize(value) {
-    return this.serializers.some(
-      (serializer) => serializer.canSerialize(value)
-    );
-  }
-  serialize(value) {
-    for (const serializer of this.serializers) {
-      if (serializer.canSerialize(value)) {
-        return serializer.serialize(value);
-      }
-    }
-    throw new Error(`Missing serializer for value of type ${typeof value}.`);
-  }
-};
-
 // src/utils/guards.ts
 function isArray(value) {
   return Array.isArray(value);
@@ -204,7 +183,6 @@ var TextSerializer = class {
 // src/matcher/validation-file-matcher.ts
 import * as fs2 from "fs";
 import * as path from "path";
-import "vitest";
 
 // src/utils/file.ts
 import fs from "fs";
@@ -234,24 +212,22 @@ function addMissingFileMarker(data) {
 
 // src/matcher/validation-file-matcher.ts
 var ValidationFileMatcher = class {
-  baseDir;
   validationDir;
   outputDir;
   constructor(config = {}) {
-    this.baseDir = config.baseDir ?? ".";
     this.validationDir = config.validationDir ?? "data/test/validation";
     this.outputDir = config.outputDir ?? "data/test/output";
   }
   matchFileSnapshot(actual, options) {
-    const { testName, testDir, fileSuffix, serializer } = options;
+    const { testPath, titlePath, name, serializer } = options;
     if (!serializer.canSerialize(actual)) {
       throw new Error(`Cannot serialize value of type ${typeof actual}`);
     }
     const serializerResult = serializer.serialize(actual);
     const validationFilePath = this.buildValidationFilePath({
-      testName,
-      testDir,
-      fileSuffix,
+      titlePath,
+      testPath,
+      name,
       fileExtension: serializerResult.fileExtension
     });
     return this.writeFileSnapshots(
@@ -260,20 +236,13 @@ var ValidationFileMatcher = class {
     );
   }
   buildValidationFilePath(options) {
-    const { testName, testDir, fileSuffix, fileExtension } = options;
-    const normalizedTestNames = testName.map(normalizeFileName);
-    const normalizedFileSuffix = fileSuffix !== void 0 ? `_${normalizeFileName(fileSuffix)}` : "";
-    const normalizedTestName = normalizedTestNames.pop();
-    const absoluteValidationFilePath = path.join(
-      testDir,
-      ...normalizedTestNames
-    );
-    const relativeValidationFilePath = path.relative(
-      this.baseDir,
-      absoluteValidationFilePath
-    );
-    const validationFileName = `${normalizedTestName}${normalizedFileSuffix}.${fileExtension}`;
-    return path.join(relativeValidationFilePath, validationFileName);
+    const { testPath, titlePath, name, fileExtension } = options;
+    const normalizedTitlePath = titlePath.map(normalizeFileName);
+    const normalizedFileName = name !== void 0 ? `_${normalizeFileName(name)}` : "";
+    const normalizedTestName = normalizedTitlePath.pop();
+    const validationFilePath = path.join(testPath, ...normalizedTitlePath);
+    const validationFileName = `${normalizedTestName}${normalizedFileName}.${fileExtension}`;
+    return path.join(validationFilePath, validationFileName);
   }
   writeFileSnapshots(actual, validationFilePath) {
     const validationFileDir = path.dirname(validationFilePath);
@@ -291,12 +260,13 @@ var ValidationFileMatcher = class {
       actual: readSnapshotFile(actualFile),
       expected: readSnapshotFile(validationFile),
       actualFile,
-      validationFile
+      validationFile,
+      message: () => `Actual file '${actualFile}'
+does not match validation file '${validationFile}'`
     };
   }
 };
 export {
-  CompositeSerializer,
   JsonSerializer,
   TextSerializer,
   ValidationFileMatcher

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
   ],
   "bugs": {
-    "url": "https://github.com/cronn/vitest-file-snapshots/issues"
+    "url": "https://github.com/cronn/file-snapshots/issues"
   },
   "author": "cronn",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/cronn/vitest-file-snapshots.git",
+    "url": "https://github.com/cronn/file-snapshots.git",
     "directory": "packages/lib-file-snapshots"
   },
-  "homepage": "https://github.com/cronn/vitest-file-snapshots",
+  "homepage": "https://github.com/cronn/file-snapshots",
   "engines": {
     "node": ">=22",
     "pnpm": ">=10"
@@ -33,11 +33,11 @@
   ],
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "@types/node": "22.15.29",
-    "@vitest/coverage-istanbul": "3.1.4",
+    "@types/node": "22.15.30",
+    "@vitest/coverage-istanbul": "3.2.4",
     "tsup": "8.5.0",
     "typescript": "5.8.3",
-    "vitest": "3.1.4",
+    "vitest": "3.2.4",
     "@cronn/shared-configs": "0.0.0"
   },
   "scripts": {