npm - html-webpack-plugin - Versions diffs - 4.0.0-beta.7 → 4.0.0-beta.8 - Mend

html-webpack-plugin 4.0.0-beta.7 → 4.0.0-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "html-webpack-plugin",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.8",
   "license": "MIT",
   "description": "Simplifies creation of HTML files to serve your webpack bundles",
   "author": "Jan Nicklas <j.nicklas@me.com> (https://github.com/jantimon)",

package/typings.d.ts CHANGED Viewed

@@ -1,10 +1,13 @@
 import { AsyncSeriesWaterfallHook } from "tapable";
+import { Compiler } from 'webpack';
 import { Options as HtmlMinifierOptions } from "html-minifier";
 export = HtmlWebpackPlugin;
 declare class HtmlWebpackPlugin {
   constructor(options?: HtmlWebpackPlugin.Options);
+  apply(compiler: Compiler): void;
 }
 declare namespace HtmlWebpackPlugin {
@@ -102,22 +105,19 @@ declare namespace HtmlWebpackPlugin {
       | false // Pass an empty object to the template function
       | ((
           compilation: any,
-          assets,
-          assetTags: {
-            headTags: HtmlTagObject[];
-            bodyTags: HtmlTagObject[];
+          assets: {
+            publicPath: string;
+            js: Array<string>;
+            css: Array<string>;
+            manifest?: string;
+            favicon?: string;
           },
-          options: ProcessedOptions
-        ) => { [option: string]: any })
-      | ((
-          compilation: any,
-          assets,
           assetTags: {
             headTags: HtmlTagObject[];
             bodyTags: HtmlTagObject[];
           },
           options: ProcessedOptions
-        ) => Promise<{ [option: string]: any }>)
+        ) => { [option: string]: any } | Promise<{ [option: string]: any }>)
       | { [option: string]: any };
     /**
      * The title to use for the generated HTML document
@@ -189,8 +189,8 @@ declare namespace HtmlWebpackPlugin {
         publicPath: string;
         js: Array<string>;
         css: Array<string>;
-        favicon?: string | undefined;
-        manifest?: string | undefined;
+        favicon?: string;
+        manifest?: string;
       };
       outputName: string;
       plugin: HtmlWebpackPlugin;

package/CHANGELOG.md.orig DELETED Viewed

@@ -1,376 +0,0 @@
-# Change Log
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-<a name="3.0.3"></a>
-## [3.0.3](https://github.com/jantimon/html-webpack-plugin/compare/v3.0.2...v3.0.3) (2018-03-01)
-<<<<<<< HEAD
-=======
-### Refactor
-* **performance:** Reduce the amount of chunk information gathered based on #825 ([06c59a7](https://github.com/jantimon/html-webpack-plugin/commit/06c59a7))
->>>>>>> chore(release): 3.0.3
-<a name="3.0.2"></a>
-## [3.0.2](https://github.com/jantimon/html-webpack-plugin/compare/v3.0.1...v3.0.2) (2018-03-01)
-### Bug Fixes
-* **query-loader:** In case no query is provided, return an empty object. This fixes #727 ([7587754](https://github.com/jantimon/html-webpack-plugin/commit/7587754))
-<a name="3.0.1"></a>
-## [3.0.1](https://github.com/jantimon/html-webpack-plugin/compare/v3.0.0...v3.0.1) (2018-03-01)
-### Bug Fixes
-* **package:** Remove the extract-text-webpack-plugin peer dependency ([57411a9](https://github.com/jantimon/html-webpack-plugin/commit/57411a9))
-<a name="3.0.0"></a>
-## [3.0.0](https://github.com/jantimon/html-webpack-plugin/compare/v2.30.1...v3.0.0) (2018-28-02)
-### Features
-* Add support for the new [https://github.com/webpack/tapable](webpack tapable) to be compatible with webpack 4.x
-* Remove bluebird dependency
-### BREAKING CHANGES
-* Similar to webpack 4.x the support for node versions older than 6 are no longer supported
-<a name="2.30.1"></a>
-## 2.30.1
-* Revert part the performance optimization (#723) because of #753.
-<a name="2.30.0"></a>
-## 2.30.0
-* Add manual sort
-* Performance improvements (#723)
-<a name="2.29.0"></a>
-## 2.29.0
-* Add support for Webpack 3
-<a name="2.28.0"></a>
-## 2.28.0
-* Backport 3.x void tag for plugin authors
-<a name="2.27.1"></a>
-## 2.27.1
-* Revert 2.25.0 loader resolving
-<a name="2.27.0"></a>
-## 2.27.0
-* Fix a chunksorter webpack 2 issue (#569)
-* Fix template path resolving(#542)
-<a name="2.26.0"></a>
-## 2.26.0
-* Allow plugins to add attributes without values to the `<script>` and `<link>` tags
-<a name="2.25.0"></a>
-## 2.25.0
-* Clearer loader output
-* Add basic support for webpack 2
-<a name="2.24.1"></a>
-## 2.24.1
-* Hide event deprecated warning of 'applyPluginsAsyncWaterfall' for html-webpack-plugin-after-emit and improve the warning message.
-<a name="2.24.0"></a>
-## 2.24.0
-* Update dependencies
-* Add deprecate warning for plugins not returning a result
-* Add [path] for favicons
-<a name="2.23.0"></a>
-## 2.23.0
-* Update dependencies
-* Stop automated tests for webpack 2 beta because of #401
-<a name="2.22.0"></a>
-## 2.22.0
-* Update dependencies
-<a name="2.21.1"></a>
-## 2.21.1
-* Better error handling (#354)
-<a name="2.21.0"></a>
-## 2.21.0
-* Add `html-webpack-plugin-alter-asset-tags` event to allow plugins to adjust the script/link tags
-<a name="2.20.0"></a>
-## 2.20.0
-* Exclude chunks works now even if combined with dependency sort
-<a name="2.19.0"></a>
-## 2.19.0
-* Add `html-webpack-plugin-alter-chunks` event for custom chunk sorting and interpolation
-<a name="2.18.0"></a>
-## 2.18.0
-* Updated all dependencies
-<a name="2.17.0"></a>
-## 2.17.0
-* Add `type` attribute to `script` element to prevent issues in Safari 9.1.1
-<a name="2.16.2"></a>
-## 2.16.2
-* Fix bug introduced by 2.16.2. Fixes #315
-<a name="2.16.1"></a>
-## 2.16.1
-* Fix hot module replacement for webpack 2.x
-<a name="2.16.0"></a>
-## 2.16.0
-* Add support for dynamic filenames like index[hash].html
-<a name="2.15.0"></a>
-## 2.15.0
-* Add full unit test coverage for the webpack 2 beta version
-* For webpack 2 the default sort will be 'dependency' instead of 'id'
-* Upgrade dependencies
-<a name="2.14.0"></a>
-## 2.14.0
-* Export publicPath to the template
-* Add example for inlining css and js
-<a name="2.13.0"></a>
-## 2.13.0
-* Add support for absolute output file names
-* Add support for relative file names outside the output path
-<a name="2.12.0"></a>
-## 2.12.0
-* Basic Webpack 2.x support #225
-<a name="2.11.0"></a>
-## 2.11.0
-* Add `xhtml` option which is turned of by default. When activated it will inject self closed `<link href=".." />` tags instead of unclosed `<link href="..">` tags. https://github.com/ampedandwired/html-webpack-plugin/pull/255
-* Add support for webpack placeholders inside the public path e.g. `'/dist/[hash]/'`. https://github.com/ampedandwired/html-webpack-plugin/pull/249
-<a name="2.10.0"></a>
-## 2.10.0
-* Add `hash` field to the chunk object
-* Add `compilation` field to the templateParam object (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/237)
-* Add `html-webpack-plugin-before-html-generation` event
-* Improve error messages
-<a name="2.9.0"></a>
-## 2.9.0
-* Fix favicon path (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/185, https://github.com/ampedandwired/html-webpack-plugin/issues/208, https://github.com/ampedandwired/html-webpack-plugin/pull/215 )
-<a name="2.8.2"></a>
-## 2.8.2
-* Support relative URLs on Windows (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/205 )
-<a name="2.8.1"></a>
-## 2.8.1
-* Caching improvements (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/204 )
-<a name="2.8.0"></a>
-## 2.8.0
-* Add `dependency` mode for `chunksSortMode` to sort chunks based on their dependencies with each other
-<a name="2.7.2"></a>
-## 2.7.2
-* Add support for require in js templates
-<a name="2.7.1"></a>
-## 2.7.1
-* Refactoring
-* Fix relative windows path
-<a name="2.6.5"></a>
-## 2.6.5
-* Minor refactoring
-<a name="2.6.4"></a>
-## 2.6.4
-* Fix for `"Uncaught TypeError: __webpack_require__(...) is not a function"`
-* Fix incomplete cache modules causing "HtmlWebpackPlugin Error: No source available"
-* Fix some issues on Windows
-<a name="2.6.3"></a>
-## 2.6.3
-* Prevent parsing the base template with the html-loader
-<a name="2.6.2"></a>
-## 2.6.2
-* Fix `lodash` resolve error (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/172 )
-<a name="2.6.1"></a>
-## 2.6.1
-* Fix missing module (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/164 )
-<a name="2.6.0"></a>
-## 2.6.0
-* Move compiler to its own file
-* Improve error messages
-* Fix global HTML_WEBPACK_PLUGIN variable
-<a name="2.5.0"></a>
-## 2.5.0
-* Support `lodash` template's HTML _"escape"_ delimiter (`<%- %>`)
-* Fix bluebird warning (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/130 )
-* Fix an issue where incomplete cache modules were used
-<a name="2.4.0"></a>
-## 2.4.0
-* Don't recompile if the assets didn't change
-<a name="2.3.0"></a>
-## 2.3.0
-* Add events `html-webpack-plugin-before-html-processing`, `html-webpack-plugin-after-html-processing`, `html-webpack-plugin-after-emit` to allow other plugins to alter the html this plugin executes
-<a name="2.2.0"></a>
-## 2.2.0
-* Inject css and js even if the html file is incomplete (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/135 )
-* Update dependencies
-<a name="2.1.0"></a>
-## 2.1.0
-* Synchronize with the stable `@1` version
-<a name="2.0.4"></a>
-## 2.0.4
-* Fix `minify` option
-* Fix missing hash interpolation in publicPath
-<a name="2.0.3"></a>
-## 2.0.3
-* Add support for webpack.BannerPlugin
-<a name="2.0.2"></a>
-## 2.0.2
-* Add support for loaders in templates (fixes https://github.com/ampedandwired/html-webpack-plugin/pull/41 )
-* Remove `templateContent` option from configuration
-* Better error messages
-* Update dependencies
-<a name="1.7.0"></a>
-## 1.7.0
-* Add `chunksSortMode` option to configuration to control how chunks should be sorted before they are included to the html
-* Don't insert async chunks into html (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/95 )
-* Update dependencies
-<a name="1.6.2"></a>
-## 1.6.2
-* Fix paths on Windows
-* Fix missing hash interpolation in publicPath
-* Allow only `false` or `object` in `minify` configuration option
-<a name="1.6.1"></a>
-## 1.6.1
-* Add `size` field to the chunk object
-* Fix stylesheet `<link>`s being discarded when used with `"inject: 'head'"`
-* Update dependencies
-<a name="1.6.0"></a>
-## 1.6.0
-* Support placing templates in subfolders
-* Don't include chunks with undefined name (fixes https://github.com/ampedandwired/html-webpack-plugin/pull/60 )
-* Don't include async chunks
-<a name="1.5.2"></a>
-## 1.5.2
-* Update dependencies (lodash)
-<a name="1.5.1"></a>
-## 1.5.1
-* Fix error when manifest is specified (fixes https://github.com/ampedandwired/html-webpack-plugin/issues/56 )
-<a name="1.5.0"></a>
-## 1.5.0
-* Allow to inject javascript files into the head of the html page
-* Fix error reporting
-<a name="1.4.0"></a>
-## 1.4.0
-* Add `favicon.ico` option
-* Add html minifcation
-<a name="1.2.0"></a>
-## 1.2.0
-* Set charset using HTML5 meta attribute
-* Reload upon change when using webpack watch mode
-* Generate manifest attribute when using
-  [appcache-webpack-plugin](https://github.com/lettertwo/appcache-webpack-plugin)
-* Optionally add webpack hash as a query string to resources included in the HTML
-  (`hash: true`) for cache busting
-* CSS files generated using webpack (for example, by using the
-  [extract-text-webpack-plugin](https://github.com/webpack/extract-text-webpack-plugin))
-  are now automatically included into the generated HTML
-* More detailed information about the files generated by webpack is now available
-  to templates in the `o.htmlWebpackPlugin.files` attribute. See readme for more
-  details. This new attribute deprecates the old `o.htmlWebpackPlugin.assets` attribute.
-* The `templateContent` option can now be a function that returns the template string to use
-* Expose webpack configuration to templates (`o.webpackConfig`)
-* Sort chunks to honour dependencies between them (useful for use with CommonsChunkPlugin).

package/README.md.orig DELETED Viewed

@@ -1,603 +0,0 @@
-[![npm][npm]][npm-url]
-[![node][node]][node-url]
-![npm](https://img.shields.io/npm/dw/html-webpack-plugin.svg)
-[![deps][deps]][deps-url]
-[![tests][tests]][tests-url]
-[![Backers on Open Collective](https://opencollective.com/html-webpack-plugin/backers/badge.svg)](#backers)
- [![Sponsors on Open Collective](https://opencollective.com/html-webpack-plugin/sponsors/badge.svg)](#sponsors)
-<div align="center">
-  <img width="200" height="200" src="https://worldvectorlogo.com/logos/html5.svg">
-  <a href="https://github.com/webpack/webpack">
-    <img width="200" height="200"
-      src="https://webpack.js.org/assets/icon-square-big.svg">
-  </a>
-  <div>
-    <img width="100" height="100" title="Webpack Plugin" src="http://michael-ciniawsky.github.io/postcss-load-plugins/logo.svg">
-  </div>
-  <h1>HTML Webpack Plugin</h1>
-  <p>Plugin that simplifies creation of HTML files to serve your bundles</p>
-</div>
-<h2 align="center">Install Beta</h2>
-```bash
-  npm i --save-dev html-webpack-plugin@next
-```
-```bash
-  yarn add --dev html-webpack-plugin@next
-```
-<h2 align="center">Install Stable</h2>
-```bash
-  npm i --save-dev html-webpack-plugin
-```
-```bash
-  yarn add --dev html-webpack-plugin
-```
-This is a [webpack](http://webpack.js.org/) plugin that simplifies creation of HTML files to serve your `webpack` bundles. This is especially useful for `webpack` bundles that include a hash in the filename which changes every compilation. You can either let the plugin generate an HTML file for you, supply
-your own template using `lodash` templates or use your own loader.
-<h2 align="center">Sponsors</h2>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/0/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/0/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/1/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/1/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/2/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/2/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/3/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/3/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/4/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/4/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/5/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/5/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/6/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/6/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/7/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/7/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/8/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/8/avatar.svg"></a>
-<a href="https://opencollective.com/html-webpack-plugin/sponsor/9/website" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/sponsor/9/avatar.svg"></a>
-Thanks for supporting the ongoing improvements to the html-webpack-plugin!
-<h2 align="center">Zero Config</h2>
-The `html-webpack-plugin` works without configuration.
-It's a great addition to the [⚙️ webpack-config-plugins](https://github.com/namics/webpack-config-plugins/blob/master/README.md#zero-config-webpack-dev-server-example).
-<h2 align="center">Plugins</h2>
-The `html-webpack-plugin` provides [hooks](https://github.com/jantimon/html-webpack-plugin#events) to extend it to your needs. There are already some really powerful plugins which can be integrated with zero configuration
- * [webpack-subresource-integrity](https://www.npmjs.com/package/webpack-subresource-integrity) for enhanced asset security
- * [appcache-webpack-plugin](https://github.com/lettertwo/appcache-webpack-plugin) for iOS and Android offline usage
- * [favicons-webpack-plugin](https://github.com/jantimon/favicons-webpack-plugin) which generates favicons and icons for iOS, Android and desktop browsers
- * [html-webpack-harddisk-plugin](https://github.com/jantimon/html-webpack-harddisk-plugin) can be used to always write to disk the html file, useful when webpack-dev-server / HMR are being used
- * [html-webpack-inline-source-plugin](https://github.com/DustinJackson/html-webpack-inline-source-plugin) to inline your assets in the resulting HTML file
- * [html-webpack-inline-svg-plugin](https://github.com/thegc/html-webpack-inline-svg-plugin) to inline SVGs in the resulting HTML file.
- * [html-webpack-exclude-assets-plugin](https://github.com/jamesjieye/html-webpack-exclude-assets-plugin) for excluding assets using regular expressions
- * [html-webpack-include-assets-plugin](https://github.com/jharris4/html-webpack-include-assets-plugin) for including lists of js or css file paths (such as those copied by the copy-webpack-plugin).
- * [script-ext-html-webpack-plugin](https://github.com/numical/script-ext-html-webpack-plugin) to add `async`, `defer` or `module` attributes to your `<script>` elements, or even inline them
- * [style-ext-html-webpack-plugin](https://github.com/numical/style-ext-html-webpack-plugin) to convert your `<link>`s to external stylesheets into `<style>` elements containing internal CSS
- * [resource-hints-webpack-plugin](https://github.com/jantimon/resource-hints-webpack-plugin) to add resource hints for faster initial page loads using `<link rel='preload'>` and `<link rel='prefetch'>`
- * [preload-webpack-plugin](https://github.com/GoogleChrome/preload-webpack-plugin) for automatically wiring up asynchronous (and other types) of JavaScript chunks using `<link rel='preload'>` helping with lazy-loading
- * [link-media-html-webpack-plugin](https://github.com/yaycmyk/link-media-html-webpack-plugin) allows for injected stylesheet `<link />` tags to have their media attribute set automatically; useful for providing specific desktop/mobile/print etc. stylesheets that the browser will conditionally download
- * [inline-chunk-manifest-html-webpack-plugin](https://github.com/jouni-kantola/inline-chunk-manifest-html-webpack-plugin) for inlining webpack's chunk manifest. Default extracts manifest and inlines in `<head>`
- * [html-webpack-inline-style-plugin](https://github.com/djaax/html-webpack-inline-style-plugin) for inlining styles to HTML elements using [juice](https://github.com/Automattic/juice). Useful for email generation automatisation.
- * [html-webpack-exclude-empty-assets-plugin](https://github.com/KnisterPeter/html-webpack-exclude-empty-assets-plugin) removes empty assets from being added to the html. This fixes some problems with extract-text-plugin with webpack 4.
- * [webpack-concat-plugin](https://github.com/hxlniada/webpack-concat-plugin) for concat and uglify files that needn't to be webpack bundles(for legacy files) and inject to html-webpack-plugin.
- * [html-webpack-link-type-plugin](https://github.com/steadyapp/html-webpack-link-type-plugin) adds a configurable mimetype to resources injected as links (such as adding type="text/css" to external stylesheets) for compatibility with "strict mode".
- * [csp-html-webpack-plugin](https://github.com/slackhq/csp-html-webpack-plugin) to add [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) meta tags to the HTML output
-<h2 align="center">Usage</h2>
-The plugin will generate an HTML5 file for you that includes all your `webpack`
-bundles in the body using `script` tags. Just add the plugin to your `webpack`
-config as follows:
-**webpack.config.js**
-```js
-const HtmlWebpackPlugin = require('html-webpack-plugin')
-module.exports = {
-  entry: 'index.js',
-  output: {
-    path: __dirname + '/dist',
-    filename: 'index_bundle.js'
-  },
-  plugins: [
-    new HtmlWebpackPlugin()
-  ]
-}
-```
-This will generate a file `dist/index.html` containing the following
-```html
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>Webpack App</title>
-  </head>
-  <body>
-    <script src="index_bundle.js"></script>
-  </body>
-</html>
-```
-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 with the [ExtractTextPlugin](https://github.com/webpack/extract-text-webpack-plugin))
-then these will be included with `<link>` tags in the HTML head.
-If you have plugins that make use of it, `html-webpack-plugin` should be ordered first before any of the integrated plugins.
-<h2 align="center">Options</h2>
-You can pass a hash of configuration options to `html-webpack-plugin`.
-Allowed values are as follows
-|Name|Type|Default|Description|
-|:--:|:--:|:-----:|:----------|
-<<<<<<< HEAD
-|**`title`**|`{String}`|`Webpack App`|The title to use for the generated HTML document|
-|**`filename`**|`{String}`|`'index.html'`|The file to write the HTML to. Defaults to `index.html`. You can specify a subdirectory here too (eg: `assets/admin.html`)|
-|**`template`**|`{String}`|``|`webpack` require path to the template. Please see the [docs](https://github.com/jantimon/html-webpack-plugin/blob/master/docs/template-option.md) for details|
-=======
-|**[`title`](#)**|`{String}`|`Webpack App`|The title to use for the generated HTML document|
-|**[`filename`](#)**|`{String}`|`'index.html'`|The file to write the HTML to. Defaults to `index.html`. You can specify a subdirectory here too (eg: `assets/admin.html`)|
-|**[`template`](#)**|`{String}`|``|`webpack` relative or absolute path to the template. By default it will use `src/index.ejs` if it exists. Please see the [docs](https://github.com/jantimon/html-webpack-plugin/blob/master/docs/template-option.md) for details|
->>>>>>> fix: Use src/index.ejs by default if present
-|**[`templateParameters`](#)**|`{Boolean\|Object\|Function}`|``| Allows to overwrite the parameters used in the template |
-|**`inject`**|`{Boolean\|String}`|`true`|`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`**|`{String}`|``|Adds the given favicon path to the output HTML|
-|**`meta`**|`{Object}`|`{}`|Allows to inject `meta`-tags. E.g. `meta: {viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no'}`|
-|**`minify`**|`{Boolean\|Object}`|`true` if `mode` is `'production'`, otherwise `false`|Controls if and in what ways the output should be minified. See [minification](#minification) below for more details.|
-|**`hash`**|`{Boolean}`|`false`|If `true` then append a unique `webpack` compilation hash to all included scripts and CSS files. This is useful for cache busting|
-|**`cache`**|`{Boolean}`|`true`|Emit the file only if it was changed|
-|**`showErrors`**|`{Boolean}`|`true`|Errors details will be written into the HTML page|
-|**`chunks`**|`{?}`|`?`|Allows you to add only some chunks (e.g only the unit-test chunk)|
-|**[`chunksSortMode`](#plugins)**|`{String\|Function}`|`auto`|Allows to control how chunks should be sorted before they are included to the HTML. Allowed values are `'none' \| 'auto' \| 'dependency' \| 'manual' \| {Function}`|
-|**`excludeChunks`**|`{Array.<string>}`|``|Allows you to skip some chunks (e.g don't add the unit-test chunk)|
-|**`xhtml`**|`{Boolean}`|`false`|If `true` render the `link` tags as self-closing (XHTML compliant)|
-Here's an example webpack config illustrating how to use these options
-**webpack.config.js**
-```js
-{
-  entry: 'index.js',
-  output: {
-    path: __dirname + '/dist',
-    filename: 'index_bundle.js'
-  },
-  plugins: [
-    new HtmlWebpackPlugin({
-      title: 'My App',
-      filename: 'assets/admin.html'
-    })
-  ]
-}
-```
-### Generating Multiple HTML Files
-To generate more than one HTML file, declare the plugin more than
-once in your plugins array
-**webpack.config.js**
-```js
-{
-  entry: 'index.js',
-  output: {
-    path: __dirname + '/dist',
-    filename: 'index_bundle.js'
-  },
-  plugins: [
-    new HtmlWebpackPlugin(), // Generates default index.html
-    new HtmlWebpackPlugin({  // Also generate a test.html
-      filename: 'test.html',
-      template: 'src/assets/test.html'
-    })
-  ]
-}
-```
-### 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 `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.
-Details of other template loaders are [documented here](https://github.com/jantimon/html-webpack-plugin/blob/master/docs/template-option.md).
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-    title: 'Custom template',
-    // Load a custom template (lodash by default)
-    template: 'index.html'
-  })
-]
-```
-**index.html**
-```html
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8"/>
-    <title><%= htmlWebpackPlugin.options.title %></title>
-  </head>
-  <body>
-  </body>
-</html>
-```
-If you already have a template loader, you can use it to parse the template.
-Please note that this will also happen if you specify the html-loader and use `.html` file as template.
-**webpack.config.js**
-```js
-module: {
-  loaders: [
-    { test: /\.hbs$/, loader: "handlebars-loader" }
-  ]
-},
-plugins: [
-  new HtmlWebpackPlugin({
-    title: 'Custom template using Handlebars',
-    template: 'index.hbs'
-  })
-]
-```
-You can use the `lodash` syntax out of the box. If the `inject` feature doesn't fit your needs and you want full control over the asset placement use the [default template](https://github.com/jaketrent/html-webpack-template/blob/86f285d5c790a6c15263f5cc50fd666d51f974fd/index.html) of the [html-webpack-template project](https://github.com/jaketrent/html-webpack-template) as a starting point for writing your own.
-The following variables are available in the template:
-- `htmlWebpackPlugin`: data specific to this plugin
-  - `htmlWebpackPlugin.files`: a massaged representation of the
-    `assetsByChunkName` attribute of webpack's [stats](https://github.com/webpack/docs/wiki/node.js-api#stats)
-    object. It contains a mapping from entry point name to the bundle filename, eg:
-    ```json
-    "htmlWebpackPlugin": {
-      "files": {
-        "css": [ "main.css" ],
-        "js": [ "assets/head_bundle.js", "assets/main_bundle.js"],
-        "chunks": {
-          "head": {
-            "entry": "assets/head_bundle.js",
-            "css": [ "main.css" ]
-          },
-          "main": {
-            "entry": "assets/main_bundle.js",
-            "css": []
-          },
-        }
-      }
-    }
-    ```
-    If you've set a publicPath in your webpack config this will be reflected
-    correctly in this assets hash.
-  - `htmlWebpackPlugin.options`: the options hash that was passed to
-     the plugin. In addition to the options actually used by this plugin,
-     you can use this hash to pass arbitrary data through to your template.
-- `webpack`: the webpack [stats](https://github.com/webpack/docs/wiki/node.js-api#stats)
-  object. Note that this is the stats object as it was at the time the HTML template
-  was emitted and as such may not have the full set of stats that are available
-  after the webpack run is complete.
-- `webpackConfig`: the webpack configuration that was used for this compilation. This
-  can be used, for example, to get the `publicPath` (`webpackConfig.output.publicPath`).
-- `compilation`: the webpack [compilation](https://webpack.js.org/api/compilation/) object.
-  This can be used, for example, to get the contents of processed assets and inline them
-  directly in the page, through `compilation.assets[...].source()`
-  (see [the inline template example](examples/inline/template.pug)).
-### Filtering Chunks
-To include only certain chunks you can limit the chunks being used
-**webpack.config.js**
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-    chunks: ['app']
-  })
-]
-```
-It is also possible to exclude certain chunks by setting the `excludeChunks` option
-**webpack.config.js**
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-    excludeChunks: [ 'dev-helper' ]
-  })
-]
-```
-### Minification
-If the `minify` option is set to `true` (the default when webpack's `mode` is `'production'`),
-the generated HTML will be minified using [html-minifier](https://github.com/kangax/html-minifier)
-and the following options:
-```js
-{
-  collapseWhitespace: true,
-  removeComments: true,
-  removeRedundantAttributes: true,
-  removeScriptTypeAttributes: true,
-  removeStyleLinkTypeAttributes: true,
-  useShortDoctype: true
-}
-```
-To use custom [html-minifier options](https://github.com/kangax/html-minifier#options-quick-reference)
-pass an object to `minify` instead. This object will not be merged with the defaults above.
-To disable minification during production mode set the `minify` option to `false`.
-### Meta Tags
-If the `meta` option is set the html-webpack-plugin will inject meta tags.
-For the default template the html-webpack-plugin will already provide a default for the `viewport` meta tag.
-Please take a look at this well maintained list of almost all [possible meta tags](https://github.com/joshbuchea/HEAD#meta).
-#### name/content meta tags
-Most meta tags are configured by setting a `name` and a `content` attribute.
-To add those use a key/value pair:
-**webpack.config.js**
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-      'meta': {
-        'viewport': 'width=device-width, initial-scale=1, shrink-to-fit=no',
-        // Will generate: <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-        'theme-color': '#4285f4'
-        // Will generate: <meta name="theme-color" content="#4285f4">
-      }
-  })
-]
-```
-#### Simulate http response headers
-The **http-equiv** attribute is essentially used to simulate a HTTP response header.
-This format is supported using an object notation which allows you to add any attribute:
-**webpack.config.js**
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-    'meta': {
-      'Content-Security-Policy': { 'http-equiv': 'Content-Security-Policy', 'content': 'default-src https:' },
-      // Will generate: <meta http-equiv="Content-Security-Policy" content="default-src https:">
-      // Which equals to the following http header: `Content-Security-Policy: default-src https:`
-      'set-cookie': { 'http-equiv': 'set-cookie', content: 'name=value; expires=date; path=url' },
-      // Will generate: <meta http-equiv="set-cookie" content="value; expires=date; path=url">
-      // Which equals to the following http header: `set-cookie: value; expires=date; path=url`
-    }
-  })
-]
-```
-### Long Term Caching
-For long term caching add `contenthash/templatehash` to the filename.
-**Example:**
-```js
-plugins: [
-  new HtmlWebpackPlugin({
-    filename: 'index.[contenthash].html'
-  })
-]
-```
-`contenthash/templatehash` is the hash of the content of the output file.
-Optionally, You can configure like `[<hashType>:contenthash:<digestType>:<length>]`
-* `hashType` - one of `sha1`, `md5`, `sha256`, `sha512`  or any other node.js supported hash type
-* `digestType` - one of `hex`, `base26`, `base32`, `base36`, `base49`, `base52`, `base58`, `base62`, `base64`
-* `maxlength` - maximum length of the generated hash in chars
-**Defaults:** `[md5:contenthash:hex:9999]`
-### Events
-To allow other [plugins](https://github.com/webpack/docs/wiki/plugins) to alter the HTML this plugin executes
-[tapable](https://github.com/webpack/tapable/tree/master) hooks.
-The [lib/hooks.js](https://github.com/jantimon/html-webpack-plugin/blob/master/lib/hooks.js) contains all information
-about which values are passed.
-[![Concept flow uml](https://raw.githubusercontent.com/jantimon/html-webpack-plugin/master/flow.png)](https://github.com/jantimon/html-webpack-plugin/blob/master/flow.puml)
-#### `beforeAssetTagGeneration` hook
-```
-    AsyncSeriesWaterfallHook<{
-      assets: {
-        publicPath: string,
-        js: Array<{string}>,
-        css: Array<{string}>,
-        favicon?: string | undefined,
-        manifest?: string | undefined
-      },
-      outputName: string,
-      plugin: HtmlWebpackPlugin
-    }>
-```
-#### `alterAssetTags` hook
-```
-    AsyncSeriesWaterfallHook<{
-      assetTags: {
-        scripts: Array<HtmlTagObject>,
-        styles: Array<HtmlTagObject>,
-        meta: Array<HtmlTagObject>,
-      },
-      outputName: string,
-      plugin: HtmlWebpackPlugin
-    }>
-```
-#### `alterAssetTagGroups` hook
-```
-    AsyncSeriesWaterfallHook<{
-      headTags: Array<HtmlTagObject | HtmlTagObject>,
-      bodyTags: Array<HtmlTagObject | HtmlTagObject>,
-      outputName: string,
-      plugin: HtmlWebpackPlugin
-    }>
-```
-#### `afterTemplateExecution` hook
-```
-    AsyncSeriesWaterfallHook<{
-      html: string,
-      headTags: Array<HtmlTagObject | HtmlTagObject>,
-      bodyTags: Array<HtmlTagObject | HtmlTagObject>,
-      outputName: string,
-      plugin: HtmlWebpackPlugin,
-    }>
-```
-#### `beforeEmit` hook
-```
-    AsyncSeriesWaterfallHook<{
-      html: string,
-      outputName: string,
-      plugin: HtmlWebpackPlugin,
-    }>
-```
-#### `afterEmit` hook
-```
-    AsyncSeriesWaterfallHook<{
-      outputName: string,
-      plugin: HtmlWebpackPlugin
-    }>
-```
-Example implementation: [webpack-subresource-integrity](https://www.npmjs.com/package/webpack-subresource-integrity)
-**plugin.js**
-```js
-// If your plugin is direct dependent to the html webpack plugin:
-const HtmlWebpackPlugin = require('html-webpack-plugin');
-// If your plugin is using html-webpack-plugin as an optional dependency
-// you can use https://github.com/tallesl/node-safe-require instead:
-const HtmlWebpackPlugin = require('safe-require')('html-webpack-plugin');
-class MyPlugin {
-  apply (compiler) {
-    compiler.hooks.compilation.tap('MyPlugin', (compilation) => {
-      console.log('The compiler is starting a new compilation...')
-      // Staic Plugin interface |compilation |HOOK NAME | register listener
-      HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync(
-        'MyPlugin', // <-- Set a meaningful name here for stacktraces
-        (data, cb) => {
-          // Manipulate the content
-          data.html += 'The Magic Footer'
-          // Tell webpack to move on
-          cb(null, data)
-        }
-      )
-    })
-  }
-}
-module.exports = MyPlugin
-```
-**webpack.config.js**
-```js
-plugins: [
-  new MyPlugin({ options: '' })
-]
-```
-Note that the callback must be passed the HtmlWebpackPluginData in order to pass this onto any other plugins listening on the same `beforeEmit` event
-<h2 align="center">Maintainers</h2>
-<table>
-  <tbody>
-    <tr>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://avatars3.githubusercontent.com/u/4113649?v=3&s=150">
-        </br>
-        <a href="https://github.com/jantimon">Jan Nicklas</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://avatars2.githubusercontent.com/u/4112409?v=3&s=150">
-        </br>
-        <a href="https://github.com/mastilver">Thomas Sileghem</a>
-      </td>
-    </tr>
-  <tbody>
-</table>
-## Backers
-Thank you to all our backers!
-If you want to support the project as well [become a sponsor](https://opencollective.com/html-webpack-plugin#sponsor) or a [a backer](https://opencollective.com/html-webpack-plugin#backer).
-<a href="https://opencollective.com/html-webpack-plugin/backer/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/0/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/1/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/2/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/3/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/4/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/5/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/6/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/7/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/8/avatar.svg?requireActive=false"></a>
-<a href="https://opencollective.com/html-webpack-plugin/backer/9/website?requireActive=false" target="_blank"><img src="https://opencollective.com/html-webpack-plugin/backer/9/avatar.svg?requireActive=false"></a>
-## Contributors
-This project exists thanks to all the people who contribute.
-You're free to contribute to this project by submitting [issues](https://github.com/jantimon/html-webpack-plugin/issues) and/or [pull requests](https://github.com/jantimon/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).
-<a href="https://github.com/jantimon/html-webpack-plugin/graphs/contributors"><img src="https://opencollective.com/html-webpack-plugin/contributors.svg?width=890&button=false" /></a>
-[npm]: https://img.shields.io/npm/v/html-webpack-plugin.svg
-[npm-url]: https://npmjs.com/package/html-webpack-plugin
-[node]: https://img.shields.io/node/v/html-webpack-plugin.svg
-[node-url]: https://nodejs.org
-[deps]: https://david-dm.org/jantimon/html-webpack-plugin.svg
-[deps-url]: https://david-dm.org/jantimon/html-webpack-plugin
-[tests]: http://img.shields.io/travis/jantimon/html-webpack-plugin.svg
-[tests-url]: https://travis-ci.org/jantimon/html-webpack-plugin