html-webpack-plugin 4.0.0 → 4.0.4

package/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 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.
 
+## [4.0.4](https://github.com/jantimon/html-webpack-plugin/compare/v4.0.3...v4.0.4) (2020-04-01)
+
+
+### Bug Fixes
+
+* Fix querystring encoding ([#1386](https://github.com/jantimon/html-webpack-plugin/issues/1386)) ([4f48a39](https://github.com/jantimon/html-webpack-plugin/commit/4f48a39e5738a5d431be2bec39c1b1f0de800d57)), closes [#1355](https://github.com/jantimon/html-webpack-plugin/issues/1355)
+
+
+
+## [4.0.3](https://github.com/jantimon/html-webpack-plugin/compare/v4.0.2...v4.0.3) (2020-03-28)
+
+
+### Bug Fixes
+
+* add webpack, tapable and html-minifier-terser as dependencies because of types.d.ts ([238da81](https://github.com/jantimon/html-webpack-plugin/commit/238da8123950f87267954fd448f3e6b0fb1ead17))
+
+
+
+## [4.0.2](https://github.com/jantimon/html-webpack-plugin/compare/v4.0.1...v4.0.2) (2020-03-26)
+
+
+### Bug Fixes
+
+* don't remove trailing slashes from self closing tags by default ([2281e4b](https://github.com/jantimon/html-webpack-plugin/commit/2281e4bfda9b91c4a83d63bfc8df8372d1e6ae9e))
+
+
+
+## [4.0.1](https://github.com/jantimon/html-webpack-plugin/compare/v4.0.0...v4.0.1) (2020-03-23)
+
+
+### Bug Fixes
+
+* update typedefs to match with html-minifier-terser ([2698c7e](https://github.com/jantimon/html-webpack-plugin/commit/2698c7e45a7f12113a07b256dc400ec89666130d))
+
+
+
 # [4.0.0](https://github.com/jantimon/html-webpack-plugin/compare/v3.2.0...v4.0.0) (2020-03-23)
 
 The summary can be found in the [**release blog post**](https://dev.to/jantimon/html-webpack-plugin-4-has-been-released-125d).

package/README.md

@@ -19,17 +19,7 @@
   <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>
+<h2 align="center">Install</h2>
 
 ```bash
   npm i --save-dev html-webpack-plugin
@@ -291,7 +281,7 @@ The following variables are available in the template:
 - `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.
+- `compilation`: the webpack [compilation object](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)).

package/index.js

@@ -115,10 +115,11 @@ class HtmlWebpackPlugin {
 
     const minify = this.options.minify;
     if (minify === true || (minify === 'auto' && isProductionLikeMode)) {
-      /** @type { import('html-minifier').Options } */
+      /** @type { import('html-minifier-terser').Options } */
       this.options.minify = {
-        // https://github.com/kangax/html-minifier#options-quick-reference
+        // https://www.npmjs.com/package/html-minifier-terser#options-quick-reference
         collapseWhitespace: true,
+        keepClosingSlash: true,
         removeComments: true,
         removeRedundantAttributes: true,
         removeScriptTypeAttributes: true,
@@ -938,10 +939,35 @@ class HtmlWebpackPlugin {
    * Encode each path component using `encodeURIComponent` as files can contain characters
    * which needs special encoding in URLs like `+ `.
    *
+   * Valid filesystem characters which need to be encoded for urls:
+   *
+   * # pound, % percent, & ampersand, { left curly bracket, } right curly bracket,
+   * \ back slash, < left angle bracket, > right angle bracket, * asterisk, ? question mark,
+   * blank spaces, $ dollar sign, ! exclamation point, ' single quotes, " double quotes,
+   * : colon, @ at sign, + plus sign, ` backtick, | pipe, = equal sign
+   *
+   * However the query string must not be encoded:
+   *
+   *  fo:demonstration-path/very fancy+name.js?path=/home?value=abc&value=def#zzz
+   *    ^             ^    ^    ^     ^    ^  ^    ^^    ^     ^   ^     ^   ^
+   *    |             |    |    |     |    |  |    ||    |     |   |     |   |
+   *    encoded       |    |    encoded    |  |    ||    |     |   |     |   |
+   *                 ignored              ignored  ignored     ignored   ignored
+   *
    * @param {string} filePath
    */
   urlencodePath (filePath) {
-    return filePath.split('/').map(encodeURIComponent).join('/');
+    // People use the filepath in quite unexpected ways.
+    // Try to extract the first querystring of the url:
+    //
+    // some+path/demo.html?value=abc?def
+    //
+    const queryStringStart = filePath.indexOf('?');
+    const urlPath = queryStringStart === -1 ? filePath : filePath.substr(0, queryStringStart);
+    const queryString = filePath.substr(urlPath.length);
+    // Encode all parts except '/' which are not part of the querystring:
+    const encodedUrlPath = urlPath.split('/').map(encodeURIComponent).join('/');
+    return encodedUrlPath + queryString;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-webpack-plugin",
-  "version": "4.0.0",
+  "version": "4.0.4",
   "license": "MIT",
   "description": "Simplifies creation of HTML files to serve your webpack bundles",
   "author": "Jan Nicklas <j.nicklas@me.com> (https://github.com/jantimon)",
@@ -28,10 +28,8 @@
     ]
   },
   "devDependencies": {
-    "@types/html-minifier": "3.5.3",
     "@types/loader-utils": "1.1.3",
     "@types/node": "11.13.9",
-    "@types/tapable": "1.0.4",
     "appcache-webpack-plugin": "1.4.0",
     "commitizen": "4.0.3",
     "css-loader": "2.1.1",
@@ -52,6 +50,9 @@
     "webpack-recompilation-simulator": "3.0.0"
   },
   "dependencies": {
+    "@types/html-minifier-terser": "^5.0.0",
+    "@types/tapable": "^1.0.5",
+    "@types/webpack": "^4.41.8",
     "html-minifier-terser": "^5.0.1",
     "loader-utils": "^1.2.3",
     "lodash": "^4.17.15",

package/typings.d.ts

@@ -1,6 +1,6 @@
 import { AsyncSeriesWaterfallHook } from "tapable";
 import { Compiler, compilation } from 'webpack';
-import { Options as HtmlMinifierOptions } from "html-minifier";
+import { Options as HtmlMinifierOptions } from "html-minifier-terser";
 
 export = HtmlWebpackPlugin;