fix: utilize new plugin API

Author: SimenB

CHANGELOG.md

@@ -10,7 +10,7 @@ https://github.com/SimenB/add-asset-html-webpack-plugin/releases
 
 ### Changed
 
-- Drop support for Node 4
+- Drop support for Node 4 and html-webpack-plugin@2
 
 ## [2.1.3] - 2018-03-03
 

example/webpack.config.dll.js

@@ -6,9 +6,9 @@ module.exports = {
   context: __dirname,
   entry: {
     vendor: ['classnames'],
-    lib: ['classnames'],
   },
   devtool: '#source-map',
+  mode: 'development',
   output: {
     path: path.join(__dirname, 'build'),
     filename: '[name].[hash:4].dll.js',

example/webpack.config.js

@@ -8,6 +8,7 @@ module.exports = {
   context: __dirname,
   entry: path.join(__dirname, 'entry.js'),
   devtool: '#source-map',
+  mode: 'development',
   output: {
     path: path.join(__dirname, 'dist'),
     filename: 'index_bundle.js',

src/addAllAssetsToCompilation.js

@@ -98,20 +98,10 @@ async function addFileToAssets(
 }
 
 // Visible for testing
-export default async function(assets, compilation, htmlPluginData, callback) {
-  try {
-    const handledAssets = await handleUrl(assets);
-    await pEachSeries(handledAssets, asset =>
-      addFileToAssets(compilation, htmlPluginData, asset),
-    );
-    if (callback) {
-      return callback(null, htmlPluginData);
-    }
-    return htmlPluginData;
-  } catch (e) {
-    if (callback) {
-      return callback(e, htmlPluginData);
-    }
-    throw new Error(e);
-  }
+export default async function(assets, compilation, htmlPluginData) {
+  const handledAssets = await handleUrl(assets);
+  await pEachSeries(handledAssets, asset =>
+    addFileToAssets(compilation, htmlPluginData, asset),
+  );
+  return htmlPluginData;
 }

src/index.js

@@ -7,17 +7,11 @@ export default class AddAssetHtmlPlugin {
 
   /* istanbul ignore next: this would be integration tests */
   apply(compiler) {
-    compiler.plugin('compilation', compilation => {
-      compilation.plugin(
-        'html-webpack-plugin-before-html-generation',
-        async (htmlPluginData, callback) => {
-          await addAllAssetsToCompilation(
-            this.assets,
-            compilation,
-            htmlPluginData,
-            callback,
-          );
-        },
+    compiler.hooks.compilation.tap('AddAssetHtmlPlugin', compilation => {
+      compilation.hooks.htmlWebpackPluginBeforeHtmlGeneration.tapPromise(
+        'AddAssetHtmlPlugin',
+        htmlPluginData =>
+          addAllAssetsToCompilation(this.assets, compilation, htmlPluginData),
       );
     });
   }

test.js

@@ -20,31 +20,20 @@ test('assets should should be reversed', () => {
   expect(new AddAssetHtmlPlugin(['a', 'b']).assets).toEqual(['b', 'a']);
 });
 
-test('should invoke callback on success', async () => {
-  const callback = jest.fn();
-
-  await addAllAssetsToCompilation([], {}, pluginMock, callback);
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginMock);
-});
-
 test('should not reject success', async () => {
   expect(await addAllAssetsToCompilation([], {}, pluginMock)).toEqual(
     pluginMock,
   );
 });
 
 test('should invoke callback on error', async () => {
-  const callback = jest.fn();
   const compilation = { errors: [] };
 
-  await addAllAssetsToCompilation([{}], compilation, pluginMock, callback);
+  await expect(
+    addAllAssetsToCompilation([{}], compilation, pluginMock),
+  ).rejects.toThrowError();
 
   expect(compilation.errors).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(compilation.errors[0], pluginMock);
 });
 
 test('should reject on error', async () => {
@@ -60,64 +49,48 @@ test('should reject on error', async () => {
 });
 
 test("should add file using compilation's publicPath", 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') }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('should used passed in publicPath', async () => {
-  const callback = jest.fn();
   const compilation = { options: { output: { publicPath: 'vendor/' } } };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
   await addAllAssetsToCompilation(
     [{ filepath: 'my-file.js', publicPath: 'pp' }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 // TODO: No idea what this does, actually... Coverage currently hits it, but the logic is untested.
 test.skip('should handle missing `publicPath`', () => {});
 
 test('should add file missing "/" to public path', async () => {
-  const callback = jest.fn();
   const compilation = { options: { output: { publicPath: 'vendor' } } };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
   await addAllAssetsToCompilation(
     [{ filepath: 'my-file.js' }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('should add sourcemap to compilation', async () => {
-  const callback = jest.fn();
   const addFileToAssetsStub = jest.fn();
   const compilation = { options: { output: {} } };
   const pluginData = {
@@ -130,14 +103,10 @@ test('should add sourcemap to compilation', async () => {
     [{ filepath: 'my-file.js' }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
 
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
-
   expect(addFileToAssetsStub).toHaveBeenCalledTimes(2);
   expect(addFileToAssetsStub.mock.calls[0]).toEqual([
     'my-file.js',
@@ -150,7 +119,6 @@ test('should add sourcemap to compilation', async () => {
 });
 
 test('should skip adding sourcemap to compilation if set to false', async () => {
-  const callback = jest.fn();
   const addFileToAssetsStub = jest.fn();
   const compilation = { options: { output: {} } };
   const pluginData = {
@@ -163,20 +131,15 @@ test('should skip adding sourcemap to compilation if set to false', async () =>
     [{ filepath: 'my-file.js', includeSourcemap: false }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
 
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
-
   expect(addFileToAssetsStub).toHaveBeenCalledTimes(1);
   expect(addFileToAssetsStub).toHaveBeenCalledWith('my-file.js', compilation);
 });
 
 test('should include hash of file content if option is set', async () => {
-  const callback = jest.fn();
   const compilation = {
     options: { output: {} },
     assets: {
@@ -189,17 +152,12 @@ test('should include hash of file content if option is set', async () => {
     [{ filepath: 'my-file.js', hash: true }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('should add to css if `typeOfAsset` is css', async () => {
-  const callback = jest.fn();
   const compilation = {
     options: { output: {} },
     assets: {
@@ -212,17 +170,12 @@ test('should add to css if `typeOfAsset` is css', async () => {
     [{ filepath: 'my-file.css', typeOfAsset: 'css' }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('should replace compilation assets key if `outputPath` is set', async () => {
-  const callback = jest.fn();
   const source = { source: () => 'test' };
   const addFileToAssetsMock = (filename, compilation) => {
     const name = path.basename(filename);
@@ -242,7 +195,6 @@ test('should replace compilation assets key if `outputPath` is set', async () =>
     [{ filepath: 'my-file.js', outputPath: 'assets' }],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
@@ -254,7 +206,6 @@ test('should replace compilation assets key if `outputPath` is set', async () =>
 });
 
 test('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);
 
@@ -267,49 +218,35 @@ test('filter option should exclude some files', async () => {
     ],
     compilation,
     pluginData,
-    callback,
   );
 
   expect(pluginData.assets).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('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).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('filter option should include some files with string option', 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).toMatchSnapshot();
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith(null, pluginData);
 });
 
 test('use globby to find multi file', async () => {