@cronn/lib-file-snapshots 1.0.1 → 1.1.0

package/dist/index.d.mts

@@ -1,5 +1,29 @@
+//#region src/models/table.d.ts
+interface TableData<TRow extends TableRow = TableRow> {
+  columns: Array<string>;
+  rows: Array<TRow>;
+}
+type TableRow = Array<TableCell>;
+type TableCell = string | number | boolean | null | undefined;
+type TableRowRecord = Record<string, TableCell>;
+declare class Table<TRow extends TableRow = TableRow> implements TableData<TRow> {
+  readonly columns: Array<string>;
+  readonly rows: Array<TRow>;
+  private constructor();
+  /**
+   * Defines a table
+   */
+  static define<TRow extends TableRow>(data: TableData<TRow>): Table<TRow>;
+  /**
+   * Defines a table from record-based rows
+   *
+   * Columns are derived from keys, rows from values.
+   */
+  static fromRecords<TRow extends TableRowRecord>(rows: Array<TRow>): Table;
+}
+//#endregion
 //#region src/types/serializer.d.ts
-interface SnapshotSerializer {
+interface SnapshotSerializer<TValue> {
   /**
    * The file extension associated with the serialized value
    */
@@ -11,7 +35,7 @@ interface SnapshotSerializer {
    * @return {string} The serialized value
    * @throws {Error} Will throw an error if value cannot be serialized.
    */
-  serialize(value: unknown): string;
+  serialize(value: TValue): string;
 }
 //#endregion
 //#region src/serializers/json-serializer.d.ts
@@ -38,7 +62,7 @@ interface JsonNormalizerContext {
   key?: string;
   index?: number;
 }
-declare class JsonSerializer implements SnapshotSerializer {
+declare class JsonSerializer implements SnapshotSerializer<unknown> {
   readonly fileExtension = "json";
   private readonly includeUndefinedObjectProperties;
   private readonly normalizers;
@@ -57,6 +81,23 @@ declare class JsonSerializer implements SnapshotSerializer {
   private applyCustomNormalizers;
 }
 //#endregion
+//#region src/serializers/markdown-table-serializer.d.ts
+interface MarkdownTableSerializerOptions {
+  /**
+   * Custom normalizers to apply before serialization
+   */
+  normalizers?: Array<MarkdownTableNormalizer>;
+}
+type MarkdownTableNormalizer = (value: TableCell) => TableCell;
+declare class MarkdownTableSerializer implements SnapshotSerializer<TableData> {
+  readonly fileExtension = "md";
+  private readonly normalizers;
+  constructor(options?: MarkdownTableSerializerOptions);
+  serialize(value: TableData): string;
+  private serializeCellValue;
+  private mapCellValueToString;
+}
+//#endregion
 //#region src/serializers/text-serializer.d.ts
 interface TextSerializerOptions {
   /**
@@ -71,16 +112,16 @@ interface TextSerializerOptions {
   fileExtension?: string;
 }
 type TextNormalizer = (value: string) => string;
-declare class TextSerializer implements SnapshotSerializer {
+declare class TextSerializer implements SnapshotSerializer<string> {
   readonly fileExtension: string;
   private readonly normalizers;
   constructor(options?: TextSerializerOptions);
-  serialize(value: unknown): string;
+  serialize(value: string): string;
   private normalizeValue;
 }
 //#endregion
 //#region src/types/matcher.d.ts
-interface ValidationFileMatcherConfig {
+interface ValidationFileMatcherConfig<TValue> {
   /**
    * Directory in which golden masters are stored
    */
@@ -98,7 +139,7 @@ interface ValidationFileMatcherConfig {
   /**
    * The serializer to use for the snapshot
    */
-  serializer: SnapshotSerializer;
+  serializer: SnapshotSerializer<TValue>;
   /**
    * Whether to update golden masters with the actual result.
    *
@@ -123,15 +164,15 @@ interface FilePathResolverParams {
 }
 //#endregion
 //#region src/matcher/validation-file-matcher.d.ts
-declare class ValidationFileMatcher {
+declare class ValidationFileMatcher<TValue> {
   private readonly updateSnapshots;
   private readonly serializer;
   private readonly filePaths;
   private validationFile;
-  constructor(config: ValidationFileMatcherConfig);
+  constructor(config: ValidationFileMatcherConfig<TValue>);
   get isValidationFileMissing(): boolean;
   get isUpdate(): boolean;
-  matchFileSnapshot(actual: unknown): ValidationFileMatcherResult;
+  matchFileSnapshot(actual: TValue): ValidationFileMatcherResult;
   private buildFilePaths;
   private readValidationFile;
   private createMatcherResult;
@@ -152,4 +193,4 @@ declare function isArray(value: unknown): value is Array<unknown>;
 type PlainObject = Record<PropertyKey, unknown>;
 declare function isPlainObject(value: unknown): value is PlainObject;
 //#endregion
-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 };
+export { type FilePathResolver, type FilePathResolverParams, type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type MarkdownTableNormalizer, MarkdownTableSerializer, type PlainObject, type SnapshotSerializer, Table, type TableCell, type TableData, type TableRow, type TextNormalizer, TextSerializer, type UpdateSnapshotsType, ValidationFileMatcher, type ValidationFileMatcherResult, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };

package/dist/index.mjs

@@ -3,7 +3,35 @@ import fs from "node:fs";
 import os from "node:os";
 import * as path$1 from "node:path";
 import path from "node:path";
-
+import { markdownTable } from "markdown-table";
+//#region src/models/table.ts
+var Table = class Table {
+	columns;
+	rows;
+	constructor(data) {
+		this.columns = data.columns;
+		this.rows = data.rows;
+	}
+	/**
+	* Defines a table
+	*/
+	static define(data) {
+		return new Table(data);
+	}
+	/**
+	* Defines a table from record-based rows
+	*
+	* Columns are derived from keys, rows from values.
+	*/
+	static fromRecords(rows) {
+		const [firstRow] = rows;
+		return new Table({
+			columns: firstRow !== void 0 ? Object.keys(firstRow) : [],
+			rows: rows.map((row) => Object.values(row))
+		});
+	}
+};
+//#endregion
 //#region src/utils/file.ts
 const NEW_LINE_SEPARATOR = "\n";
 const EMOJI_REGEXP = /(?!(\*|#|\d))[\p{Extended_Pictographic}\p{Emoji_Component}]|[\u0030-\u0039]\ufe0f?[\u20e3]|[\u002A\u0023]?\ufe0f?[\u20e3]/gu;
@@ -28,7 +56,6 @@ function addTrailingNewLine(data) {
 function addMissingFileMarker(data) {
 	return `===== missing file =====${NEW_LINE_SEPARATOR}${data}`;
 }
-
 //#endregion
 //#region src/utils/guards.ts
 function isString(value) {
@@ -45,13 +72,11 @@ function isPlainObject(value) {
 	const proto = Object.getPrototypeOf(value);
 	return proto === null || proto === Object.prototype;
 }
-
 //#endregion
 //#region src/utils/validators.ts
 function isPositiveInteger(value) {
 	return Number.isInteger(value) && value > 0;
 }
-
 //#endregion
 //#region src/serializers/json-serializer.ts
 var JsonSerializer = class {
@@ -142,7 +167,30 @@ var JsonSerializer = class {
 		return normalizedValue;
 	}
 };
-
+//#endregion
+//#region src/serializers/markdown-table-serializer.ts
+var MarkdownTableSerializer = class {
+	fileExtension = "md";
+	normalizers;
+	constructor(options = {}) {
+		this.normalizers = options.normalizers ?? [];
+	}
+	serialize(value) {
+		const { columns, rows } = value;
+		if (columns.length === 0) throw new Error("Markdown table must have at least one column.");
+		return addTrailingNewLine(markdownTable([columns, ...rows.map((row) => row.map((cellValue) => this.serializeCellValue(cellValue)))]));
+	}
+	serializeCellValue(value) {
+		let normalizedValue = value;
+		for (const normalizer of this.normalizers) normalizedValue = normalizer(normalizedValue);
+		return this.mapCellValueToString(normalizedValue);
+	}
+	mapCellValueToString(value) {
+		if (value === void 0) return "undefined";
+		if (value === null) return "null";
+		return value.toString().trim();
+	}
+};
 //#endregion
 //#region src/serializers/text-serializer.ts
 var TextSerializer = class {
@@ -153,7 +201,6 @@ var TextSerializer = class {
 		this.fileExtension = options.fileExtension ?? "txt";
 	}
 	serialize(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) {
@@ -162,7 +209,6 @@ var TextSerializer = class {
 		return normalizedValue.trim();
 	}
 };
-
 //#endregion
 //#region src/matcher/validation-file-matcher.ts
 var ValidationFileMatcher = class {
@@ -231,7 +277,6 @@ var ValidationFileMatcher = class {
 		return this.validationFile;
 	}
 };
-
 //#endregion
 //#region src/matcher/file-path-resolver.ts
 function resolveNameAsFile(params) {
@@ -254,6 +299,5 @@ function resolveFilePath(params, resolveNamedFilePath) {
 		normalizedName: normalizeFileName(name)
 	});
 }
-
 //#endregion
-export { JsonSerializer, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };
+export { JsonSerializer, MarkdownTableSerializer, Table, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
@@ -22,12 +22,12 @@
   "devEngines": {
     "runtime": {
       "name": "node",
-      "version": ">=24.13 <25",
+      "version": ">=24.14.1 <25",
       "onFail": "error"
     },
     "packageManager": {
       "name": "pnpm",
-      "version": ">=10.28.2 <11",
+      "version": ">=10.33.0 <11",
       "onFail": "error"
     }
   },
@@ -45,18 +45,20 @@
   "devDependencies": {
     "@arethetypeswrong/core": "0.18.2",
     "@trivago/prettier-plugin-sort-imports": "6.0.2",
-    "@types/node": "24.11.0",
-    "@typescript/native-preview": "7.0.0-dev.20260302.1",
-    "@vitest/coverage-v8": "4.0.18",
-    "eslint": "10.0.2",
+    "@types/node": "24.12.2",
+    "@typescript/native-preview": "7.0.0-dev.20260406.1",
+    "@vitest/coverage-v8": "4.1.4",
+    "eslint": "10.2.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-check-file": "3.3.1",
     "eslint-plugin-unused-imports": "4.4.1",
+    "markdown-table": "3.0.4",
     "prettier": "3.8.1",
     "publint": "0.3.18",
-    "tsdown": "0.20.3",
-    "typescript-eslint": "8.56.1",
-    "vitest": "4.0.18",
+    "rimraf": "6.1.3",
+    "tsdown": "0.21.7",
+    "typescript-eslint": "8.58.0",
+    "vitest": "4.1.4",
     "@cronn/shared-configs": "0.0.0"
   },
   "scripts": {
@@ -65,6 +67,7 @@
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "compile": "tsgo",
-    "build": "tsdown"
+    "build": "tsdown",
+    "clean": "rimraf .turbo dist coverage"
   }
 }