refactor: drop test option in favor transformPath (#472)

BREAKING CHANGE: the `test` option was removed in favor the `transformPath` option

Author: cap-Bernardito

README.md

@@ -81,7 +81,6 @@ module.exports = {
 |        [`context`](#context)        |     `{String}`      | `options.context \|\| compiler.options.context` | A path that determines how to interpret the `from` path.                                              |
 |    [`globOptions`](#globoptions)    |     `{Object}`      |                   `undefined`                   | [Options][glob-options] passed to the glob pattern matching library including `ignore` option.        |
 |         [`toType`](#totype)         |     `{String}`      |                   `undefined`                   | Determinate what is `to` option - directory, file or template.                                        |
-|           [`test`](#test)           | `{String\|RegExp}`  |                   `undefined`                   | Pattern for extracting elements to be used in `to` templates.                                         |
 |          [`force`](#force)          |     `{Boolean}`     |                     `false`                     | Overwrites files already in `compilation.assets` (usually added by other plugins/loaders).            |
 |        [`flatten`](#flatten)        |     `{Boolean}`     |                     `false`                     | Removes all directory references and only copies file names.                                          |
 |      [`transform`](#transform)      |    `{Function}`     |                   `undefined`                   | Allows to modify the file contents.                                                                   |
@@ -353,37 +352,6 @@ module.exports = {
 };
 ```
 
-#### `test`
-
-Type: `string|RegExp`
-Default: `undefined`
-
-Pattern for extracting elements to be used in `to` templates.
-
-Defines a `{RegExp}` to match some parts of the file path.
-These capture groups can be reused in the name property using `[N]` placeholder.
-Note that `[0]` will be replaced by the entire path of the file,
-whereas `[1]` will contain the first capturing parenthesis of your `{RegExp}`
-and so on...
-
-**webpack.config.js**
-
-```js
-module.exports = {
-  plugins: [
-    new CopyPlugin({
-      patterns: [
-        {
-          from: '*/*',
-          to: '[1]-[2].[hash].[ext]',
-          test: /([^/]+)\/(.+)\.png$/,
-        },
-      ],
-    }),
-  ],
-};
-```
-
 #### `force`
 
 Type: `Boolean`

src/options.json

@@ -16,16 +16,6 @@
         "toType": {
           "enum": ["dir", "file", "template"]
         },
-        "test": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "instanceof": "RegExp"
-            }
-          ]
-        },
         "force": {
           "type": "boolean"
         },

src/postProcessPattern.js

@@ -117,7 +117,6 @@ export default async function postProcessPattern(globalRef, pattern, file) {
       file.webpackTo,
       {
         content,
-        regExp: file.webpackToRegExp,
         context: pattern.context,
       }
     );

src/processPattern.js

@@ -56,7 +56,6 @@ export default async function processPattern(globalRef, pattern) {
       file.webpackTo = pattern.to || file.relativeFrom;
     } else if (pattern.toType === 'template') {
       file.webpackTo = pattern.to;
-      file.webpackToRegExp = pattern.test;
     }
 
     if (path.isAbsolute(file.webpackTo)) {

test/__snapshots__/validate-options.test.js.snap

@@ -14,7 +14,7 @@ exports[`validate options should throw an error on the "options" option with "{"
 exports[`validate options should throw an error on the "patterns" option with "" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns should be an array:
-   [non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
+   [non-empty string | object { from, to?, context?, toType?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
 `;
 
 exports[`validate options should throw an error on the "patterns" option with "[""]" value 1`] = `
@@ -42,18 +42,6 @@ exports[`validate options should throw an error on the "patterns" option with "[
  - options.patterns[0].force should be a boolean."
 `;
 
-exports[`validate options should throw an error on the "patterns" option with "[{"from":"test.txt","to":"dir","context":"context","test":true}]" value 1`] = `
-"Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
- - options.patterns[0] should be one of these:
-   non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }
-   Details:
-    * options.patterns[0].test should be one of these:
-      string | RegExp
-      Details:
-       * options.patterns[0].test should be a string.
-       * options.patterns[0].test should be an instance of RegExp."
-`;
-
 exports[`validate options should throw an error on the "patterns" option with "[{"from":"test.txt","to":"dir","context":"context","toType":"foo"}]" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns[0].toType should be one of these:
@@ -73,7 +61,7 @@ exports[`validate options should throw an error on the "patterns" option with "[
 exports[`validate options should throw an error on the "patterns" option with "[{"from":"test.txt","to":"dir","context":"context"}]" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns[0] should be one of these:
-   non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }
+   non-empty string | object { from, to?, context?, toType?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }
    Details:
     * options.patterns[0].cacheTransform should be one of these:
       boolean | object { … }
@@ -112,19 +100,19 @@ exports[`validate options should throw an error on the "patterns" option with "[
 exports[`validate options should throw an error on the "patterns" option with "{}" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns should be an array:
-   [non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
+   [non-empty string | object { from, to?, context?, toType?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
 `;
 
 exports[`validate options should throw an error on the "patterns" option with "true" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns should be an array:
-   [non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
+   [non-empty string | object { from, to?, context?, toType?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
 `;
 
 exports[`validate options should throw an error on the "patterns" option with "true" value 2`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns should be an array:
-   [non-empty string | object { from, to?, context?, toType?, test?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
+   [non-empty string | object { from, to?, context?, toType?, force?, flatten?, transform?, cacheTransform?, transformPath?, … }, ...] (should not have fewer than 1 item)"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "/test/" value 1`] = `

test/test-option.test.js

@@ -192,4 +192,82 @@ describe('transformPath option', () => {
       .then(done)
       .catch(done);
   });
+
+  it('should move files', (done) => {
+    runEmit({
+      expectedAssetKeys: ['txt'],
+      patterns: [
+        {
+          from: 'directory/nested/deep-nested',
+          to: '[1]',
+          transformPath(targetPath, absolutePath) {
+            const mathes = absolutePath.match(/\.([^.]*)$/);
+            const [, res] = mathes;
+            const target = targetPath.replace(/\[[1]\]/, res);
+
+            return target;
+          },
+        },
+      ],
+    })
+      .then(done)
+      .catch(done);
+  });
+
+  it('should move files to a non-root directory with [1]', (done) => {
+    runEmit({
+      expectedAssetKeys: ['nested/txt'],
+      patterns: [
+        {
+          from: 'directory/nested/deep-nested',
+          to: 'nested/[1]',
+          transformPath(targetPath, absolutePath) {
+            const mathes = absolutePath.match(/\.([^.]*)$/);
+            const [, res] = mathes;
+            const target = targetPath.replace(/\[[1]\]/, res);
+
+            return target;
+          },
+        },
+      ],
+    })
+      .then(done)
+      .catch(done);
+  });
+
+  it('should move files', (done) => {
+    runEmit({
+      expectedAssetKeys: [
+        'deep-nested-deepnested.txt',
+        'directoryfile.txt',
+        'nested-nestedfile.txt',
+      ],
+      patterns: [
+        {
+          from: '**/*',
+          context: 'directory',
+          transformPath(targetPath) {
+            const pathSegments = path.parse(targetPath);
+            const result = [];
+
+            if (pathSegments.root) {
+              result.push(pathSegments.root);
+            }
+
+            if (pathSegments.dir) {
+              result.push(pathSegments.dir.split(path.sep).pop());
+            }
+
+            if (pathSegments.base) {
+              result.push(pathSegments.base);
+            }
+
+            return result.join('-');
+          },
+        },
+      ],
+    })
+      .then(done)
+      .catch(done);
+  });
 });

test/transformPath-option.test.js

@@ -53,7 +53,6 @@ describe('validate options', () => {
             to: 'dir',
             context: 'context',
             toType: 'file',
-            test: /test/,
             force: true,
             flatten: true,
             transform: () => {},
@@ -71,22 +70,6 @@ describe('validate options', () => {
             },
           },
         ],
-        [
-          {
-            from: 'test.txt',
-            to: 'dir',
-            context: 'context',
-            test: 'test',
-          },
-        ],
-        [
-          {
-            from: 'test.txt',
-            to: 'dir',
-            context: 'context',
-            test: /test/,
-          },
-        ],
         [
           {
             from: 'test.txt',
@@ -142,14 +125,6 @@ describe('validate options', () => {
             toType: 'foo',
           },
         ],
-        [
-          {
-            from: 'test.txt',
-            to: 'dir',
-            context: 'context',
-            test: true,
-          },
-        ],
         [
           {
             from: 'test.txt',