path-serializer 0.2.0 → 0.2.2

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

@@ -17,6 +17,10 @@ declare interface Features {
      * @default true
      */
     replaceTmpDir?: boolean;
+    /**
+     * @default true
+     */
+    replaceHomeDir?: boolean;
     /**
      * @default true
      */
@@ -48,9 +52,25 @@ declare interface SnapshotSerializer {
 }
 
 declare interface SnapshotSerializerOptions {
+    /**
+     * 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.js

@@ -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,22 @@ function __webpack_require__(moduleId) {
         /(?<![a-zA-Z])([a-zA-Z]:[\\/])([-\u4e00-\u9fa5\w\s.()~!@#$%^&()\[\]{}+=]+[\\/])*/g, (match, _diskName)=>normalizeToPosixPath(match));
     }
     function createSnapshotSerializer(options) {
-        const { root = process.cwd(), workspace = process.cwd(), replace: customMatchers = [], replacePost: customPostMatchers = [], features = {} } = options || {};
-        const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, addDoubleQuotes = true, transformWin32Path = true, escapeDoubleQuotes = true, escapeEOL = 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 = [];
             pathMatchers.push(...customMatchers);
-            if (replaceRoot) pathMatchers.push({
-                mark: 'root',
-                match: root
-            });
-            if (replaceWorkspace) pathMatchers.push({
+            if (replaceWorkspace && workspace) pathMatchers.push({
                 mark: 'workspace',
                 match: workspace
             });
+            if (replaceRoot && root) pathMatchers.push({
+                mark: 'root',
+                match: root
+            });
             if (replacePnpmInner) pathMatchers.push(...createPnpmInnerMatchers());
             if (replaceTmpDir) pathMatchers.push(...createTmpDirMatchers());
+            if (replaceHomeDir) pathMatchers.push(...createHomeDirMatchers());
             pathMatchers.push(...customPostMatchers);
             return pathMatchers;
         }
@@ -896,7 +903,7 @@ function __webpack_require__(moduleId) {
                 if (transformWin32Path) replaced = transformCodeToPosixPath(replaced);
                 replaced = applyMatcherReplacement(pathMatchers, replaced);
                 if (escapeDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
-                if (escapeEOL) replaced = replaced.replace(/\\r\\n/g, '\n');
+                if (escapeEOL) replaced = replaced.replace(/\\r\\n/g, '\\n');
                 if (addDoubleQuotes) replaced = `"${replaced}"`;
                 return replaced;
             }

package/dist/esm/index.d.ts

@@ -17,6 +17,10 @@ declare interface Features {
      * @default true
      */
     replaceTmpDir?: boolean;
+    /**
+     * @default true
+     */
+    replaceHomeDir?: boolean;
     /**
      * @default true
      */
@@ -48,9 +52,25 @@ declare interface SnapshotSerializer {
 }
 
 declare interface SnapshotSerializerOptions {
+    /**
+     * 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.mjs

@@ -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,22 @@ function transformCodeToPosixPath(code) {
     /(?<![a-zA-Z])([a-zA-Z]:[\\/])([-\u4e00-\u9fa5\w\s.()~!@#$%^&()\[\]{}+=]+[\\/])*/g, (match, _diskName)=>normalizeToPosixPath(match));
 }
 function createSnapshotSerializer(options) {
-    const { root = process.cwd(), workspace = process.cwd(), replace: customMatchers = [], replacePost: customPostMatchers = [], features = {} } = options || {};
-    const { replaceRoot = true, replaceWorkspace = true, replacePnpmInner = true, replaceTmpDir = true, addDoubleQuotes = true, transformWin32Path = true, escapeDoubleQuotes = true, escapeEOL = 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 = [];
         pathMatchers.push(...customMatchers);
-        if (replaceRoot) pathMatchers.push({
-            mark: 'root',
-            match: root
-        });
-        if (replaceWorkspace) pathMatchers.push({
+        if (replaceWorkspace && workspace) pathMatchers.push({
             mark: 'workspace',
             match: workspace
         });
+        if (replaceRoot && root) pathMatchers.push({
+            mark: 'root',
+            match: root
+        });
         if (replacePnpmInner) pathMatchers.push(...createPnpmInnerMatchers());
         if (replaceTmpDir) pathMatchers.push(...createTmpDirMatchers());
+        if (replaceHomeDir) pathMatchers.push(...createHomeDirMatchers());
         pathMatchers.push(...customPostMatchers);
         return pathMatchers;
     }
@@ -871,7 +878,7 @@ function createSnapshotSerializer(options) {
             if (transformWin32Path) replaced = transformCodeToPosixPath(replaced);
             replaced = applyMatcherReplacement(pathMatchers, replaced);
             if (escapeDoubleQuotes) replaced = replaced.replace(/"/g, '\\"');
-            if (escapeEOL) replaced = replaced.replace(/\\r\\n/g, '\n');
+            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.2.0",
+  "version": "0.2.2",
   "description": "path-serializer",
   "keywords": [
     "snapshot",