Add files option

SimenB · SimenB · commit 0ae8d222ad55 · 2017-04-23T18:49:17.000+02:00
Closes #61
diff --git a/README.md b/README.md
@@ -21,9 +21,9 @@ $ npm i add-asset-html-webpack-plugin -D
 NOTE: This plugin requires `html-webpack-plugin@^2.10.0`.
 
 ## Basic Usage
-The plugin will add the given JS or CSS file to the files Webpack knows about, and put it into the
-list of assets `html-webpack-plugin` injects into the generated html. Add the plugin the your
-config, providing it a filepath:
+The plugin will add the given JS or CSS file to the files Webpack knows about,
+and put it into the list of assets `html-webpack-plugin` injects into the
+generated html. Add the plugin the your config, providing it a filepath:
 
 ```js
 const HtmlWebpackPlugin = require('html-webpack-plugin');
@@ -41,7 +41,8 @@ const webpackConfig = {
 };
 ```
 
-This will add a script tag to the HTML generated by `html-webpack-plugin`, and look like:
+This will add a script tag to the HTML generated by `html-webpack-plugin`, and
+look like:
 ```html
 <!DOCTYPE html>
 <html>
@@ -56,8 +57,8 @@ This will add a script tag to the HTML generated by `html-webpack-plugin`, and l
 </html>
 ```
 
-NOTE: You can also pass an array of assets to be added. Same API as mentioned below, just pass
-multiple objects as an array.
+NOTE: You can also pass an array of assets to be added. Same API as mentioned
+below, just pass multiple objects as an array.
 
 ```js
 new AddAssetHtmlPlugin([
@@ -76,12 +77,22 @@ new AddAssetHtmlPlugin({ filepath: require.resolve('./some-file') });
 #### `filepath`
 Type: `string`, mandatory
 
-The absolute path of the file you want to add to the compilation, and resulting HTML file.
+The absolute path of the file you want to add to the compilation, and resulting
+HTML file.
+
+#### `filter`
+Type: `string|Array<string>`, default `[]
+
+Files that the assets will be added to.
+
+By default the assets will be included in all files. If files are defined, the
+assets will only be included in specified file globs.
 
 #### `hash`
 Type: `boolean`, default: `false`
 
-If `true`, will append a unique hash of the file to the filename. This is useful for cache busting.
+If `true`, will append a unique hash of the file to the filename. This is
+useful for cache busting.
 
 #### `includeSourcemap`
 Type: `boolean`, default: `true`
diff --git a/package.json b/package.json
@@ -38,7 +38,8 @@
   },
   "homepage": "https://github.com/SimenB/add-asset-html-webpack-plugin#readme",
   "dependencies": {
-    "bluebird": "^3.4.6"
+    "bluebird": "^3.4.6",
+    "minimatch": "^3.0.3"
   },
   "devDependencies": {
     "babel-cli": "^6.18.0",
diff --git a/src/addAllAssetsToCompilation.js b/src/addAllAssetsToCompilation.js
@@ -1,6 +1,7 @@
 import path from 'path';
 import crypto from 'crypto';
 import Promise from 'bluebird';
+import minimatch from 'minimatch';
 
 function ensureTrailingSlash(string) {
   if (string.length && string.substr(-1, 1) !== '/') {
@@ -30,14 +31,24 @@ function resolveOutput(compilation, addedFilename, outputPath) {
 async function addFileToAssets(
   compilation,
   htmlPluginData,
-  { filepath, typeOfAsset = 'js', includeSourcemap = true, hash = false, publicPath, outputPath }
+  { filepath, typeOfAsset = 'js', includeSourcemap = true, hash = false, publicPath, outputPath, files = [] }
 ) {
   if (!filepath) {
     const error = new Error('No filepath defined');
     compilation.errors.push(error);
     return Promise.reject(error);
   }
 
+  const filters = Array.isArray(files) ? files : [files];
+
+  if (filters.length > 0) {
+    const shouldSkip = !files.some(file => minimatch(htmlPluginData.outputName, file));
+
+    if (shouldSkip) {
+      return Promise.resolve(null);
+    }
+  }
+
   const addedFilename = await htmlPluginData.plugin.addFileToAssets(filepath, compilation);
 
   let suffix = '';
diff --git a/test.js b/test.js
@@ -9,6 +9,7 @@ const pluginMock = {
   plugin: {
     addFileToAssets: filename => Promise.resolve(path.basename(filename)),
   },
+  outputName: 'index.html',
 };
 
 test('assets should always be an array', () => {
@@ -76,7 +77,7 @@ test.concurrent('should used passed in publicPath', async () => {
   expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
-// No idea what this does, actually... Coverage currently hits it, but the logic is untested.
+// TODO: No idea what this does, actually... Coverage currently hits it, but the logic is untested.
 test('should handle missing `publicPath`');
 
 test.concurrent('should add file missing "/" to public path', async () => {
@@ -200,3 +201,41 @@ test.concurrent('should replace compilation assets key if `outputPath` is set',
   expect(compilation.assets['my-file.js.map']).toBeUndefined();
   expect(compilation.assets['assets/my-file.js.map']).toEqual(source);
 });
+
+test.concurrent('filter option should exclude some files', async () => {
+  const callback = jest.fn();
+  const compilation = { options: { output: { publicPath: 'vendor/' } } };
+  const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
+
+  await addAllAssetsToCompilation(
+    [{ filepath: path.join(__dirname, 'my-file.js'), files: ['something-weird'] }],
+    compilation,
+    pluginData,
+    callback
+  );
+
+  expect(pluginData.assets.css).toEqual([]);
+  expect(pluginData.assets.js).toEqual([]);
+
+  expect(callback).toHaveBeenCalledTimes(1);
+  expect(callback).toHaveBeenCalledWith(null, pluginData);
+});
+
+test.concurrent('filter option should include some files', async () => {
+  const callback = jest.fn();
+  const compilation = { options: { output: { publicPath: 'vendor/' } } };
+  const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
+
+  await addAllAssetsToCompilation(
+    [{ filepath: path.join(__dirname, 'my-file.js'), files: ['index.*'] }],
+    compilation,
+    pluginData,
+    callback
+  );
+
+  expect(pluginData.assets.css).toEqual([]);
+  expect(pluginData.assets.js).toEqual(['vendor/my-file.js']);
+
+  expect(callback).toHaveBeenCalledTimes(1);
+  expect(callback).toHaveBeenCalledWith(null, pluginData);
+});
