path-serializer 0.1.4 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # path-serializer
 
- <a href="https://www.npmjs.com/package/path-serializer"><img src="https://img.shields.io/npm/v/path-serializer?style=flat-square&color=98c379" alt="latest version" /></a>
+[![npm latest version](https://img.shields.io/npm/v/path-serializer?style=flat-square&color=98c379)](https://www.npmjs.com/package/path-serializer)
 
 ```ts
 // __snapshots__/index.test.ts.snap
@@ -22,6 +22,8 @@ expect.addSnapshotSerializer(
 );
 ```
 
+The specific usage can be found in [./src/types.ts](https://github.com/rspack-contrib/path-serializer/blob/main/src/types.ts)
+
 ## Showcases
 
 [Rslib](https://github.com/web-infra-dev/rslib/blob/3ff6859eb38171c731e447a1364afc021f8c501a/tests/setupVitestTests.ts)

package/dist/cjs/index.d.ts

@@ -20,7 +20,7 @@ declare interface Features {
     /**
      * @default true
      */
-    ansiDoubleQuotes?: boolean;
+    replaceHomeDir?: boolean;
     /**
      * @default true
      */
@@ -29,6 +29,14 @@ declare interface Features {
      * @default true
      */
     transformWin32Path?: boolean;
+    /**
+     * @default true
+     */
+    escapeDoubleQuotes?: boolean;
+    /**
+     * @default true
+     */
+    escapeEOL?: boolean;
 }
 
 declare interface PathMatcher {
@@ -44,9 +52,26 @@ declare interface SnapshotSerializer {
 }
 
 declare interface SnapshotSerializerOptions {
-    cwd?: string;
+    /**
+     * repository root path
+     * @example '/Users/foo/codes/rsbuild/node_modules/.pnpm' -> '<ROOT>/node_modules/.pnpm'
+     * @default process.cwd()
+     */
+    root?: string;
+    /**
+     * workspace root path
+     * @example '/Users/foo/codes/rsbuild/packages/core/src' -> '<WORKSPACE>/src'
+     * @default ''
+     */
     workspace?: string;
+    /**
+     * @description replace -> workspace root pnpmInner temp home -> replacePost
+     */
     replace?: PathMatcher[];
+    /**
+     * @description replace -> workspace root pnpmInner temp home -> replacePost
+     */
+    replacePost?: PathMatcher[];
     features?: Features;
 }
 

package/dist/cjs/{index.cjs → index.js}

@@ -425,8 +425,8 @@ function __webpack_require__(moduleId) {
     /** Detect free variable `global` from Node.js. */ var freeGlobal = 'object' == typeof global && global && global.Object === Object && global;
     /* harmony default export */ const _freeGlobal = freeGlobal;
     /** Detect free variable `self`. */ var freeSelf = 'object' == typeof self && self && self.Object === Object && self;
-    /** Used as a reference to the global object. */ var root = _freeGlobal || freeSelf || Function('return this')();
-    /* harmony default export */ const _root = root;
+    /** Used as a reference to the global object. */ var _root_root = _freeGlobal || freeSelf || Function('return this')();
+    /* harmony default export */ const _root = _root_root;
     /** Built-in value references. */ var Symbol1 = _root.Symbol;
     /* harmony default export */ const _Symbol = Symbol1;
     /**
@@ -834,17 +834,23 @@ function __webpack_require__(moduleId) {
     }
     const createTmpDirMatchers = ()=>{
         const ret = [];
-        const tmpdir = getRealTemporaryDirectory();
-        tmpdir && ret.push({
-            match: tmpdir,
+        const realTmpDir = getRealTemporaryDirectory();
+        realTmpDir && ret.push({
+            match: realTmpDir,
             mark: 'temp'
         });
-        ret.push({
-            match: external_node_os_default().tmpdir(),
+        const tmpDir = external_node_os_default().tmpdir();
+        tmpDir && ret.push({
+            match: tmpDir,
             mark: 'temp'
         });
-        ret.push({
-            match: external_node_os_default().homedir(),
+        return ret;
+    };
+    const createHomeDirMatchers = ()=>{
+        const ret = [];
+        const homedir = external_node_os_default().homedir();
+        homedir && ret.push({
+            match: homedir,
             mark: 'home'
         });
         return ret;
@@ -866,21 +872,23 @@ function __webpack_require__(moduleId) {
         /(?<![a-zA-Z])([a-zA-Z]:[\\/])([-\u4e00-\u9fa5\w\s.()~!@#$%^&()\[\]{}+=]+[\\/])*/g, (match, _diskName)=>normalizeToPosixPath(match));
     }
     function createSnapshotSerializer(options) {
-        const { cwd = process.cwd(), workspace = process.cwd(), replace: customMatchers = [], features = {} } = options || {};
-        const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, ansiDoubleQuotes = true, addDoubleQuotes = true, transformWin32Path = true } = features;
+        const { root = process.cwd(), workspace = '', replace: customMatchers = [], replacePost: customPostMatchers = [], features = {} } = options || {};
+        const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, replaceHomeDir = true, addDoubleQuotes = true, transformWin32Path = true, escapeDoubleQuotes = true, escapeEOL = true } = features;
         function createPathMatchers() {
             const pathMatchers = [];
-            if (replaceRoot) pathMatchers.push({
-                mark: 'root',
-                match: cwd
-            });
-            if (replaceWorkspace) pathMatchers.push({
+            pathMatchers.push(...customMatchers);
+            if (replaceWorkspace && workspace) pathMatchers.push({
                 mark: 'workspace',
                 match: workspace
             });
+            if (replaceRoot && root) pathMatchers.push({
+                mark: 'root',
+                match: root
+            });
             if (replacePnpmInner) pathMatchers.push(...createPnpmInnerMatchers());
-            pathMatchers.push(...customMatchers);
             if (replaceTmpDir) pathMatchers.push(...createTmpDirMatchers());
+            if (replaceHomeDir) pathMatchers.push(...createHomeDirMatchers());
+            pathMatchers.push(...customPostMatchers);
             return pathMatchers;
         }
         const pathMatchers = createPathMatchers();
@@ -894,7 +902,8 @@ function __webpack_require__(moduleId) {
                 let replaced = val;
                 if (transformWin32Path) replaced = transformCodeToPosixPath(replaced);
                 replaced = applyMatcherReplacement(pathMatchers, replaced);
-                if (ansiDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
+                if (escapeDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
+                if (escapeEOL) replaced = replaced.replace(/\\r\\n/g, '\n');
                 if (addDoubleQuotes) replaced = `"${replaced}"`;
                 return replaced;
             }

package/dist/esm/index.d.ts

@@ -20,7 +20,7 @@ declare interface Features {
     /**
      * @default true
      */
-    ansiDoubleQuotes?: boolean;
+    replaceHomeDir?: boolean;
     /**
      * @default true
      */
@@ -29,6 +29,14 @@ declare interface Features {
      * @default true
      */
     transformWin32Path?: boolean;
+    /**
+     * @default true
+     */
+    escapeDoubleQuotes?: boolean;
+    /**
+     * @default true
+     */
+    escapeEOL?: boolean;
 }
 
 declare interface PathMatcher {
@@ -44,9 +52,26 @@ declare interface SnapshotSerializer {
 }
 
 declare interface SnapshotSerializerOptions {
-    cwd?: string;
+    /**
+     * repository root path
+     * @example '/Users/foo/codes/rsbuild/node_modules/.pnpm' -> '<ROOT>/node_modules/.pnpm'
+     * @default process.cwd()
+     */
+    root?: string;
+    /**
+     * workspace root path
+     * @example '/Users/foo/codes/rsbuild/packages/core/src' -> '<WORKSPACE>/src'
+     * @default ''
+     */
     workspace?: string;
+    /**
+     * @description replace -> workspace root pnpmInner temp home -> replacePost
+     */
     replace?: PathMatcher[];
+    /**
+     * @description replace -> workspace root pnpmInner temp home -> replacePost
+     */
+    replacePost?: PathMatcher[];
     features?: Features;
 }
 

package/dist/esm/{index.js → index.mjs}

@@ -406,8 +406,8 @@ function __webpack_require__(moduleId) {
 /** Detect free variable `global` from Node.js. */ var freeGlobal = 'object' == typeof global && global && global.Object === Object && global;
 /* harmony default export */ const _freeGlobal = freeGlobal;
 /** Detect free variable `self`. */ var freeSelf = 'object' == typeof self && self && self.Object === Object && self;
-/** Used as a reference to the global object. */ var root = _freeGlobal || freeSelf || Function('return this')();
-/* harmony default export */ const _root = root;
+/** Used as a reference to the global object. */ var _root_root = _freeGlobal || freeSelf || Function('return this')();
+/* harmony default export */ const _root = _root_root;
 /** Built-in value references. */ var Symbol = _root.Symbol;
 /* harmony default export */ const _Symbol = Symbol;
 /**
@@ -809,17 +809,23 @@ function applyMatcherReplacement(matchers, str, options = {}) {
 }
 const createTmpDirMatchers = ()=>{
     const ret = [];
-    const tmpdir = getRealTemporaryDirectory();
-    tmpdir && ret.push({
-        match: tmpdir,
+    const realTmpDir = getRealTemporaryDirectory();
+    realTmpDir && ret.push({
+        match: realTmpDir,
         mark: 'temp'
     });
-    ret.push({
-        match: __WEBPACK_EXTERNAL_MODULE_node_os__["default"].tmpdir(),
+    const tmpDir = __WEBPACK_EXTERNAL_MODULE_node_os__["default"].tmpdir();
+    tmpDir && ret.push({
+        match: tmpDir,
         mark: 'temp'
     });
-    ret.push({
-        match: __WEBPACK_EXTERNAL_MODULE_node_os__["default"].homedir(),
+    return ret;
+};
+const createHomeDirMatchers = ()=>{
+    const ret = [];
+    const homedir = __WEBPACK_EXTERNAL_MODULE_node_os__["default"].homedir();
+    homedir && ret.push({
+        match: homedir,
         mark: 'home'
     });
     return ret;
@@ -841,21 +847,23 @@ function transformCodeToPosixPath(code) {
     /(?<![a-zA-Z])([a-zA-Z]:[\\/])([-\u4e00-\u9fa5\w\s.()~!@#$%^&()\[\]{}+=]+[\\/])*/g, (match, _diskName)=>normalizeToPosixPath(match));
 }
 function createSnapshotSerializer(options) {
-    const { cwd = process.cwd(), workspace = process.cwd(), replace: customMatchers = [], features = {} } = options || {};
-    const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, ansiDoubleQuotes = true, addDoubleQuotes = true, transformWin32Path = true } = features;
+    const { root = process.cwd(), workspace = '', replace: customMatchers = [], replacePost: customPostMatchers = [], features = {} } = options || {};
+    const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, replaceHomeDir = true, addDoubleQuotes = true, transformWin32Path = true, escapeDoubleQuotes = true, escapeEOL = true } = features;
     function createPathMatchers() {
         const pathMatchers = [];
-        if (replaceRoot) pathMatchers.push({
-            mark: 'root',
-            match: cwd
-        });
-        if (replaceWorkspace) pathMatchers.push({
+        pathMatchers.push(...customMatchers);
+        if (replaceWorkspace && workspace) pathMatchers.push({
             mark: 'workspace',
             match: workspace
         });
+        if (replaceRoot && root) pathMatchers.push({
+            mark: 'root',
+            match: root
+        });
         if (replacePnpmInner) pathMatchers.push(...createPnpmInnerMatchers());
-        pathMatchers.push(...customMatchers);
         if (replaceTmpDir) pathMatchers.push(...createTmpDirMatchers());
+        if (replaceHomeDir) pathMatchers.push(...createHomeDirMatchers());
+        pathMatchers.push(...customPostMatchers);
         return pathMatchers;
     }
     const pathMatchers = createPathMatchers();
@@ -869,7 +877,8 @@ function createSnapshotSerializer(options) {
             let replaced = val;
             if (transformWin32Path) replaced = transformCodeToPosixPath(replaced);
             replaced = applyMatcherReplacement(pathMatchers, replaced);
-            if (ansiDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
+            if (escapeDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
+            if (escapeEOL) replaced = replaced.replace(/\\r\\n/g, '\n');
             if (addDoubleQuotes) replaced = `"${replaced}"`;
             return replaced;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-serializer",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "path-serializer",
   "keywords": [
     "snapshot",
@@ -9,7 +9,6 @@
     "ci",
     "test"
   ],
-  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/rspack-contrib/path-serializer.git"
@@ -19,13 +18,13 @@
   "exports": {
     ".": {
       "types": "./dist/esm/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.cjs"
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./dist/cjs/index.cjs",
-  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.mjs",
   "types": "./dist/esm/index.d.ts",
   "files": [
     "dist",