@cronn/lib-file-snapshots 0.19.1 → 1.0.1

package/dist/index.d.mts

@@ -4,12 +4,6 @@ interface SnapshotSerializer {
    * The file extension associated with the serialized value
    */
   readonly fileExtension: string;
-  /**
-   * Returns true when value can be serialized
-   *
-   * @param value The value to be serialized
-   */
-  canSerialize(value: unknown): boolean;
   /**
    * Serializes value
    *
@@ -50,7 +44,6 @@ declare class JsonSerializer implements SnapshotSerializer {
   private readonly normalizers;
   private readonly indentSize;
   constructor(options?: JsonSerializerOptions);
-  canSerialize(_value: unknown): boolean;
   serialize(value: unknown): string;
   private normalizeValueRecursive;
   private normalizeNumber;
@@ -82,7 +75,6 @@ declare class TextSerializer implements SnapshotSerializer {
   readonly fileExtension: string;
   private readonly normalizers;
   constructor(options?: TextSerializerOptions);
-  canSerialize(value: unknown): value is string;
   serialize(value: unknown): string;
   private normalizeValue;
 }

package/dist/index.mjs

@@ -10,17 +10,17 @@ const EMOJI_REGEXP = /(?!(\*|#|\d))[\p{Extended_Pictographic}\p{Emoji_Component}
 function normalizeFileName(testName) {
 	return testName.replaceAll(EMOJI_REGEXP, "").replaceAll(/[+*%~<>?!$#'"`|\\/()[\]{}]/g, "").replaceAll(/[\s.:,;]+/g, "_").replaceAll(/_{2,}/g, "_");
 }
-function readSnapshotFile(path) {
-	const contents = fs.readFileSync(path, { encoding: "utf8" });
+function readSnapshotFile(filePath) {
+	const contents = fs.readFileSync(filePath, { 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));
-	fs.writeFileSync(file, data, { encoding: "utf8" });
+function writeSnapshotFile(filePath, data) {
+	mkdirRecursive(path.dirname(filePath));
+	fs.writeFileSync(filePath, data, { encoding: "utf8" });
 }
-function mkdirRecursive(path) {
-	fs.mkdirSync(path, { recursive: true });
+function mkdirRecursive(dirPath) {
+	fs.mkdirSync(dirPath, { recursive: true });
 }
 function addTrailingNewLine(data) {
 	return `${data}${NEW_LINE_SEPARATOR}`;
@@ -65,9 +65,6 @@ var JsonSerializer = class {
 		this.normalizers = options.normalizers ?? [];
 		this.indentSize = options.indentSize ?? 2;
 	}
-	canSerialize(_value) {
-		return true;
-	}
 	serialize(value) {
 		const jsonValue = this.normalizeValueRecursive(value);
 		return addTrailingNewLine(JSON.stringify(jsonValue, void 0, this.indentSize));
@@ -124,9 +121,9 @@ var JsonSerializer = class {
 		return normalizedObject;
 	}
 	normalizeMap(value) {
-		return Array.from(value.entries()).reduce((object, [key, value]) => {
+		return Array.from(value.entries()).reduce((object, [key, propertyValue]) => {
 			this.assertKeyType(key);
-			object[key] = value;
+			object[key] = propertyValue;
 			return object;
 		}, {});
 	}
@@ -155,11 +152,8 @@ var TextSerializer = class {
 		this.normalizers = options.normalizers ?? [];
 		this.fileExtension = options.fileExtension ?? "txt";
 	}
-	canSerialize(value) {
-		return isString(value);
-	}
 	serialize(value) {
-		if (!this.canSerialize(value)) throw new Error(`Missing text serialization for value of type ${typeof value}.`);
+		if (!isString(value)) throw new Error(`Value of type ${typeof value} cannot be serialized as text. Only strings are supported.`);
 		return addTrailingNewLine(this.normalizeValue(value));
 	}
 	normalizeValue(value) {
@@ -189,7 +183,6 @@ var ValidationFileMatcher = class {
 		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);
 		const expected = this.resolveExpected(serializedActual);
 		return this.createMatcherResult({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "0.19.1",
+  "version": "1.0.1",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
@@ -12,7 +12,7 @@
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/cronn/file-snapshots.git",
+    "url": "git+https://github.com/cronn/file-snapshots.git",
     "directory": "packages/lib-file-snapshots"
   },
   "homepage": "https://github.com/cronn/file-snapshots",
@@ -43,16 +43,19 @@
     "dist"
   ],
   "devDependencies": {
+    "@arethetypeswrong/core": "0.18.2",
     "@trivago/prettier-plugin-sort-imports": "6.0.2",
-    "@types/node": "24.10.12",
+    "@types/node": "24.11.0",
+    "@typescript/native-preview": "7.0.0-dev.20260302.1",
     "@vitest/coverage-v8": "4.0.18",
-    "eslint": "9.39.2",
+    "eslint": "10.0.2",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-unused-imports": "4.3.0",
+    "eslint-plugin-check-file": "3.3.1",
+    "eslint-plugin-unused-imports": "4.4.1",
     "prettier": "3.8.1",
+    "publint": "0.3.18",
     "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.54.0",
+    "typescript-eslint": "8.56.1",
     "vitest": "4.0.18",
     "@cronn/shared-configs": "0.0.0"
   },
@@ -61,7 +64,7 @@
     "lint:fix": "eslint src/ --max-warnings=0 --fix",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "compile": "tsc",
+    "compile": "tsgo",
     "build": "tsdown"
   }
 }