Rename filename to filepath

Author: SimenB

CHANGELOG.md

@@ -5,6 +5,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 Latest version of this document will always be available on https://github.com/SimenB/add-asset-html-webpack-plugin/releases
 
 ## [Unreleased]
+### Breaking
+- Rename `filname` to `filepath`, which makes much more sense
+
 ### Added
 - A Changelog!
 - A first attempt to add typings

README.md

@@ -21,7 +21,7 @@ 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 filename:
+config, providing it a filepath:
 
 ```js
 var HtmlWebpackPlugin = require('html-webpack-plugin')
@@ -34,7 +34,7 @@ var webpackConfig = {
   },
   plugins: [
     new HtmlWebpackPlugin(),
-    new AddAssetHtmlPlugin({ filename: require.resolve('./some-file') })
+    new AddAssetHtmlPlugin({ filepath: require.resolve('./some-file') })
   ]
 }
 ```
@@ -59,19 +59,19 @@ multiple objects as an array.
 
 ```js
 new AddAssetHtmlPlugin([
-  { filename: require.resolve('./some-file') }, 
-  { filename: require.resolve('./some-other-file') }
+  { filepath: require.resolve('./some-file') }, 
+  { filepath: require.resolve('./some-other-file') }
 ])
 ```
 
 ## Options
 Options are passed to the plugin during instantiation.
 
 ```js
-new AddAssetHtmlPlugin({ filename: require.resolve('./some-file') })
+new AddAssetHtmlPlugin({ filepath: require.resolve('./some-file') })
 ```
 
-#### `filename`
+#### `filepath`
 Type: `string`, mandatory
 
 The absolute path of the file you want to add to the compilation, and resulting HTML file.
@@ -84,7 +84,7 @@ If `true`, will append a unique hash of the file to the filename. This is useful
 #### `includeSourcemap`
 Type: `boolean`, default: `true`
 
-If `true`, will add `filename + '.map'` to the compilation as well.
+If `true`, will add `filepath + '.map'` to the compilation as well.
 
 #### `publicPath`
 Type: `string`
@@ -117,7 +117,7 @@ var webpackConfig = {
   devtool: '#source-map',
   output: {
     path: path.join(__dirname, 'build'),
-    filename: '[name].dll.js',
+    filepath: '[name].dll.js',
     library: '[name]_[hash]'
   },
   plugins: [
@@ -139,7 +139,7 @@ var webpackConfig = {
   entry: 'index.js',
   output: {
     path: 'dist',
-    filename: 'index_bundle.js'
+    filepath: 'index_bundle.js'
   },
   plugins: [
     new webpack.DllReferencePlugin({
@@ -148,7 +148,7 @@ var webpackConfig = {
     }),
     new HtmlWebpackPlugin(),
     new AddAssetHtmlPlugin({
-      filename: require.resolve('./build/vendor.dll.js'),
+      filepath: require.resolve('./build/vendor.dll.js'),
       includeSourcemap: true
     })
   ]

addAssetHtmlPlugin.js

@@ -20,14 +20,14 @@ function resolvePublicPath(compilation, filename, publicPath) {
   return resolvedPublicPath;
 }
 
-function addFileToAssets(compilation, htmlPluginData, { filename, typeOfAsset = 'js', includeSourcemap = true, hash = false, publicPath }) {
-  if (!filename) {
+function addFileToAssets(compilation, htmlPluginData, { filepath, typeOfAsset = 'js', includeSourcemap = true, hash = false, publicPath }) {
+  if (!filepath) {
     const error = new Error('No filename defined');
     compilation.errors.push(error);
     return Promise.reject(error);
   }
 
-  return htmlPluginData.plugin.addFileToAssets(filename, compilation)
+  return htmlPluginData.plugin.addFileToAssets(filepath, compilation)
     .then(addedFilename => {
       let suffix = '';
       if (hash) {
@@ -46,7 +46,7 @@ function addFileToAssets(compilation, htmlPluginData, { filename, typeOfAsset =
     })
     .then(() => {
       if (includeSourcemap) {
-        return htmlPluginData.plugin.addFileToAssets(`${filename}.map`, compilation);
+        return htmlPluginData.plugin.addFileToAssets(`${filepath}.map`, compilation);
       }
       return null;
     });

test.js

@@ -49,7 +49,7 @@ test("should add file using compilation's publicPath", async t => {
   const compilation = { options: { output: { publicPath: 'vendor/' } } };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
-  await addAllAssetsToCompilation([{ filename: path.join(__dirname, 'my-file.js') }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: path.join(__dirname, 'my-file.js') }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['vendor/my-file.js']);
@@ -63,7 +63,7 @@ test('should used passed in publicPath', async t => {
   const compilation = { options: { output: { publicPath: 'vendor/' } } };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.js', publicPath: 'pp' }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.js', publicPath: 'pp' }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['pp/my-file.js']);
@@ -80,7 +80,7 @@ test('should add file missing "/" to public path', async t => {
   const compilation = { options: { output: { publicPath: 'vendor' } } };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.js' }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.js' }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['vendor/my-file.js']);
@@ -96,7 +96,7 @@ test('should add sourcemap to compilation', async t => {
   const pluginData = { assets: { js: [], css: [] }, plugin: { addFileToAssets: addFileToAssetsStub } };
   addFileToAssetsStub.returns(Promise.resolve('my-file.js'));
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.js' }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.js' }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['my-file.js']);
@@ -116,7 +116,7 @@ test('should skip adding sourcemap to compilation if set to false', async t => {
   const pluginData = { assets: { js: [], css: [] }, plugin: { addFileToAssets: addFileToAssetsStub } };
   addFileToAssetsStub.returns(Promise.resolve('my-file.js'));
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.js', includeSourcemap: false }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.js', includeSourcemap: false }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['my-file.js']);
@@ -136,7 +136,7 @@ test('should include hash of file content if option is set', async t => {
   };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.js', hash: true }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.js', hash: true }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, []);
   t.deepEqual(pluginData.assets.js, ['my-file.js?5329c141291f07ab06c6']);
@@ -153,7 +153,7 @@ test('should add to css if `typeOfAsset` is css', async t => {
   };
   const pluginData = Object.assign({ assets: { js: [], css: [] } }, pluginMock);
 
-  await addAllAssetsToCompilation([{ filename: 'my-file.css', typeOfAsset: 'css' }], compilation, pluginData, callback);
+  await addAllAssetsToCompilation([{ filepath: 'my-file.css', typeOfAsset: 'css' }], compilation, pluginData, callback);
 
   t.deepEqual(pluginData.assets.css, ['my-file.css']);
   t.deepEqual(pluginData.assets.js, []);