html-minifier 0.6.9 → 0.8.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.7.0](https://github.com/kangax/html-minifier/compare/v0.6.9...v0.7.0)
+
+* TODO
+
+## [0.6.9](https://github.com/kangax/html-minifier/compare/v0.6.8...v0.6.9)
+
+* TODO
+
+## [0.6.8](https://github.com/kangax/html-minifier/compare/v0.6.7...v0.6.8)
+
+* TODO
+
 ## [0.6.7](https://github.com/kangax/html-minifier/compare/v0.6.6...v0.6.7)
 
 * Preserve empty script with `src` attribute

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2014 Juriy "kangax" Zaytsev
+Copyright (c) 2010-2015 Juriy "kangax" Zaytsev
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -1,9 +1,9 @@
-[![NPM version](https://badge.fury.io/js/html-minifier.svg)](http://badge.fury.io/js/html-minifier)
-[![Build Status](https://travis-ci.org/kangax/html-minifier.svg)](https://travis-ci.org/kangax/html-minifier)
-[![Dependency Status](https://david-dm.org/kangax/html-minifier.svg?theme=shields.io)](https://david-dm.org/kangax/html-minifier)
-[![devDependency Status](https://david-dm.org/kangax/html-minifier/dev-status.svg?theme=shields.io)](https://david-dm.org/kangax/html-minifier#info=devDependencies)
+[![NPM version](https://img.shields.io/npm/v/html-minifier.svg)](https://www.npmjs.com/package/html-minifier)
+[![Build Status](https://img.shields.io/travis/kangax/html-minifier.svg)](https://travis-ci.org/kangax/html-minifier)
+[![Dependency Status](https://img.shields.io/david/kangax/html-minifier.svg)](https://david-dm.org/kangax/html-minifier)
+[![devDependency Status](https://img.shields.io/david/dev/kangax/html-minifier.svg)](https://david-dm.org/kangax/html-minifier#info=devDependencies)
 
-[HTMLMinifier](http://kangax.github.io/html-minifier/) is a highly __configurable__, __well-tested__, Javascript-based HTML minifier, with lint-like capabilities.
+[HTMLMinifier](http://kangax.github.io/html-minifier/) is a highly **configurable**, **well-tested**, Javascript-based HTML minifier, with lint-like capabilities.
 
 See [corresponding blog post](http://perfectionkills.com/experimenting-with-html-minifier/) for all the gory 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).
 
@@ -13,13 +13,13 @@ Also see corresponding [Ruby wrapper](https://github.com/stereobooster/html_mini
 
 How does HTMLMinifier compare to [another solution](http://www.willpeavy.com/minifier/) — HTML Minifier from Will Peavy (1st result in [google search for "html minifier"](https://www.google.com/#q=html+minifier)) as well as htmlcompressor.com?
 
-| Site  | Original size _(KB)_ | HTMLMinifier _(KB)_  | Will Peavy _(KB)_  | htmlcompressor.com _(KB)_  |
+| Site | Original size _(KB)_ | HTMLMinifier _(KB)_ | Will Peavy _(KB)_ | htmlcompressor.com _(KB)_ |
 | --------------------------------------------------------------------------- |:-----------:| ----------------:| ------------:| ----------------:|
 | [HTMLMinifier page](https://github.com/kangax/html-minifier)                | 48.8        | <b>37.3</b>      |   43.3       | 41.9 |
 | [ES6 table](http://kangax.github.io/es5-compat-table/es6/)                  | 117.9       | <b>79.9</b>      |   92         | 91.9 |
 | [MSN](http://msn.com)                                                       | 156.6       | <b>133</b>       |   145        | 138.3 |
 | [Stackoverflow](http://stackoverflow.com)                                   | 200.4       | <b>159.5</b>     |   168.3      | 163.3 |
-| [Amazon](http://amazon.com)                                                 | 245.9       | <b>206.3</b>     |   225        |  218.5 |
+| [Amazon](http://amazon.com)                                                 | 245.9       | <b>206.3</b>     |   225        | 218.5 |
 | [Wikipedia](http://en.wikipedia.org/wiki/President_of_the_United_States)    | 401.4       | <b>380.6</b>     |   396.3      | n/a |
 | [Eloquent Javascript](http://eloquentjavascript.net/print.html)             | 869.5       | <b>830</b>       |   872        | n/a |
 
@@ -34,10 +34,11 @@ How does HTMLMinifier compare to [another solution](http://www.willpeavy.com/min
 | `removeCDATASectionsFromCDATA` | [Remove CDATA sections from script and style elements](http://perfectionkills.com/experimenting-with-html-minifier/#remove_cdata_sections) | `false` |
 | `collapseWhitespace`           | [Collapse white space that contributes to text nodes in a document tree.](http://perfectionkills.com/experimenting-with-html-minifier/#collapse_whitespace) | `false` |
 | `conservativeCollapse`         | Always collapse to 1 space (never remove it entirely). Must be used in conjunction with `collapseWhitespace=true` | `false` |
-| `preserveLineBreaks`            | Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with `collapseWhitespace=true` | `false` |
+| `preserveLineBreaks`           | Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with `collapseWhitespace=true` | `false` |
 | `collapseBooleanAttributes`    | [Omit attribute values from boolean attributes](http://perfectionkills.com/experimenting-with-html-minifier/#collapse_boolean_attributes) | `false` |
 | `removeAttributeQuotes`        | [Remove quotes around attributes when possible.](http://perfectionkills.com/experimenting-with-html-minifier/#remove_attribute_quotes) | `false` |
 | `removeRedundantAttributes`    | [Remove attributes when value matches default.](http://perfectionkills.com/experimenting-with-html-minifier/#remove_redundant_attributes) | `false` |
+| `preventAttributesEscaping`    | Prevents the escaping of the values of attributes. | `false` |
 | `useShortDoctype`              | [Replaces the doctype with the short (HTML5) doctype](http://perfectionkills.com/experimenting-with-html-minifier/#use_short_doctype) | `false` |
 | `removeEmptyAttributes`        | [Remove all attributes with whitespace-only values](http://perfectionkills.com/experimenting-with-html-minifier/#remove_empty_or_blank_attributes) | `false` |
 | `removeScriptTypeAttributes`   | Remove `type="text/javascript"` from `script` tags. Other `type` attribute values are left intact. | `false` |
@@ -47,7 +48,7 @@ How does HTMLMinifier compare to [another solution](http://www.willpeavy.com/min
 | `removeEmptyElements`          | [Remove all elements with empty contents](http://perfectionkills.com/experimenting-with-html-minifier/#remove_empty_elements) | `false` |
 | `lint`                         | [Toggle linting](http://perfectionkills.com/experimenting-with-html-minifier/#validate_input_through_html_lint) | `false` |
 | `keepClosingSlash`             | Keep the trailing slash on singleton elements                            | `false` |
-| `caseSensitive`                | Treat attributes in case sensitive manner (useful for SVG; e.g. viewBox) | `false` |
+| `caseSensitive`                | Treat attributes in case sensitive manner (useful for custom HTML tags.) | `false` |
 | `minifyJS`                     | Minify Javascript in script elements and on* attributes (uses [UglifyJS](https://github.com/mishoo/UglifyJS2)) | `false` (could be `true`, `false`, `Object` (options)) |
 | `minifyCSS`                    | Minify CSS in style elements and style attributes (uses [clean-css](https://github.com/GoalSmashers/clean-css)) | `false` (could be `true`, `false`, `Object` (options)) |
 | `minifyURLs`                   | Minify URLs in various attributes (uses [relateurl](https://github.com/stevenvachon/relateurl)) | `false` (could be `Object` (options)) |
@@ -57,9 +58,37 @@ How does HTMLMinifier compare to [another solution](http://www.willpeavy.com/min
 | `customAttrAssign`             | Arrays of regex'es that allow to support custom attribute assign expressions (e.g. `'<div flex?="{{mode != cover}}"></div>'`) | `[ ]` |
 | `customAttrSurround`           | Arrays of regex'es that allow to support custom attribute surround expressions (e.g. `<input {{#if value}}checked="checked"{{/if}}>`) | `[ ]` |
 | `customAttrCollapse`           | Regex that specifies custom attribute to strip newlines from (e.g. `/ng\-class/`) | |
+| `quoteCharacter`               | Type of quote to use for attribute values (' or ") | " |
 
+## Special cases
 
-Chunks of markup can be ignored by wrapping them with `<!-- htmlmin:ignore -->`.
+### Ignoring chunks of markup.
+
+If you have chunks of markup you would like preserved, you can wrap them `<!-- htmlmin:ignore -->`.
+
+### Preserving SVG tags
+
+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.
+
+### Working with invalid markup
+
+HTMLMinifier **can't work with invalid or partial chunks of markup**. This is because it parses markup into a tree struture, then modifies it (removing anything that was specified for removal, ignoring anything that was specified to be ingored, etc.), then it creates a markup out of that tree and returns it. 
+
+Input markup (e.g. `<p id="">foo`)
+
+↓
+
+Internal representation of markup in a form of tree (e.g. `{tag: "p", attr: "id", children: ["foo"] }`)
+
+↓
+
+Transformation of internal representation (e.g. removal of "id" attribute)
+
+↓
+
+Output of resulting markup (e.g. `<p>foo</p>`)
+
+HTMLMinifier can't know that original markup was only half of the tree; it does its best to try to parse it as a full tree and it loses information about tree being malformed or partial in the beginning. As a result, it can't create a partial/malformed tree at the time of the output.
 
 ## Installation Instructions
 
@@ -84,7 +113,7 @@ npm link .
 
 For command line usage please see `html-minifier --help`
 
-## Node.js
+### Node.js
 
 ```js
 var minify = require('html-minifier').minify;
@@ -94,8 +123,8 @@ var result = minify('<p title="blah" id="moo">foo</p>', {
 result; // '<p title=blah id=moo>foo</p>'
 ```
 
-Running benchmarks
-------------------
+## Running benchmarks
+
 Benchmarks for minified HTML:
 ```
 node benchmark.js

package/cli.js

@@ -4,7 +4,7 @@
  *
  * The MIT License (MIT)
  *
- *  Copyright (c) 2014 Zoltan Frombach
+ *  Copyright (c) 2014-2015 Zoltan Frombach
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy of
  *  this software and associated documentation files (the "Software"), to deal in
@@ -25,15 +25,19 @@
  *
  */
 
+/* globals JSON:true */
+
 'use strict';
 
 var cli = require('cli');
+var concat = require('concat-stream');
 var changeCase = require('change-case');
 var path = require('path');
 var fs = require('fs');
 var appName = require('./package.json').name;
 var appVersion = require('./package.json').version;
 var minify = require('./dist/htmlminifier.min.js').minify;
+var HTMLLint = require('./dist/htmlminifier.min.js').HTMLLint;
 var minifyOptions = {};
 var input = null;
 var output = null;
@@ -62,9 +66,13 @@ var mainOptions = {
   collapseBooleanAttributes: [[false, 'Omit attribute values from boolean attributes']],
   removeAttributeQuotes: [[false, 'Remove quotes around attributes when possible.']],
   removeRedundantAttributes: [[false, 'Remove attributes when value matches default.']],
+  preventAttributesEscaping: [[false, 'Prevents the escaping of the values of attributes.']],
   useShortDoctype: [[false, 'Replaces the doctype with the short (HTML5) doctype']],
   removeEmptyAttributes: [[false, 'Remove all attributes with whitespace-only values']],
+  removeScriptTypeAttributes: [[false, 'Remove type="text/javascript" from script tags. Other type attribute values are left intact.']],
+  removeStyleLinkTypeAttributes: [[false, 'Remove type="text/css" from style and link tags. Other type attribute values are left intact.']],
   removeOptionalTags: [[false, 'Remove unrequired tags']],
+  removeIgnored: [[false, 'Remove all tags starting and ending with <%, %>, <?, ?>']],
   removeEmptyElements: [[false, 'Remove all elements with empty contents']],
   lint: [[false, 'Toggle linting']],
   keepClosingSlash: [[false, 'Keep the trailing slash on singleton elements']],
@@ -72,9 +80,12 @@ var mainOptions = {
   minifyJS: [[false, 'Minify Javascript in script elements and on* attributes (uses UglifyJS)']],
   minifyCSS: [[false, 'Minify CSS in style elements and style attributes (uses clean-css)']],
   minifyURLs: [[false, 'Minify URLs in various attributes (uses relateurl)']],
-  ignoreCustomComments: [[false, 'Array of regex\'es that allow to ignore certain comments, when matched', 'string'], 'json'],
-  processScripts: [[false, 'Array of strings corresponding to types of script elements to process through minifier (e.g. "text/ng-template", "text/x-handlebars-template", etc.)', 'string'], 'json'],
-  maxLineLength: [[false, 'Max line length', 'number'], true]
+  ignoreCustomComments: [[false, 'Array of regex\'es that allow to ignore certain comments, when matched', 'string'], 'json-regex'],
+  processScripts: [[false, 'Array of strings corresponding to types of script elements to process through minifier (e.g. "text/ng-template", "text/x-handlebars-template", etc.)', 'string'], 'json-regex'],
+  maxLineLength: [[false, 'Max line length', 'number'], true],
+  customAttrAssign: [[false, 'Arrays of regex\'es that allow to support custom attribute assign expressions (e.g. \'<div flex?="{{mode != cover}}"></div>\')', 'string'], 'json-regex'],
+  customAttrSurround: [[false, 'Arrays of regex\'es that allow to support custom attribute surround expressions (e.g. <input {{#if value}}checked="checked"{{/if}}>)', 'string'], 'json-regex'],
+  customAttrCollapse: [[false, 'Regex that specifies custom attribute to strip newlines from (e.g. /ng\-class/)', 'string'], 'string-regex']
 };
 
 var cliOptions = {
@@ -92,8 +103,94 @@ cli.parse(cliOptions);
 
 cli.main(function(args, options) {
 
+  function stringToRegExp(value) {
+    // JSON does not support regexes, so, e.g., JSON.parse() will not create
+    // a RegExp from the JSON value `[ "/matchString/" ]`, which is
+    // technically just an array containing a string that begins and end with
+    // a forward slash. To get a RegExp from a JSON string, it must be
+    // constructed explicitly in JavaScript.
+    //
+    // The likelihood of actually wanting to match text that is enclosed in
+    // forward slashes is probably quite rare, so if forward slashes were
+    // included in an argument that requires a regex, the user most likely
+    // thought they were part of the syntax for specifying a regex.
+    //
+    // In the unlikely case that forward slashes are indeed desired in the
+    // search string, the user would need to enclose the expression in a
+    // second set of slashes:
+    //
+    //    --customAttrSrround "[\"//matchString//\"]"
+    //
+    if (value) {
+      var stripSlashes = /^\/(.*)\/$/.exec(value);
+      if (stripSlashes) {
+        value = stripSlashes[1];
+      }
+      return new RegExp(value);
+    }
+  }
+
+  function parseJSONOption(value, options) {
+    var opts = options || {};
+    if (value !== null) {
+      var jsonArray;
+      try {
+        jsonArray = JSON.parse(value);
+        if (opts.regexArray) {
+          jsonArray = jsonArray.map(function (regexString) {
+            return stringToRegExp(regexString);
+          });
+        }
+      }
+      catch (e) {
+        cli.fatal('Could not parse JSON value \'' + value + '\'');
+      }
+      if (jsonArray instanceof Array) {
+        return jsonArray;
+      }
+      else {
+        return [value];
+      }
+    }
+  }
+
+  function runMinify(original) {
+    var status = 0;
+    var minified = null;
+    try {
+      minified = minify(original, minifyOptions);
+    }
+    catch (e) {
+      status = 3;
+      cli.error('Minification error');
+      process.stderr.write(e);
+    }
+
+    if (minifyOptions.lint) {
+      minifyOptions.lint.populate();
+    }
+
+    if (minified !== null) {
+      // Write the output
+      try {
+        if (output !== null) {
+          fs.writeFileSync(path.resolve(output), minified);
+        }
+        else {
+          process.stdout.write(minified);
+        }
+      }
+      catch (e) {
+        status = 4;
+        cli.error('Cannot write to output');
+      }
+    }
+
+    cli.exit(status);
+  }
+
   if (options.version) {
-    process.stderr.write(appName + ' v' + appVersion);
+    cli.output(appName + ' v' + appVersion);
     cli.exit(0);
   }
 
@@ -105,8 +202,7 @@ cli.main(function(args, options) {
       }
     }
     catch (e) {
-      process.stderr.write('Error: Cannot read the specified config file');
-      cli.exit(1);
+      cli.fatal('Cannot read the specified config file');
     }
   }
 
@@ -118,6 +214,12 @@ cli.main(function(args, options) {
         case 'json':
           minifyOptions[key] = parseJSONOption(value);
           break;
+        case 'json-regex':
+          minifyOptions[key] = parseJSONOption(value, { regexArray: true });
+          break;
+        case 'string-regex':
+          minifyOptions[key] = stringToRegExp(value);
+          break;
         case true:
           minifyOptions[key] = value;
           break;
@@ -127,6 +229,10 @@ cli.main(function(args, options) {
     }
   });
 
+  if (minifyOptions.lint === true) {
+    minifyOptions.lint = new HTMLLint();
+  }
+
   if (args.length) {
     input = args;
   }
@@ -135,104 +241,25 @@ cli.main(function(args, options) {
     output = options.output;
   }
 
-  var original = '';
-  var status = 0;
-
   if (input !== null) { // Minifying one or more files specified on the CMD line
 
+    var original = '';
+
     input.forEach(function(afile) {
       try {
         original += fs.readFileSync(afile, 'utf8');
       }
       catch (e) {
-        status = 2;
-        process.stderr.write('Error: Cannot read file ' + afile);
+        cli.error('Cannot read file ' + afile);
+        cli.exit(2);
       }
     });
 
-  }
-  else { // Minifying input coming from STDIN
-
-    var BUFSIZE = 4096;
-    var buf = new Buffer(BUFSIZE);
-    var bytesRead;
-
-    while (true) { // Loop as long as stdin input is available.
-      bytesRead = 0;
-      try {
-        bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE);
-      }
-      catch (e) {
-        if (e.code === 'EAGAIN') { // 'resource temporarily unavailable'
-          // Happens on OS X 10.8.3 (not Windows 7!), if there's no
-          // stdin input - typically when invoking a script without any
-          // input (for interactive stdin input).
-          // If you were to just continue, you'd create a tight loop.
-          process.stderr.write('ERROR: interactive stdin input not supported');
-          cli.exit(2);
-        }
-        else if (e.code === 'EOF') {
-          // Happens on Windows 7, but not OS X 10.8.3:
-          // simply signals the end of *piped* stdin input.
-          break;
-        }
-        throw e; // unexpected exception
-      }
-      if (bytesRead === 0) {
-        // No more stdin input available.
-        // OS X 10.8.3: regardless of input method, this is how the end
-        //   of input is signaled.
-        // Windows 7: this is how the end of input is signaled for
-        //   *interactive* stdin input.
-        break;
-      }
-      original += buf.toString('utf8', 0, bytesRead);
-    }
-
-  }
-
-  function parseJSONOption(value) {
-    if (value !== null) {
-      var jsonArray;
-      try {
-        jsonArray = JSON.parse(value);
-      }
-      catch (e) {}
-      if (jsonArray instanceof Array) {
-        return jsonArray;
-      }
-      else {
-        return [value];
-      }
-    }
-  }
+    runMinify(original);
 
-  // Run minify
-  var minified = null;
-  try {
-    minified = minify(original, minifyOptions);
-  }
-  catch (e) {
-    status = 3;
-    process.stderr.write('Error: Minification error');
   }
-
-  if (minified !== null) {
-    // Write the output
-    try {
-      if (output !== null) {
-        fs.writeFileSync(path.resolve(output), minified);
-      }
-      else {
-        process.stdout.write(minified);
-      }
-    }
-    catch (e) {
-      status = 4;
-      process.stderr.write('Error: Cannot write to output');
-    }
+  else { // Minifying input coming from STDIN
+    process.stdin.pipe(concat({ encoding: 'string' }, runMinify));
   }
 
-  cli.exit(status);
-
 });