feat: introduced "postTransformPublicPath" option

removed prefixPublicPathWithWebpackPublicPath and introduced postTransformPublicPath option instead
webpack-contrib · Jul 22, 2019 · 4f990d7 · 4f990d7
1 parent e776945
commit 4f990d7
Show file tree

Hide file tree

Showing 4 changed files with 168 additions and 90 deletions.
diff --git a/src/index.js b/src/index.js
@@ -45,10 +45,10 @@ export default function loader(content) {
     }
 
     publicPath = JSON.stringify(publicPath);
+  }
 
-    if (options.prefixPublicPathWithWebpackPublicPath) {
-      publicPath = `__webpack_public_path__ + ${publicPath}`;
-    }
+  if (options.postTransformPublicPath) {
+    publicPath = options.postTransformPublicPath(publicPath);
   }
 
   if (typeof options.emitFile === 'undefined' || options.emitFile) {

diff --git a/src/options.json b/src/options.json
@@ -34,8 +34,8 @@
         }
       ]
     },
-    "prefixPublicPathWithWebpackPublicPath": {
-      "type": "boolean"
+    "postTransformPublicPath": {
+      "instanceof": "Function"
     },
     "context": {
       "description": "A custom file context (https://github.com/webpack-contrib/file-loader#context).",

diff --git a/test/__snapshots__/publicPath-option.test.js.snap b/test/__snapshots__/publicPath-option.test.js.snap
@@ -1,33 +1,33 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{Function}\` value 1`] = `
+exports[`when applied with \`postTransformPublicPath\` option matches snapshot for appending to input parameter value 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
   ],
-  "source": "module.exports = __webpack_public_path__ + \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+  "source": "module.exports = __webpack_public_path__ + \\"9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\" + \\"/test\\";",
 }
 `;
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{Function}\` value and pass \`context\` 1`] = `
+exports[`when applied with \`postTransformPublicPath\` option matches snapshot for returned input parameter value without modification 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
   ],
-  "source": "module.exports = __webpack_public_path__ + \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+  "source": "module.exports = __webpack_public_path__ + \\"9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
 }
 `;
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{Function}\` value and pass \`resourcePath\` 1`] = `
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{Function}\` value matches snapshot for appending to input parameter value 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
   ],
-  "source": "module.exports = __webpack_public_path__ + \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+  "source": "module.exports = \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\" + \\"?test=test\\";",
 }
 `;
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{String}\` value 1`] = `
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{Function}\` value matches snapshot for prefixing with __webpack_public_path__ 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
@@ -36,16 +36,34 @@ Object {
 }
 `;
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{String}\` value as URL 1`] = `
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{Function}\` value matches snapshot for prefixing with string 1`] = `
+Object {
+  "assets": Array [
+    "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
+  ],
+  "source": "module.exports = \\"path_prefix/\\" + \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+}
+`;
+
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{Function}\` value matches snapshot for returned input parameter value without modification 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
   ],
-  "source": "module.exports = __webpack_public_path__ + \\"https://cdn.com/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+  "source": "module.exports = \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
 }
 `;
 
-exports[`when applied with \`publicPath\` and \`prefixPublicPathWithWebpackPublicPath\` options matches snapshot for \`{String}\` value without trailing slash 1`] = `
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{String}\` value matches snapshot for appending to input parameter value 1`] = `
+Object {
+  "assets": Array [
+    "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
+  ],
+  "source": "module.exports = \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\" + \\"?test=test\\";",
+}
+`;
+
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{String}\` value matches snapshot for prefixing with __webpack_public_path__ 1`] = `
 Object {
   "assets": Array [
     "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
@@ -54,6 +72,15 @@ Object {
 }
 `;
 
+exports[`when applied with \`publicPath\` and \`postTransformPublicPath\` option \`{String}\` value matches snapshot for returned input parameter value without modification 1`] = `
+Object {
+  "assets": Array [
+    "9c87cbf3ba33126ffd25ae7f2f6bbafb.png",
+  ],
+  "source": "module.exports = \\"public_path/9c87cbf3ba33126ffd25ae7f2f6bbafb.png\\";",
+}
+`;
+
 exports[`when applied with \`publicPath\` option matches snapshot for \`{Function}\` value 1`] = `
 Object {
   "assets": Array [

diff --git a/test/publicPath-option.test.js b/test/publicPath-option.test.js
@@ -128,14 +128,13 @@ describe('when applied with `publicPath` option', () => {
   });
 });
 
-describe('when applied with `publicPath` and `prefixPublicPathWithWebpackPublicPath` options', () => {
-  it('matches snapshot for `{String}` value', async () => {
+describe('when applied with `postTransformPublicPath` option', () => {
+  it('matches snapshot for returned input parameter value without modification', async () => {
     const config = {
       loader: {
         test: /(png|jpg|svg)/,
         options: {
-          publicPath: 'public_path/',
-          prefixPublicPathWithWebpackPublicPath: true,
+          postTransformPublicPath: (p) => p,
         },
       },
     };
@@ -147,13 +146,12 @@ describe('when applied with `publicPath` and `prefixPublicPathWithWebpackPublicP
     expect({ assets, source }).toMatchSnapshot();
   });
 
-  it('matches snapshot for `{String}` value without trailing slash', async () => {
+  it('matches snapshot for appending to input parameter value', async () => {
     const config = {
       loader: {
         test: /(png|jpg|svg)/,
         options: {
-          publicPath: 'public_path',
-          prefixPublicPathWithWebpackPublicPath: true,
+          postTransformPublicPath: (p) => `${p} + "/test"`,
         },
       },
     };
@@ -164,87 +162,140 @@ describe('when applied with `publicPath` and `prefixPublicPathWithWebpackPublicP
 
     expect({ assets, source }).toMatchSnapshot();
   });
+});
 
-  // notice that this case will produce invalid urls if __webpack_public_path__ is set to an absolute url
-  it('matches snapshot for `{String}` value as URL', async () => {
-    const config = {
-      loader: {
-        test: /(png|jpg|svg)/,
-        options: {
-          publicPath: 'https://cdn.com/',
-          prefixPublicPathWithWebpackPublicPath: true,
+describe('when applied with `publicPath` and `postTransformPublicPath` option', () => {
+  describe('`{String}` value', () => {
+    it('matches snapshot for returned input parameter value without modification', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath: 'public_path/',
+            postTransformPublicPath: (p) => p,
+          },
         },
-      },
-    };
-
-    const stats = await webpack('fixture.js', config);
-    const [module] = stats.toJson().modules;
-    const { assets, source } = module;
-
-    expect({ assets, source }).toMatchSnapshot();
-  });
-
-  it('matches snapshot for `{Function}` value', async () => {
-    const config = {
-      loader: {
-        test: /(png|jpg|svg)/,
-        options: {
-          publicPath(url) {
-            return `public_path/${url}`;
+      };
+
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
+
+      expect({ assets, source }).toMatchSnapshot();
+    });
+
+    it('matches snapshot for appending to input parameter value', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath: 'public_path/',
+            postTransformPublicPath: (p) => `${p} + "?test=test"`,
           },
-          prefixPublicPathWithWebpackPublicPath: true,
         },
-      },
-    };
-
-    const stats = await webpack('fixture.js', config);
-    const [module] = stats.toJson().modules;
-    const { assets, source } = module;
-
-    expect({ assets, source }).toMatchSnapshot();
-  });
-
-  it('matches snapshot for `{Function}` value and pass `resourcePath`', async () => {
-    const config = {
-      loader: {
-        test: /(png|jpg|svg)/,
-        options: {
-          publicPath(url, resourcePath) {
-            expect(resourcePath).toMatch('file.png');
-
-            return `public_path/${url}`;
+      };
+
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
+
+      expect({ assets, source }).toMatchSnapshot();
+    });
+
+    it('matches snapshot for prefixing with __webpack_public_path__', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath: 'public_path/',
+            postTransformPublicPath: (p) => `__webpack_public_path__ + ${p}`,
           },
-          prefixPublicPathWithWebpackPublicPath: true,
         },
-      },
-    };
+      };
 
-    const stats = await webpack('fixture.js', config);
-    const [module] = stats.toJson().modules;
-    const { assets, source } = module;
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
 
-    expect({ assets, source }).toMatchSnapshot();
+      expect({ assets, source }).toMatchSnapshot();
+    });
   });
 
-  it('matches snapshot for `{Function}` value and pass `context`', async () => {
-    const config = {
-      loader: {
-        test: /(png|jpg|svg)/,
-        options: {
-          publicPath(url, resourcePath, context) {
-            expect(context).toMatch('fixtures');
-
-            return `public_path/${url}`;
+  describe('`{Function}` value', () => {
+    it('matches snapshot for returned input parameter value without modification', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath(url) {
+              return `public_path/${url}`;
+            },
+            postTransformPublicPath: (p) => p,
           },
-          prefixPublicPathWithWebpackPublicPath: true,
         },
-      },
-    };
+      };
+
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
+
+      expect({ assets, source }).toMatchSnapshot();
+    });
+
+    it('matches snapshot for appending to input parameter value', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath(url) {
+              return `public_path/${url}`;
+            },
+            postTransformPublicPath: (p) => `${p} + "?test=test"`,
+          },
+        },
+      };
+
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
+
+      expect({ assets, source }).toMatchSnapshot();
+    });
+
+    it('matches snapshot for prefixing with string', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath: 'public_path/',
+            postTransformPublicPath: (p) => `"path_prefix/" + ${p}`,
+          },
+        },
+      };
+
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
+
+      expect({ assets, source }).toMatchSnapshot();
+    });
+
+    it('matches snapshot for prefixing with __webpack_public_path__', async () => {
+      const config = {
+        loader: {
+          test: /(png|jpg|svg)/,
+          options: {
+            publicPath: 'public_path/',
+            postTransformPublicPath: (p) => `__webpack_public_path__ + ${p}`,
+          },
+        },
+      };
 
-    const stats = await webpack('fixture.js', config);
-    const [module] = stats.toJson().modules;
-    const { assets, source } = module;
+      const stats = await webpack('fixture.js', config);
+      const [module] = stats.toJson().modules;
+      const { assets, source } = module;
 
-    expect({ assets, source }).toMatchSnapshot();
+      expect({ assets, source }).toMatchSnapshot();
+    });
   });
 });