html-minifier-next 1.1.5 → 1.2.1

package/README.md

@@ -41,7 +41,7 @@ const { minify } = require('html-minifier-next');
 const result = await minify('<p title="blah" id="moo">foo</p>', {
   removeAttributeQuotes: true,
 });
-result; // '<p title=blah id=moo>foo</p>'
+result; // “<p title=blah id=moo>foo</p>”
 ```
 
 See [the original blog post](http://perfectionkills.com/experimenting-with-html-minifier) for details of [how it works](http://perfectionkills.com/experimenting-with-html-minifier#how_it_works), [description of each option](http://perfectionkills.com/experimenting-with-html-minifier#options), [testing results](http://perfectionkills.com/experimenting-with-html-minifier#field_testing), and [conclusions](http://perfectionkills.com/experimenting-with-html-minifier#cost_and_benefits).
@@ -54,21 +54,22 @@ How does HTMLMinifier compare to other solutions, like [minimize](https://github
 
 | Site | Original size (KB) | HTMLMinifier | minimize | htmlcompressor.com |
 | --- | --- | --- | --- | --- |
-| [Amazon](https://www.amazon.com/) | 695 | **625** | 682 | n/a |
-| [BBC](https://www.bbc.co.uk/) | 655 | **602** | 649 | n/a |
-| [ECMAScript](https://tc39.es/ecma262/) | 7197 | **6353** | 6573 | n/a |
-| [EFF](https://www.eff.org/) | 60 | **51** | 54 | n/a |
-| [Eloquent JavaScript](https://eloquentjavascript.net/) | 6 | **5** | 6 | n/a |
-| [FAZ](https://www.faz.net/aktuell/) | 1793 | **1667** | 1705 | n/a |
-| [Frontend Dogma](https://frontenddogma.com/) | 116 | **112** | 125 | n/a |
-| [Google](https://www.google.com/) | 51 | **46** | 51 | n/a |
-| [HTMLMinifier](https://github.com/kangax/html-minifier) | 366 | **245** | 343 | n/a |
-| [Mastodon](https://mastodon.social/explore) | 37 | **27** | 36 | n/a |
-| [NBC](https://www.nbc.com/) | 1022 | **932** | 1010 | n/a |
-| [New York Times](https://www.nytimes.com/) | 951 | **809** | 939 | n/a |
-| [United Nations](https://www.un.org/) | 9 | **7** | 8 | n/a |
-| [W3C](https://www.w3.org/) | 51 | **36** | 42 | n/a |
-| [Wikipedia](https://en.wikipedia.org/wiki/Main_Page) | 114 | **100** | 107 | n/a |
+| [A List Apart](https://alistapart.com/) | 64 | **54** | 59 | 57 |
+| [Amazon](https://www.amazon.com/) | 206 | **195** | 203 | 200 |
+| [BBC](https://www.bbc.co.uk/) | 767 | **703** | 761 | n/a |
+| [CSS-Tricks](https://css-tricks.com/) | 166 | **124** | 152 | 148 |
+| [ECMAScript](https://tc39.es/ecma262/) | 7204 | **6361** | 6581 | n/a |
+| [EFF](https://www.eff.org/) | 57 | **48** | 52 | 52 |
+| [FAZ](https://www.faz.net/aktuell/) | 1767 | **1641** | 1679 | n/a |
+| [Frontend Dogma](https://frontenddogma.com/) | 119 | **114** | 128 | 118 |
+| [Google](https://www.google.com/) | 51 | **46** | 50 | 50 |
+| [HTMLMinifier](https://github.com/kangax/html-minifier) | 373 | **250** | 349 | n/a |
+| [Mastodon](https://mastodon.social/explore) | 37 | **28** | 36 | 36 |
+| [NBC](https://www.nbc.com/) | 601 | **549** | 593 | n/a |
+| [New York Times](https://www.nytimes.com/) | 822 | **701** | 811 | n/a |
+| [United Nations](https://www.un.org/) | 9 | **7** | 8 | 8 |
+| [W3C](https://www.w3.org/) | 50 | **36** | 41 | 39 |
+| [Wikipedia](https://en.wikipedia.org/wiki/Main_Page) | 225 | **204** | 215 | 215 |
 
 ## Options quick reference
 
@@ -76,7 +77,7 @@ Most of the options are disabled by default.
 
 | Option | Description | Default |
 | --- | --- | --- |
-| `caseSensitive` | Treat attributes in case sensitive manner (useful for custom HTML tags) | `false` |
+| `caseSensitive` | Treat attributes in case sensitive manner (useful for custom HTML elements) | `false` |
 | `collapseBooleanAttributes` | [Omit attribute values from boolean attributes](http://perfectionkills.com/experimenting-with-html-minifier#collapse_boolean_attributes) | `false` |
 | `customFragmentQuantifierLimit` | Set maximum quantifier limit for custom fragments to prevent ReDoS attacks | `200` |
 | `collapseInlineTagWhitespace` | Don’t leave any spaces between `display:inline;` elements when collapsing. Must be used in conjunction with `collapseWhitespace=true` | `false` |
@@ -91,7 +92,8 @@ Most of the options are disabled by default.
 | `html5` | Parse input according to HTML5 specifications | `true` |
 | `ignoreCustomComments` | Array of regexes that allow to ignore certain comments, when matched | `[ /^!/, /^\s*#/ ]` |
 | `ignoreCustomFragments` | Array of regexes that allow to ignore certain fragments, when matched (e.g. `<?php ... ?>`, `{{ ... }}`, etc.) | `[ /<%[\s\S]*?%>/, /<\?[\s\S]*?\?>/ ]` |
-| `includeAutoGeneratedTags` | Insert tags generated by HTML parser | `true` |
+| `includeAutoGeneratedTags` | Insert elements generated by HTML parser | `true` |
+| `inlineCustomElements` | Array of names of custom elements which are inline | `[]` |
 | `keepClosingSlash` | Keep the trailing slash on singleton elements | `false` |
 | `maxInputLength` | Maximum input length to prevent ReDoS attacks (disabled by default) | `undefined` |
 | `maxLineLength` | Specify a maximum line length. Compressed output will be split by newlines at valid HTML split-points |
@@ -110,8 +112,8 @@ Most of the options are disabled by default.
 | `removeEmptyElements` | [Remove all elements with empty contents](http://perfectionkills.com/experimenting-with-html-minifier#remove_empty_elements) | `false` |
 | `removeOptionalTags` | [Remove optional tags](http://perfectionkills.com/experimenting-with-html-minifier#remove_optional_tags) | `false` |
 | `removeRedundantAttributes` | [Remove attributes when value matches default.](http://perfectionkills.com/experimenting-with-html-minifier#remove_redundant_attributes) | `false` |
-| `removeScriptTypeAttributes` | Remove `type="text/javascript"` from `script` tags. Other `type` attribute values are left intact | `false` |
-| `removeStyleLinkTypeAttributes`| Remove `type="text/css"` from `style` and `link` tags. Other `type` attribute values are left intact | `false` |
+| `removeScriptTypeAttributes` | Remove `type="text/javascript"` from `script` elements. Other `type` attribute values are left intact | `false` |
+| `removeStyleLinkTypeAttributes`| Remove `type="text/css"` from `style` and `link` elements. Other `type` attribute values are left intact | `false` |
 | `removeTagWhitespace` | Remove space between attributes whenever possible. **Note that this will result in invalid HTML!** | `false` |
 | `sortAttributes` | [Sort attributes by frequency](#sorting-attributes--style-classes) | `false` |
 | `sortClassName` | [Sort style classes by frequency](#sorting-attributes--style-classes) | `false` |
@@ -130,11 +132,11 @@ If you have chunks of markup you would like preserved, you can wrap them `<!-- h
 
 ### Minifying JSON-LD
 
-You can minify script tags with JSON-LD by setting the option `{ processScripts: ['application/ld+json'] }`. Note that this minification is very rudimentary, it is mainly useful for removing newlines and excessive whitespace. 
+You can minify script elements with JSON-LD by setting the option `{ processScripts: ['application/ld+json'] }`. Note that this minification is very rudimentary, it is mainly useful for removing newlines and excessive whitespace. 
 
-### Preserving SVG tags
+### Preserving SVG elements
 
-SVG tags are automatically recognized, and when they are minified, both case-sensitivity and closing-slashes are preserved, regardless of the minification settings used for the rest of the file.
+SVG elements are automatically recognized, and when they are minified, both case-sensitivity and closing-slashes are preserved, regardless of the minification settings used for the rest of the file.
 
 ### Working with invalid markup
 

package/cli.js

@@ -113,6 +113,7 @@ const mainOptions = {
   ignoreCustomComments: ['Array of regex\'es that allow to ignore certain comments, when matched', parseJSONRegExpArray],
   ignoreCustomFragments: ['Array of regex\'es that allow to ignore certain fragments, when matched (e.g. <?php ... ?>, {{ ... }})', parseJSONRegExpArray],
   includeAutoGeneratedTags: 'Insert tags generated by HTML parser',
+  inlineCustomElements: ['Array of names of custom elements which are inline', parseJSONArray],
   keepClosingSlash: 'Keep the trailing slash on singleton elements',
   maxInputLength: ['Maximum input length to prevent ReDoS attacks', parseInt],
   maxLineLength: ['Max line length', parseInt],
@@ -140,7 +141,7 @@ const mainOptions = {
   useShortDoctype: 'Replaces the doctype with the short (HTML5) doctype'
 };
 
-// configure commandline flags
+// Configure command line flags
 const mainOptionKeys = Object.keys(mainOptions);
 mainOptionKeys.forEach(function (key) {
   const option = mainOptions[key];
@@ -304,4 +305,4 @@ if (inputDir || outputDir) {
   process.stdin.on('data', function (data) {
     content += data;
   }).on('end', writeMinify);
-}
+}

package/dist/htmlminifier.cjs

@@ -496,9 +496,7 @@ class TokenChain {
   }
 }
 
-function trimWhitespace(str) {
-  return str && str.replace(/^[ \n\r\t\f]+/, '').replace(/[ \n\r\t\f]+$/, '');
-}
+const trimWhitespace = str => str && str.replace(/^[ \n\r\t\f]+/, '').replace(/[ \n\r\t\f]+$/, '');
 
 function collapseWhitespaceAll(str) {
   // Non-breaking space is specifically handled inside the replacer function here:
@@ -550,14 +548,14 @@ function collapseWhitespace(str, options, trimLeft, trimRight, collapseAll) {
   return lineBreakBefore + str + lineBreakAfter;
 }
 
-// non-empty tags that will maintain whitespace around them
-const inlineTags = new Set(['a', 'abbr', 'acronym', 'b', 'bdi', 'bdo', 'big', 'button', 'cite', 'code', 'del', 'dfn', 'em', 'font', 'i', 'ins', 'kbd', 'label', 'mark', 'math', 'nobr', 'object', 'q', 'rp', 'rt', 'rtc', 'ruby', 's', 'samp', 'select', 'small', 'span', 'strike', 'strong', 'sub', 'sup', 'svg', 'textarea', 'time', 'tt', 'u', 'var']);
-// non-empty tags that will maintain whitespace within them
+// non-empty elements that will maintain whitespace around them
+const inlineHtmlElements = ['a', 'abbr', 'acronym', 'b', 'bdi', 'bdo', 'big', 'button', 'cite', 'code', 'del', 'dfn', 'em', 'font', 'i', 'img', 'input', 'ins', 'kbd', 'label', 'mark', 'math', 'meter', 'nobr', 'object', 'output', 'progress', 'q', 'rp', 'rt', 'rtc', 'ruby', 's', 'samp', 'select', 'small', 'span', 'strike', 'strong', 'sub', 'sup', 'svg', 'textarea', 'time', 'tt', 'u', 'var', 'wbr'];
+// non-empty elements that will maintain whitespace within them
 const inlineTextTags = new Set(['a', 'abbr', 'acronym', 'b', 'big', 'del', 'em', 'font', 'i', 'ins', 'kbd', 'mark', 'nobr', 'rp', 's', 'samp', 'small', 'span', 'strike', 'strong', 'sub', 'sup', 'time', 'tt', 'u', 'var']);
-// self-closing tags that will maintain whitespace around them
+// self-closing elements that will maintain whitespace around them
 const selfClosingInlineTags = new Set(['comment', 'img', 'input', 'wbr']);
 
-function collapseWhitespaceSmart(str, prevTag, nextTag, options) {
+function collapseWhitespaceSmart(str, prevTag, nextTag, options, inlineTags) {
   let trimLeft = prevTag && !selfClosingInlineTags.has(prevTag);
   if (trimLeft && !options.collapseInlineTagWhitespace) {
     trimLeft = prevTag.charAt(0) === '/' ? !inlineTags.has(prevTag.slice(1)) : !inlineTextTags.has(prevTag);
@@ -1357,6 +1355,7 @@ async function minifyHTML(value, options, partialMarkup) {
   let uidIgnore;
   let uidAttr;
   let uidPattern;
+  let inlineTags = new Set([...inlineHtmlElements, ...(options.inlineCustomElements ?? [])]);
 
   // temporarily replace ignored chunks with comments,
   // so that we don't have to worry what's there.
@@ -1488,7 +1487,7 @@ async function minifyHTML(value, options, partialMarkup) {
       const match = str.match(/^<\/([\w:-]+)>$/);
       if (match) {
         endTag = match[1];
-      } else if (/>$/.test(str) || (buffer[index] = collapseWhitespaceSmart(str, null, nextTag, options))) {
+      } else if (/>$/.test(str) || (buffer[index] = collapseWhitespaceSmart(str, null, nextTag, options, inlineTags))) {
         break;
       }
     }
@@ -1699,7 +1698,7 @@ async function minifyHTML(value, options, partialMarkup) {
             }
           }
           if (prevTag || nextTag) {
-            text = collapseWhitespaceSmart(text, prevTag, nextTag, options);
+            text = collapseWhitespaceSmart(text, prevTag, nextTag, options, inlineTags);
           } else {
             text = collapseWhitespace(text, options, true, true);
           }