@cronn/lib-file-snapshots 0.7.0 → 0.9.0

package/dist/index.d.ts

@@ -34,17 +34,18 @@ interface JsonSerializerOptions {
     /**
      * Custom normalizers to apply before serialization
      */
-    normalizers?: JsonNormalizer[];
+    normalizers?: Array<JsonNormalizer>;
 }
 type JsonNormalizer = (value: unknown, context: JsonNormalizerContext) => unknown;
 interface JsonNormalizerContext {
     key?: string;
+    index?: number;
 }
 declare class JsonSerializer implements SnapshotSerializer {
     private readonly includeUndefinedObjectProperties;
     private readonly normalizers;
     constructor(options?: JsonSerializerOptions);
-    canSerialize(value: unknown): boolean;
+    canSerialize(_value: unknown): boolean;
     serialize(value: unknown): SnapshotSerializerResult;
     private normalizeValueRecursive;
     private normalizeNumber;
@@ -62,7 +63,7 @@ interface TextSerializerOptions {
     /**
      * Custom normalizers to apply before serialization
      */
-    normalizers?: TextNormalizer[];
+    normalizers?: Array<TextNormalizer>;
 }
 type TextNormalizer = (value: string) => string;
 declare class TextSerializer implements SnapshotSerializer {
@@ -99,18 +100,25 @@ interface MatchValidationFileOptions {
      *
      * @example ["test A", "when x, then y"]
      */
-    titlePath: string[];
+    titlePath: Array<string>;
     /**
      * Unique name of the file snapshot
      *
      * Used to distinguish multiple file snapshots within the same `test`.
      */
     name?: string;
+    /**
+     * The naming strategy to use for storing the file snapshot
+     *
+     * @default "file"
+     */
+    namingStrategy?: SnapshotNamingStrategy;
     /**
      * The serializer to use for the snapshot
      */
     serializer: SnapshotSerializer;
 }
+type SnapshotNamingStrategy = "file" | "fileSuffix";
 interface ValidationFileMatcherResult {
     actual: string;
     expected: string;
@@ -125,12 +133,13 @@ declare class ValidationFileMatcher {
     constructor(config?: ValidationFileMatcherConfig);
     matchFileSnapshot(actual: unknown, options: MatchValidationFileOptions): ValidationFileMatcherResult;
     private buildValidationFilePath;
+    private applyNamingStrategy;
     private writeFileSnapshots;
 }
 
 declare function isString(value: unknown): value is string;
-declare function isArray(value: unknown): value is unknown[];
+declare function isArray(value: unknown): value is Array<unknown>;
 type PlainObject = Record<PropertyKey, unknown>;
 declare function isPlainObject(value: unknown): value is PlainObject;
 
-export { type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type PlainObject, type SnapshotSerializer, type TextNormalizer, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString };
+export { type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type PlainObject, type SnapshotNamingStrategy, type SnapshotSerializer, type TextNormalizer, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString };

package/dist/index.js

@@ -24,7 +24,7 @@ var JsonSerializer = class {
     this.includeUndefinedObjectProperties = options.includeUndefinedObjectProperties ?? false;
     this.normalizers = options.normalizers ?? [];
   }
-  canSerialize(value) {
+  canSerialize(_value) {
     return true;
   }
   serialize(value) {
@@ -100,7 +100,7 @@ var JsonSerializer = class {
   }
   normalizeArray(value) {
     return value.map(
-      (item, index) => this.normalizeValueRecursive(item, { key: index.toString() })
+      (item, index) => this.normalizeValueRecursive(item, { index })
     );
   }
   normalizeObject(value) {
@@ -214,7 +214,7 @@ import * as path from "path";
 import fs from "fs";
 var NEW_LINE_SEPARATOR = "\n";
 function normalizeFileName(testName) {
-  return testName.replaceAll(/\+0/g, "0").replaceAll(/'([\w ]+)'/g, "$1").replaceAll(/[ .:']/g, "_").replaceAll(/[,$]/g, "");
+  return testName.replaceAll(/[+*%~<>?!$#'"`|\\/()[\]{}]/g, "").replaceAll(/[\s.:,;]+/g, "_").replaceAll(/_{2,}/g, "_");
 }
 function mkdirRecursive(path2) {
   fs.mkdirSync(path2, { recursive: true });
@@ -245,7 +245,7 @@ var ValidationFileMatcher = class {
     this.outputDir = config.outputDir ?? "data/test/output";
   }
   matchFileSnapshot(actual, options) {
-    const { testPath, titlePath, name, serializer } = options;
+    const { testPath, titlePath, name, namingStrategy, serializer } = options;
     if (!serializer.canSerialize(actual)) {
       throw new Error(`Cannot serialize value of type ${typeof actual}`);
     }
@@ -254,6 +254,7 @@ var ValidationFileMatcher = class {
       titlePath,
       testPath,
       name,
+      namingStrategy,
       fileExtension: serializerResult.fileExtension
     });
     return this.writeFileSnapshots(
@@ -262,13 +263,25 @@ var ValidationFileMatcher = class {
     );
   }
   buildValidationFilePath(options) {
-    const { testPath, titlePath, name, fileExtension } = options;
+    const { testPath, titlePath, name, namingStrategy, 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);
+    const filePath = path.join(testPath, ...normalizedTitlePath);
+    const fullFilePath = this.applyNamingStrategy(
+      filePath,
+      name,
+      namingStrategy
+    );
+    return `${fullFilePath}.${fileExtension}`;
+  }
+  applyNamingStrategy(filePath, snapshotName, namingStrategy) {
+    if (snapshotName === void 0) {
+      return filePath;
+    }
+    const normalizedSnapshotName = normalizeFileName(snapshotName);
+    if (namingStrategy === "fileSuffix") {
+      return `${filePath}_${normalizedSnapshotName}`;
+    }
+    return path.join(filePath, normalizedSnapshotName);
   }
   writeFileSnapshots(actual, validationFilePath) {
     const validationFileDir = path.dirname(validationFilePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
@@ -32,21 +32,29 @@
     "dist"
   ],
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
+    "@trivago/prettier-plugin-sort-imports": "5.2.2",
     "@types/node": "22.15.30",
     "@vitest/coverage-istanbul": "3.2.4",
+    "eslint": "9.30.1",
+    "eslint-config-prettier": "10.1.5",
+    "eslint-plugin-unused-imports": "4.1.4",
+    "jiti": "2.4.2",
+    "prettier": "3.6.2",
     "tsup": "8.5.0",
     "typescript": "5.8.3",
+    "typescript-eslint": "8.36.0",
     "vitest": "3.2.4",
     "@cronn/shared-configs": "0.0.0"
   },
   "scripts": {
-    "check": "biome check .",
-    "check:fix": "biome check --write .",
+    "lint:check": "eslint src/ --max-warnings=0",
+    "lint:fix": "eslint src/ --max-warnings=0 --fix",
+    "check": "pnpm run compile && pnpm run lint:check",
+    "fix": "pnpm run lint:fix",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "compile": "tsc",
     "build": "tsup",
-    "ci": "biome ci . && pnpm run compile && pnpm run test:coverage && pnpm run build"
+    "ci": "pnpm run check && pnpm run test:coverage && pnpm run build"
   }
 }