html-webpack-plugin 2.21.0 → 2.24.0

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 Change History
 ==============
 
+v2.24.0
+---
+* Update dependencies
+* Add deprecate warning for plugins not returning a result
+* Add [path] for favicons
+
+v2.23.0
+---
+* Update dependencies
+* Stop automated tests for webpack 2 beta because of #401
+
+v2.22.0
+---
+* Update dependencies
+
+v2.21.1
+---
+* Better error handling (#354)
+
 v2.21.0
 ----
 * Add `html-webpack-plugin-alter-asset-tags` event to allow plugins to adjust the script/link tags

package/README.md

@@ -1,6 +1,6 @@
 HTML Webpack Plugin
 ===================
-[![npm version](https://badge.fury.io/js/html-webpack-plugin.svg)](http://badge.fury.io/js/html-webpack-plugin) [![Dependency Status](https://david-dm.org/ampedandwired/html-webpack-plugin.svg)](https://david-dm.org/ampedandwired/html-webpack-plugin) [![Build status](https://travis-ci.org/ampedandwired/html-webpack-plugin.svg)](https://travis-ci.org/ampedandwired/html-webpack-plugin) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/ampedandwired/html-webpack-plugin?svg=true&branch=master)](https://ci.appveyor.com/project/jantimon/html-webpack-plugin) [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard) [![bitHound Dependencies](https://www.bithound.io/github/ampedandwired/html-webpack-plugin/badges/dependencies.svg)](https://www.bithound.io/github/ampedandwired/html-webpack-plugin/master/dependencies/npm)
+[![npm version](https://badge.fury.io/js/html-webpack-plugin.svg)](http://badge.fury.io/js/html-webpack-plugin) [![Dependency Status](https://david-dm.org/ampedandwired/html-webpack-plugin.svg)](https://david-dm.org/ampedandwired/html-webpack-plugin) [![Build status](https://travis-ci.org/ampedandwired/html-webpack-plugin.svg)](https://travis-ci.org/ampedandwired/html-webpack-plugin) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/ampedandwired/html-webpack-plugin?svg=true&branch=master)](https://ci.appveyor.com/project/jantimon/html-webpack-plugin) [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard) [![bitHound Dependencies](https://www.bithound.io/github/ampedandwired/html-webpack-plugin/badges/dependencies.svg)](https://www.bithound.io/github/ampedandwired/html-webpack-plugin/master/dependencies/npm) [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()
 
 [![NPM](https://nodei.co/npm/html-webpack-plugin.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/html-webpack-plugin/)
 
@@ -24,8 +24,7 @@ Migration guide from 1.x
 [Changelog](https://github.com/ampedandwired/html-webpack-plugin/blob/master/CHANGELOG.md)
 
 If you used the 1.x version please take a look at the [migration guide](https://github.com/ampedandwired/html-webpack-plugin/blob/master/migration.md)
-In case I missed something please open a pull request for it.
-See also issue [#186](https://github.com/ampedandwired/html-webpack-plugin/issues/186)
+
 
 Basic Usage
 -----------
@@ -63,7 +62,7 @@ This will generate a file `dist/index.html` containing the following:
 If you have multiple webpack entry points, they will all be included with `script`
 tags in the generated HTML.
 
-If you have any css assets in webpack's output (for example, css extracted
+If you have any CSS assets in webpack's output (for example, CSS extracted
 with the [ExtractTextPlugin](https://github.com/webpack/extract-text-webpack-plugin))
 then these will be included with `<link>` tags in the HTML head.
 
@@ -75,12 +74,12 @@ Allowed values are as follows:
 - `title`: The title to use for the generated HTML document.
 - `filename`: The file to write the HTML to. Defaults to `index.html`.
    You can specify a subdirectory here too (eg: `assets/admin.html`).
-- `template`: Path to the template. Supports loaders e.g. `html!./index.html`.
+- `template`: Webpack require path to the template. Please see the [docs](https://github.com/ampedandwired/html-webpack-plugin/blob/master/docs/template-option.md) for details. 
 - `inject`: `true | 'head' | 'body' | false` Inject all assets into the given `template` or `templateContent` - When passing `true` or `'body'` all javascript resources will be placed at the bottom of the body element. `'head'` will place the scripts in the head element.
 - `favicon`: Adds the given favicon path to the output html.
 - `minify`: `{...} | false` Pass a [html-minifier](https://github.com/kangax/html-minifier#options-quick-reference) options object to minify the output.
 - `hash`: `true | false` if `true` then append a unique webpack compilation hash to all
-  included scripts and css files. This is useful for cache busting.
+  included scripts and CSS files. This is useful for cache busting.
 - `cache`: `true | false` if `true` (default) try to emit the file only if it was changed.
 - `showErrors`: `true | false` if `true` (default) errors details will be written into the html page.
 - `chunks`: Allows you to add only some chunks (e.g. only the unit-test chunk)
@@ -105,6 +104,13 @@ Here's an example webpack config illustrating how to use these options:
 }
 ```
 
+FAQ
+----
+
+* [Why is my html minified?](https://github.com/ampedandwired/html-webpack-plugin/blob/master/docs/template-option.md)
+* [Why is my `<% ... %>` template not working?](https://github.com/ampedandwired/html-webpack-plugin/blob/master/docs/template-option.md)
+* [How can I use handlebars/pug/ejs as template engine](https://github.com/ampedandwired/html-webpack-plugin/blob/master/docs/template-option.md)
+
 Generating Multiple HTML Files
 ------------------------------
 To generate more than one HTML file, declare the plugin more than
@@ -129,16 +135,15 @@ once in your plugins array:
 Writing Your Own Templates
 --------------------------
 If the default generated HTML doesn't meet your needs you can supply
-your own template. The easiest way is to use the `inject` option and pass a custom html file.
-The html-webpack-plugin will automatically inject all necessary css, js, manifest
+your own template. The easiest way is to use the `template` option and pass a custom html file.
+The html-webpack-plugin will automatically inject all necessary CSS, JS, manifest
 and favicon files into the markup.
 
 ```javascript
 plugins: [
   new HtmlWebpackPlugin({
     title: 'Custom template',
-    template: 'my-index.ejs', // Load a custom template (ejs by default but can be changed)
-    inject: 'body' // Inject all scripts into the body (this is the default so you can skip it)
+    template: 'my-index.ejs', // Load a custom template (ejs by default see the FAQ for details)
   })
 ]
 ```
@@ -291,3 +296,13 @@ plugins: [
 ```
 
 Note that the callback must be passed the htmlPluginData in order to pass this onto any other plugins listening on the same 'html-webpack-plugin-before-html-processing' event.
+
+
+# Contribution
+
+You're free to contribute to this project by submitting [issues](https://github.com/ampedandwired/html-webpack-plugin/issues) and/or [pull requests](https://github.com/ampedandwired/html-webpack-plugin/pulls). This project is test-driven, so keep in mind that every change and new feature should be covered by tests.
+This project uses the [semistandard code style](https://github.com/Flet/semistandard).
+
+# License
+
+This project is licensed under [MIT](https://github.com/ampedandwired/html-webpack-plugin/blob/master/LICENSE).

package/index.js

@@ -12,7 +12,7 @@ Promise.promisifyAll(fs);
 function HtmlWebpackPlugin (options) {
   // Default options
   this.options = _.extend({
-    template: __dirname + '/default_index.ejs',
+    template: path.join(__dirname, 'default_index.ejs'),
     filename: 'index.html',
     hash: false,
     inject: true,
@@ -63,7 +63,7 @@ HtmlWebpackPlugin.prototype.apply = function (compiler) {
   });
 
   compiler.plugin('emit', function (compilation, callback) {
-    var applyPluginsAsyncWaterfall = Promise.promisify(compilation.applyPluginsAsyncWaterfall, {context: compilation});
+    var applyPluginsAsyncWaterfall = self.applyPluginsAsyncWaterfall(compilation);
     // Get all chunks
     var chunks = self.filterChunks(compilation.getStats().toJson(), self.options.chunks, self.options.excludeChunks);
     // Sort chunks
@@ -93,7 +93,7 @@ HtmlWebpackPlugin.prototype.apply = function (compiler) {
         if (self.options.favicon) {
           return self.addFileToAssets(self.options.favicon, compilation)
             .then(function (faviconBasename) {
-              var publicPath = compilation.options.output.publicPath || '';
+              var publicPath = compilation.mainTemplate.getPublicPath({hash: compilation.hash}) || '';
               if (publicPath && publicPath.substr(-1) !== '/') {
                 publicPath += '/';
               }
@@ -107,7 +107,7 @@ HtmlWebpackPlugin.prototype.apply = function (compiler) {
       })
       .then(function (compiledTemplate) {
         // Allow to use a custom function / string instead
-        if (self.options.templateContent) {
+        if (self.options.templateContent !== undefined) {
           return self.options.templateContent;
         }
         // Once everything is compiled evaluate the html factory
@@ -137,28 +137,33 @@ HtmlWebpackPlugin.prototype.apply = function (compiler) {
       // Allow plugins to change the html before assets are injected
       .then(function (html) {
         var pluginArgs = {html: html, assets: assets, plugin: self, outputName: self.childCompilationOutputName};
-        return applyPluginsAsyncWaterfall('html-webpack-plugin-before-html-processing', pluginArgs)
-          .then(function () {
-            return pluginArgs.html;
-          });
+        return applyPluginsAsyncWaterfall('html-webpack-plugin-before-html-processing', pluginArgs);
       })
-      .then(function (html) {
+      .then(function (result) {
+        var html = result.html;
+        var assets = result.assets;
+        var chunks = result.chunks;
         // Prepare script and link tags
         var assetTags = self.generateAssetTags(assets);
         var pluginArgs = {head: assetTags.head, body: assetTags.body, plugin: self, chunks: chunks, outputName: self.childCompilationOutputName};
         // Allow plugins to change the assetTag definitions
         return applyPluginsAsyncWaterfall('html-webpack-plugin-alter-asset-tags', pluginArgs)
-          .then(function () {
+          .then(function (result) {
               // Add the stylesheets, scripts and so on to the resulting html
-            return self.postProcessHtml(html, assets, { body: pluginArgs.body, head: pluginArgs.head });
+            return self.postProcessHtml(html, assets, { body: result.body, head: result.head })
+              .then(function (html) {
+                return _.extend(result, {html: html, assets: assets});
+              });
           });
       })
       // Allow plugins to change the html after assets are injected
-      .then(function (html) {
+      .then(function (result) {
+        var html = result.html;
+        var assets = result.assets;
         var pluginArgs = {html: html, assets: assets, plugin: self, outputName: self.childCompilationOutputName};
         return applyPluginsAsyncWaterfall('html-webpack-plugin-after-html-processing', pluginArgs)
-          .then(function () {
-            return pluginArgs.html;
+          .then(function (result) {
+            return result.html;
           });
       })
       .catch(function (err) {
@@ -592,7 +597,7 @@ HtmlWebpackPlugin.prototype.getFullTemplatePath = function (template, context) {
   }
   // Resolve template path
   return template.replace(
-    /(\!)([^\/\\][^\!\?]+|[^\/\\!?])($|\?.+$)/,
+    /([!])([^\/\\][^!\?]+|[^\/\\!?])($|\?.+$)/,
     function (match, prefix, filepath, postfix) {
       return prefix + path.resolve(filepath) + postfix;
     });
@@ -612,4 +617,21 @@ HtmlWebpackPlugin.prototype.getAssetFiles = function (assets) {
   return files;
 };
 
+/**
+ * Helper to promisify compilation.applyPluginsAsyncWaterfall that returns
+ * a function that helps to merge given plugin arguments with processed ones
+ */
+HtmlWebpackPlugin.prototype.applyPluginsAsyncWaterfall = function (compilation) {
+  var promisedApplyPluginsAsyncWaterfall = Promise.promisify(compilation.applyPluginsAsyncWaterfall, {context: compilation});
+  return function (eventName, pluginArgs) {
+    return promisedApplyPluginsAsyncWaterfall(eventName, pluginArgs)
+      .then(function (result) {
+        if (!result) {
+          compilation.warnings.push(new Error('Using html-webpack-plugin-after-html-processing without returning a result is deprecated.'));
+        }
+        return _.extend(pluginArgs, result);
+      });
+  };
+};
+
 module.exports = HtmlWebpackPlugin;

package/lib/compiler.js

@@ -68,18 +68,6 @@ module.exports.compileTemplate = function compileTemplate (template, context, ou
   // Compile and return a promise
   return new Promise(function (resolve, reject) {
     childCompiler.runAsChild(function (err, entries, childCompilation) {
-      // Replace [hash] placeholders in filename
-      var outputName = compilation.mainTemplate.applyPluginsWaterfall('asset-path', outputOptions.filename, {
-        hash: childCompilation.hash,
-        chunk: entries[0]
-      });
-      // Restore the parent compilation to the state like it
-      // was before the child compilation
-      compilation.assets[outputName] = assetsBeforeCompilation[outputName];
-      if (assetsBeforeCompilation[outputName] === undefined) {
-        // If it wasn't there - delete it
-        delete compilation.assets[outputName];
-      }
       // Resolve / reject the promise
       if (childCompilation && childCompilation.errors && childCompilation.errors.length) {
         var errorDetails = childCompilation.errors.map(function (error) {
@@ -89,6 +77,18 @@ module.exports.compileTemplate = function compileTemplate (template, context, ou
       } else if (err) {
         reject(err);
       } else {
+        // Replace [hash] placeholders in filename
+        var outputName = compilation.mainTemplate.applyPluginsWaterfall('asset-path', outputOptions.filename, {
+          hash: childCompilation.hash,
+          chunk: entries[0]
+        });
+        // Restore the parent compilation to the state like it
+        // was before the child compilation
+        compilation.assets[outputName] = assetsBeforeCompilation[outputName];
+        if (assetsBeforeCompilation[outputName] === undefined) {
+          // If it wasn't there - delete it
+          delete compilation.assets[outputName];
+        }
         resolve({
           // Hash of the template entry point
           hash: entries[0].hash,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-webpack-plugin",
-  "version": "2.21.0",
+  "version": "2.24.0",
   "description": "Simplifies creation of HTML files to serve your webpack bundles",
   "main": "index.js",
   "files": [
@@ -30,31 +30,39 @@
     "url": "https://github.com/ampedandwired/html-webpack-plugin/issues"
   },
   "homepage": "https://github.com/ampedandwired/html-webpack-plugin",
+  "semistandard": {
+    "ignore": [
+      "examples/*/dist/**/*.*"
+    ]
+  },
   "devDependencies": {
-    "appcache-webpack-plugin": "^1.2.1",
-    "css-loader": "^0.23.1",
-    "dir-compare": "1.0.1",
-    "es6-promise": "^3.2.1",
+    "appcache-webpack-plugin": "^1.3.0",
+    "css-loader": "^0.25.0",
+    "dir-compare": "1.2.0",
+    "es6-promise": "^4.0.5",
     "extract-text-webpack-plugin": "^1.0.1",
-    "file-loader": "^0.8.5",
-    "html-loader": "^0.4.3",
+    "file-loader": "^0.9.0",
+    "html-loader": "^0.4.4",
     "jade": "^1.11.0",
     "jade-loader": "^0.8.0",
-    "jasmine": "^2.4.1",
-    "rimraf": "^2.5.2",
-    "semistandard": "^7.0.5",
+    "jasmine": "^2.5.2",
+    "rimraf": "^2.5.4",
+    "semistandard": "8.0.0",
     "style-loader": "^0.13.1",
     "underscore-template-loader": "^0.7.3",
     "url-loader": "^0.5.7",
-    "webpack": "^1.13.0",
+    "webpack": "^1.13.2",
     "webpack-recompilation-simulator": "^1.3.0"
   },
   "dependencies": {
-    "bluebird": "^3.3.5",
-    "html-minifier": "^2.1.3",
-    "loader-utils": "^0.2.15",
-    "lodash": "^4.12.0",
-    "pretty-error": "^2.0.0",
+    "bluebird": "^3.4.6",
+    "html-minifier": "^3.1.0",
+    "loader-utils": "^0.2.16",
+    "lodash": "^4.16.4",
+    "pretty-error": "^2.0.2",
     "toposort": "^1.0.0"
+  },
+  "peerDependencies": {
+    "webpack": "1 || ^2.1.0-beta"
   }
 }