feat: add beforeSerialize and afterSerialize (#13)

Author: SoonIter

README.md

@@ -2,8 +2,9 @@
 
 [![npm latest version](https://img.shields.io/npm/v/path-serializer?style=flat-square&color=98c379)](https://www.npmjs.com/package/path-serializer)
 
-1. stabilize pnpm dependencies path and update dependencies smoothly
+1. stabilize pnpm dependencies path in snapshot
 2. transform win32 path to posix path
+3. escapeEOL \r\n -> \n
    and more...
 
 ```ts
@@ -31,7 +32,7 @@ expect.addSnapshotSerializer(
 );
 ```
 
-The specific usage can be found in [./src/types.ts](https://github.com/rspack-contrib/path-serializer/blob/main/src/types.ts)
+More features can be found in [./src/types.ts](https://github.com/rspack-contrib/path-serializer/blob/main/src/types.ts)
 
 ## Showcases
 

src/createSnapshotSerializer.ts

@@ -25,6 +25,8 @@ export function createSnapshotSerializer(
     replace: customMatchers = [],
     replacePost: customPostMatchers = [],
     features = {},
+    beforeSerialize,
+    afterSerialize,
   } = options || {};
 
   const {
@@ -76,6 +78,11 @@ export function createSnapshotSerializer(
     },
     serialize(val: unknown) {
       let replaced: string = val as string;
+
+      if (beforeSerialize) {
+        replaced = beforeSerialize(replaced);
+      }
+
       if (transformWin32Path) {
         replaced = normalizeCodeToPosix(replaced);
       }
@@ -95,6 +102,10 @@ export function createSnapshotSerializer(
       if (addDoubleQuotes) {
         replaced = `"${replaced}"`;
       }
+
+      if (afterSerialize) {
+        replaced = afterSerialize(replaced);
+      }
       return replaced;
     },
   };

src/types.ts

@@ -23,10 +23,12 @@ export interface Features {
    */
   replacePnpmInner?: boolean;
   /**
+   * <TEMP>
    * @default true
    */
   replaceTmpDir?: boolean;
   /**
+   * <HOME>
    * @default true
    */
   replaceHomeDir?: boolean;
@@ -42,6 +44,7 @@ export interface Features {
    */
   transformWin32Path?: boolean;
   /**
+   * "" -> \"\"
    * @default true
    */
   escapeDoubleQuotes?: boolean;
@@ -53,7 +56,7 @@ export interface Features {
   /**
    * \u001b[1mBold Text\u001b[0m
    * -> <CLR=BOLD>Bold Text<CLR=0>
-   * @default true 
+   * @default true
    */
   transformCLR?: boolean;
 }
@@ -72,13 +75,21 @@ export interface SnapshotSerializerOptions {
    */
   workspace?: string;
   /**
-   * @description replace -> workspace root pnpmInner temp home -> replacePost
+   * @description beforeSerialize -> replace -> workspace root pnpmInner temp home -> replacePost -> afterSerialize
+   */
+  beforeSerialize?: (val: string) => string;
+  /**
+   * @description beforeSerialize -> replace -> workspace root pnpmInner temp home -> replacePost -> afterSerialize
    */
   replace?: PathMatcher[];
   /**
-   * @description replace -> workspace root pnpmInner temp home -> replacePost
+   * @description beforeSerialize -> replace -> workspace root pnpmInner temp home -> replacePost -> afterSerialize
    */
   replacePost?: PathMatcher[];
+  /**
+   * @description beforeSerialize -> replace -> workspace root pnpmInner temp home -> replacePost -> afterSerialize
+   */
+  afterSerialize?: (val: string) => string;
   features?: Features;
 }