fix: update globby to v11 (#248)

Fixes #231

BREAKING CHANGE: `filename` no longer accepts a glob pattern, that must be passed as `glob` instead.

Author: SimenB

README.md

@@ -67,8 +67,8 @@ below, just pass multiple objects as an array.
 new AddAssetHtmlPlugin([
   { filepath: require.resolve('./some-file') },
   { filepath: require.resolve('./some-other-file') },
-  // Glob to match all of the dll file
-  { filepath: require.resolve('./**/*.dll.js') },
+  // Glob to match all of the dll file, make sure to use forward slashes on Windows
+  { glob: require.resolve('./**/*.dll.js') },
 ]);
 ```
 
@@ -82,10 +82,17 @@ new AddAssetHtmlPlugin({ filepath: require.resolve('./some-file') });
 
 #### `filepath`
 
-Type: `string|Glob`, mandatory
+Type: `string`, mandatory unless `glob` is defined
 
 The absolute path of the file you want to add to the compilation, and resulting
-HTML file. Also support globby string.
+HTML file.
+
+#### `glob`
+
+Type: `string`, mandatory unless `filepath` is defined
+
+A glob used to locate files to add to the compilation. See
+[`globby`'s docs](https://github.com/sindresorhus/globby) for how to use it.
 
 #### `files`
 

__snapshots__/test.js.snap

@@ -73,12 +73,14 @@ Object {
 exports[`should invoke callback on error 1`] = `
 Array [
   [Error: No filepath defined],
+  [Error: No filepath defined],
 ]
 `;
 
 exports[`should reject on error 1`] = `
 Array [
   [Error: No filepath defined],
+  [Error: No filepath defined],
 ]
 `;
 
@@ -117,3 +119,5 @@ Object {
   ],
 }
 `;
+
+exports[`throws of both filepath and glob is defined 1`] = `"Both filepath and glob defined in {\\"filepath\\":\\"my-file.js\\",\\"glob\\":\\"my-file.js\\"} - only use one of them"`;

example/dll/webpack.config.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const webpack = require('webpack');
+const slash = require('slash');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 const AddAssetHtmlPlugin = require('../../');
 
@@ -22,7 +23,8 @@ module.exports = {
     }),
     new HtmlWebpackPlugin(),
     new AddAssetHtmlPlugin({
-      filepath: path.resolve(__dirname, './build/*.dll.js'),
+      // glob needs to use forward slashes
+      glob: `${slash(path.resolve(__dirname, './build'))}/*.dll.js`,
     }),
   ],
 };

package.json

@@ -34,7 +34,7 @@
   },
   "homepage": "https://github.com/SimenB/add-asset-html-webpack-plugin#readme",
   "dependencies": {
-    "globby": "^9.2.0",
+    "globby": "^11.1.0",
     "micromatch": "^4.0.4"
   },
   "devDependencies": {

src/index.js

@@ -86,10 +86,15 @@ module.exports = class AddAssetHtmlPlugin {
   }
 
   async addAllAssetsToCompilation(compilation, htmlPluginData) {
-    const handledAssets = await handleUrl(this.assets);
-    // eslint-disable-next-line no-restricted-syntax
-    for (const asset of handledAssets) {
-      await this.addFileToAssets(compilation, htmlPluginData, asset);
+    try {
+      const handledAssets = await handleUrl(this.assets);
+      // eslint-disable-next-line no-restricted-syntax
+      for (const asset of handledAssets) {
+        await this.addFileToAssets(compilation, htmlPluginData, asset);
+      }
+    } catch (error) {
+      compilation.errors.push(error);
+      throw error;
     }
     return htmlPluginData;
   }

src/utils.js

@@ -40,16 +40,21 @@ function resolveOutput(compilation, addedFilename, outputPath) {
 async function handleUrl(assets) {
   const globbyAssets = [];
   const normalAssets = [];
-  // if filepath is null or undefined, just bubble up.
-  assets.forEach(asset =>
-    asset.filepath && globby.hasMagic(asset.filepath)
-      ? globbyAssets.push(asset)
-      : normalAssets.push(asset),
-  );
+  assets.forEach(asset => {
+    if (asset.filepath && asset.glob) {
+      throw new Error(
+        `Both filepath and glob defined in ${JSON.stringify(
+          asset,
+        )} - only use one of them`,
+      );
+    }
+
+    return asset.glob ? globbyAssets.push(asset) : normalAssets.push(asset);
+  });
   const ret = [];
   await Promise.all(
     globbyAssets.map(asset =>
-      globby(asset.filepath).then(paths =>
+      globby(asset.glob).then(paths =>
         paths.forEach(filepath =>
           ret.push(Object.assign({}, asset, { filepath })),
         ),

test.js

@@ -292,7 +292,7 @@ test('filter option should include some files with string option', async () => {
 });
 
 test('use globby to find multi file', async () => {
-  const assets = [{ filepath: './src/*.js' }];
+  const assets = [{ glob: './src/*.js' }];
   const ret = await handleUrl(assets);
   expect(ret).toHaveLength(2);
 });
@@ -302,3 +302,8 @@ test('filepath without globbyMagic should just return', async () => {
   const ret = await handleUrl(assets);
   expect(ret).toHaveLength(1);
 });
+
+test('throws of both filepath and glob is defined', async () => {
+  const assets = [{ filepath: 'my-file.js', glob: 'my-file.js' }];
+  await expect(handleUrl(assets)).rejects.toThrowErrorMatchingSnapshot();
+});