refactor: rename the name option (webpack-contrib#261)

BREAKING CHANGE: the `name` option was renamed to the `filename` option
TheLD6978 · Jul 28, 2020 · d8f3b9e · d8f3b9e
1 parent b9f027b
commit d8f3b9e
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 31 deletions.
diff --git a/src/index.js b/src/index.js
@@ -37,24 +37,19 @@ FetchCompileWasmPlugin =
 export default function loader() {}
 
 export function pitch(request) {
+  this.cacheable(false);
+
   const options = loaderUtils.getOptions(this);
 
   validateOptions(schema, options, {
     name: 'Worker Loader',
     baseDataPath: 'options',
   });
 
-  this.cacheable(false);
-
-  const cb = this.async();
-
   const filename = loaderUtils.interpolateName(
     this,
-    options.name || '[hash].worker.js',
-    {
-      context: options.context || this.rootContext || this.options.context,
-      regExp: options.regExp,
-    }
+    options.filename || '[hash].worker.js',
+    { context: this.rootContext }
   );
 
   const worker = {};
@@ -91,6 +86,8 @@ export function pitch(request) {
     worker.compiler
   );
 
+  const cb = this.async();
+
   if (
     worker.compiler.cache &&
     typeof worker.compiler.cache.get === 'function'

diff --git a/src/options.json b/src/options.json
@@ -24,7 +24,11 @@
         }
       ]
     },
-    "name": {
+    "filename": {
+      "type": "string",
+      "minLength": 1
+    },
+    "publicPath": {
       "type": "string"
     },
     "inline": {
@@ -33,9 +37,6 @@
     "fallback": {
       "type": "boolean"
     },
-    "publicPath": {
-      "type": "string"
-    },
     "esModule": {
       "type": "boolean"
     }

diff --git a/test/__snapshots__/filename-options.test.js.snap b/test/__snapshots__/filename-options.test.js.snap
@@ -0,0 +1,14 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`"filename" option should work: errors 1`] = `Array []`;
+
+exports[`"filename" option should work: module 1`] = `
+"export default function() {
+  return new Worker(__webpack_public_path__ + \\"my-custom-name.js\\");
+};
+"
+`;
+
+exports[`"filename" option should work: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`"filename" option should work: warnings 1`] = `Array []`;
diff --git a/test/__snapshots__/name-options.test.js.snap b/test/__snapshots__/name-options.test.js.snap
diff --git a/test/name-options.test.js → test/filename-options.test.js b/test/name-options.test.js → test/filename-options.test.js
@@ -7,10 +7,10 @@ import {
   getWarnings,
 } from './helpers';
 
-describe('"name" option', () => {
+describe('"filename" option', () => {
   it('should work', async () => {
     const compiler = getCompiler('./basic/entry.js', {
-      name: 'my-custom-name.js',
+      filename: 'my-custom-name.js',
     });
     const stats = await compile(compiler);
     const result = await getResultFromBrowser(stats);

diff --git a/test/fixtures/query/entry.js b/test/fixtures/query/entry.js
@@ -1,4 +1,4 @@
-import Worker from '!../../../src?name=test.worker.js!./my-worker-name.js';
+import Worker from '!../../../src?filename=test.worker.js!./my-worker-name.js';
 
 const worker = new Worker();
 

diff --git a/test/helpers/getCompiler.js b/test/helpers/getCompiler.js
@@ -24,7 +24,7 @@ export default (fixture, loaderOptions = {}, config = {}) => {
           rules: [
             {
               loader: path.resolve(__dirname, '../../src'),
-              options: { name: 'test.worker.js', ...loaderOptions },
+              options: { filename: 'test.worker.js', ...loaderOptions },
             },
           ],
         },