html-minifier 1.2.0 → 1.5.0

package/cli.js

@@ -4,7 +4,7 @@
  *
  * The MIT License (MIT)
  *
- *  Copyright (c) 2014-2015 Zoltan Frombach
+ *  Copyright (c) 2014-2016 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,333 +25,263 @@
  *
  */
 
-/* globals JSON:true */
-
 'use strict';
 
-var cli = require('cli');
-var concat = require('concat-stream');
 var changeCase = require('change-case');
-var path = require('path');
+var concat = require('concat-stream');
 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;
-
-cli.width = 100;
-cli.option_width = 40;
-cli.setApp(appName, appVersion);
-
-var usage = appName + ' [OPTIONS] [FILE(s)]\n\n';
-usage += '  If no input file(s) specified then STDIN will be used for input.\n';
-usage += '  If more than one input file specified those will be concatenated and minified together.\n\n';
-usage += '  When you specify a config file with the --config-file option (see sample-cli-config-file.conf for format)\n';
-usage += '    you can still override some of its contents by providing individual command line options, too.\n\n';
-usage += '  When you want to provide an array of strings for --ignore-custom-comments or --process-scripts options\n';
-usage += '    on the command line you must escape those such as --ignore-custom-comments "[\\"string1\\",\\"string1\\"]"\n';
-
-cli.setUsage(usage);
-
-var mainOptions = {
-  removeComments: [[false, 'Strip HTML comments']],
-  removeCommentsFromCDATA: [[false, 'Strip HTML comments from scripts and styles']],
-  removeCDATASectionsFromCDATA: [[false, 'Remove CDATA sections from script and style elements']],
-  collapseWhitespace: [[false, 'Collapse white space that contributes to text nodes in a document tree.']],
-  conservativeCollapse: [[false, 'Always collapse to 1 space (never remove it entirely)']],
-  preserveLineBreaks: [[false, 'Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break.']],
-  collapseInlineTagWhitespace: [[false, 'Collapse white space around inline tag']],
-  collapseBooleanAttributes: [[false, 'Omit attribute values from boolean attributes']],
-  removeTagWhitespace: [[false, 'Remove space between attributes whenever possible.']],
-  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']],
-  removeEmptyElements: [[false, 'Remove all elements with empty contents']],
-  lint: [[false, 'Toggle linting']],
-  keepClosingSlash: [[false, 'Keep the trailing slash on singleton elements']],
-  caseSensitive: [[false, 'Treat attributes in case sensitive manner (useful for SVG; e.g. viewBox)']],
-  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)', 'string'], 'site-url'],
-  ignoreCustomComments: [[false, 'Array of regex\'es that allow to ignore certain comments, when matched', 'string'], 'json-regex'],
-  ignoreCustomFragments: [[false, 'Array of regex\'es that allow to ignore certain fragments, when matched (e.g. <?php ... ?>, {{ ... }})', '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'],
-  maxLineLength: [[false, 'Max line length', 'number'], true],
-  customEventAttributes: [[false, 'Arrays of regex\'es that allow to support custom event attributes for minifyJS (e.g. ng-click)', 'string'], 'json-regex'],
-  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 = {
-  version: ['v', 'Version information'],
-  output: ['o', 'Specify output file (if not specified STDOUT will be used for output)', 'file'],
-  'config-file': ['c', 'Use config file', 'file'],
-  'input-dir': [false, 'Specify an input directory', 'dir'],
-  'output-dir': [false, 'Specify an output directory', 'dir']
-};
-
-var mainOptionKeys = Object.keys(mainOptions);
-mainOptionKeys.forEach(function(key) {
-  cliOptions[changeCase.paramCase(key)] = mainOptions[key][0];
-});
-
-cli.parse(cliOptions);
+var HTMLLint = require('./src/htmllint').HTMLLint;
+var info = require('./package.json');
+var minify = require('.').minify;
+var path = require('path');
+var program = require('commander');
 
-cli.main(function(args, options) {
+program.version(info.version).description(info.name + ' command-line tool');
 
-  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 fatal(message) {
+  console.error(message);
+  process.exit(1);
+}
 
-  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];
-      }
-    }
+/**
+ * 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//\"]"
+ */
+function parseRegExp(value) {
+  if (value) {
+    return new RegExp(value.replace(/^\/(.*)\/$/, '$1'));
   }
+}
 
-  function runMinify(original, output) {
-    var status = 0;
-    var minified = null;
+function parseJSON(value) {
+  if (value) {
     try {
-      minified = minify(original, minifyOptions);
+      return JSON.parse(value);
     }
     catch (e) {
-      status = 3;
-      cli.error('Minification error');
-      process.stderr.write((e.stack || e).toString());
-    }
-
-    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;
-        console.log(output);
-        cli.error('Cannot write to output');
-      }
+      fatal('Could not parse JSON value \'' + value + '\'');
     }
-
-    return status;
   }
+}
 
-  function createDirectory(path) {
-    try {
-      fs.mkdirSync(path);
-    }
-    catch (e) {
-      if (e.code === 'EEXIST') {
-        return;
-      }
-      cli.fatal('Can not create directory ' + path);
-      cli.exit(3);
-    }
+function parseJSONArray(value) {
+  if (value) {
+    value = parseJSON(value);
+    return Array.isArray(value) ? value : [value];
   }
+}
 
-  function processDirectory(inputDir, outputDir) {
-    createDirectory(outputDir);
-    var fileList = fs.readdirSync(inputDir);
-    var status = 0;
-
-    fileList.forEach(function(fileName) {
-      var inputFilePath = inputDir + '/' + fileName;
-      var outputFilePath = outputDir + '/' + fileName;
+function parseJSONRegExpArray(value) {
+  value = parseJSONArray(value);
+  return value && value.map(parseRegExp);
+}
 
-      var stat = fs.statSync(inputFilePath);
-      if (stat.isDirectory()) {
-        processDirectory(inputFilePath, outputFilePath);
-        return;
-      }
+function parseSiteURL(value) {
+  return value && { site: value };
+}
 
-      var originalContent = fs.readFileSync(inputFilePath, 'utf8');
-      status = runMinify(originalContent, outputFilePath);
-    });
+function parseString(value) {
+  return value;
+}
 
-    cli.exit(status);
+var mainOptions = {
+  caseSensitive: 'Treat attributes in case sensitive manner (useful for SVG; e.g. viewBox)',
+  collapseBooleanAttributes: 'Omit attribute values from boolean attributes',
+  collapseInlineTagWhitespace: 'Collapse white space around inline tag',
+  collapseWhitespace: 'Collapse white space that contributes to text nodes in a document tree.',
+  conservativeCollapse: 'Always collapse to 1 space (never remove it entirely)',
+  customAttrAssign: ['Arrays of regex\'es that allow to support custom attribute assign expressions (e.g. \'<div flex?="{{mode != cover}}"></div>\')', parseJSONRegExpArray],
+  customAttrCollapse: ['Regex that specifies custom attribute to strip newlines from (e.g. /ng-class/)', parseRegExp],
+  customAttrSurround: ['Arrays of regex\'es that allow to support custom attribute surround expressions (e.g. <input {{#if value}}checked="checked"{{/if}}>)', parseJSONRegExpArray],
+  customEventAttributes: ['Arrays of regex\'es that allow to support custom event attributes for minifyJS (e.g. ng-click)', parseJSONRegExpArray],
+  decodeEntities: 'Use direct Unicode characters whenever possible',
+  html5: 'Parse input according to HTML5 specifications',
+  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',
+  keepClosingSlash: 'Keep the trailing slash on singleton elements',
+  lint: 'Toggle linting',
+  maxLineLength: ['Max line length', parseInt],
+  minifyCSS: ['Minify CSS in style elements and style attributes (uses clean-css)', parseJSON],
+  minifyJS: ['Minify Javascript in script elements and on* attributes (uses uglify-js)', parseJSON],
+  minifyURLs: ['Minify URLs in various attributes (uses relateurl)', parseSiteURL],
+  preserveLineBreaks: 'Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break.',
+  preventAttributesEscaping: 'Prevents the escaping of the values of attributes.',
+  processConditionalComments: 'Process contents of conditional comments through minifier',
+  processScripts: ['Array of strings corresponding to types of script elements to process through minifier (e.g. "text/ng-template", "text/x-handlebars-template", etc.)', parseJSONArray],
+  quoteCharacter: ['Type of quote to use for attribute values (\' or ")', parseString],
+  removeAttributeQuotes: 'Remove quotes around attributes when possible.',
+  removeComments: 'Strip HTML comments',
+  removeEmptyAttributes: 'Remove all attributes with whitespace-only values',
+  removeEmptyElements: 'Remove all elements with empty contents',
+  removeOptionalTags: 'Remove unrequired tags',
+  removeRedundantAttributes: 'Remove attributes when value matches default.',
+  removeScriptTypeAttributes: 'Remove type="text/javascript" from script tags. Other type attribute values are left intact.',
+  removeStyleLinkTypeAttributes: 'Remove type="text/css" from style and link tags. Other type attribute values are left intact.',
+  removeTagWhitespace: 'Remove space between attributes whenever possible',
+  sortAttributes: 'Sort attributes by frequency',
+  sortClassName: 'Sort style classes by frequency',
+  useShortDoctype: 'Replaces the doctype with the short (HTML5) doctype'
+};
+var mainOptionKeys = Object.keys(mainOptions);
+mainOptionKeys.forEach(function(key) {
+  var option = mainOptions[key];
+  key = '--' + changeCase.paramCase(key);
+  if (Array.isArray(option)) {
+    var optional = option[1] === parseJSON;
+    program.option(key + (optional ? ' [value]' : ' <value>'), option[0], option[1]);
+  }
+  else {
+    program.option(key, option);
   }
+});
+program.option('-o --output <file>', 'Specify output file (if not specified STDOUT will be used for output)', function(outputPath) {
+  return fs.createWriteStream(outputPath).on('error', function(e) {
+    fatal('Cannot write ' + outputPath + '\n' + e.message);
+  });
+}, process.stdout);
 
-  if (options.version) {
-    cli.output(appName + ' v' + appVersion);
-    cli.exit(0);
+function readFile(file) {
+  try {
+    return fs.readFileSync(file, { encoding: 'utf8' });
+  }
+  catch (e) {
+    fatal('Cannot read ' + file + '\n' + e.message);
   }
+}
 
-  if (options['config-file']) {
-    var fileOptions;
-    var fileOptionsPath = path.resolve(options['config-file']);
-    try {
-      fileOptions = fs.readFileSync(fileOptionsPath, { encoding: 'utf8' });
-    }
-    catch (e) {
-      cli.fatal('The specified config file doesn’t exist or is unreadable:\n' + fileOptionsPath);
-    }
+var config = {};
+program.option('-c --config-file <file>', 'Use config file', function(configPath) {
+  var data = readFile(configPath);
+  try {
+    config = JSON.parse(data);
+  }
+  catch (je) {
     try {
-      fileOptions = JSON.parse(fileOptions);
-    }
-    catch (je) {
-      try {
-        fileOptions = require(fileOptionsPath);
-      }
-      catch (ne) {
-        cli.fatal('Cannot read the specified config file. \nAs JSON: ' + je.message + '\nAs module: ' + ne.message);
-      }
+      config = require(path.resolve(configPath));
     }
-
-    if (fileOptions && typeof fileOptions === 'object') {
-      minifyOptions = fileOptions;
+    catch (ne) {
+      fatal('Cannot read the specified config file.\nAs JSON: ' + je.message + '\nAs module: ' + ne.message);
     }
   }
   mainOptionKeys.forEach(function(key) {
-    var paramKey = changeCase.paramCase(key);
-    var value = options[paramKey];
-    if (options[paramKey] !== null) {
-      switch (mainOptions[key][1]) {
-        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 'site-url':
-          minifyOptions[key] = { site: value };
-          break;
-        case true:
-          minifyOptions[key] = value;
-          break;
-        default:
-          minifyOptions[key] = true;
+    if (key in config) {
+      var option = mainOptions[key];
+      if (Array.isArray(option)) {
+        var value = config[key];
+        config[key] = option[1](typeof value === 'string' ? value : JSON.stringify(value));
       }
     }
   });
-
-  if (minifyOptions.lint === true) {
-    minifyOptions.lint = new HTMLLint();
-  }
-
-  if (args.length) {
-    input = args;
-  }
-
-  if (options['input-dir'] || options['output-dir']) {
-    var inputDir = options['input-dir'];
-    var outputDir = options['output-dir'];
-
-    if (!inputDir) {
-      cli.error('The option output-dir need to be use with the option include-dir. If you are working with only 1 file, use -o.');
-      cli.exit(2);
-    }
-
-    try {
-      fs.statSync(inputDir);
-    }
-    catch (e) {
-      cli.error('The input directory does not exits');
-      cli.exit(2);
+});
+program.option('--input-dir <dir>', 'Specify an input directory');
+program.option('--output-dir <dir>', 'Specify an output directory');
+var content;
+program.arguments('[files...]').action(function(files) {
+  content = files.map(readFile).join('');
+}).parse(process.argv);
+
+function createOptions() {
+  var options = {};
+  mainOptionKeys.forEach(function(key) {
+    var param = program[changeCase.camelCase(key)];
+    if (typeof param !== 'undefined') {
+      options[key] = param;
     }
-
-
-    if (!outputDir) {
-      cli.error('You need to specify where to write the output files with the option --output-dir');
-      cli.exit(2);
+    else if (key in config) {
+      options[key] = config[key];
     }
+  });
+  if (options.lint) {
+    options.lint = new HTMLLint();
+  }
+  return options;
+}
 
-    try {
-      processDirectory(inputDir, outputDir);
+function processDirectory(inputDir, outputDir) {
+  fs.readdir(inputDir, function(err, files) {
+    if (err) {
+      fatal('Cannot read directory ' + inputDir + '\n' + err.message);
     }
-    catch (e) {
-      cli.error('Something wrong happened');
-      cli.error(e);
-      cli.exit(3);
+    fs.mkdir(outputDir, function(err) {
+      if (err && err.code !== 'EEXIST') {
+        fatal('Cannot create directory ' + outputDir + '\n' + err.message);
+      }
+      files.forEach(function(file) {
+        var inputFile = path.join(inputDir, file);
+        var outputFile = path.join(outputDir, file);
+        fs.readFile(inputFile, { encoding: 'utf8' }, function(err, data) {
+          if (!err) {
+            var minified;
+            try {
+              minified = minify(data, createOptions());
+            }
+            catch (e) {
+              fatal('Minification error on ' + inputFile + '\n' + e.message);
+            }
+            fs.writeFile(outputFile, minified, { encoding: 'utf8' }, function(err) {
+              if (err) {
+                fatal('Cannot write ' + outputFile + '\n' + err.message);
+              }
+            });
+          }
+          else if (err.code === 'EISDIR') {
+            processDirectory(inputFile, outputFile);
+          }
+          else {
+            fatal('Cannot read ' + inputFile + '\n' + err.message);
+          }
+        });
+      });
+    });
+  });
+}
+
+function writeMinify(content) {
+  var minified;
+  try {
+    var options = createOptions();
+    minified = minify(content, options);
+    if (options.lint) {
+      options.lint.populate();
     }
-
-    cli.exit(0);
-    return;
   }
-
-  if (options.output) {
-    output = options.output;
+  catch (e) {
+    fatal('Minification error:\n' + e.message);
   }
-
-  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) {
-        cli.error('Cannot read file ' + afile);
-        cli.exit(2);
-      }
-    });
-
-    cli.exit(runMinify(original, output));
-
+  program.output.write(minified);
+}
+
+var inputDir = program.inputDir;
+var outputDir = program.outputDir;
+if (inputDir || outputDir) {
+  if (!inputDir) {
+    fatal('The option output-dir needs to be used with the option input-dir. If you are working with a single file, use -o.');
   }
-  else { // Minifying input coming from STDIN
-    process.stdin.pipe(concat({ encoding: 'string' }, runMinify));
+  else if (!outputDir) {
+    fatal('You need to specify where to write the output files with the option --output-dir');
   }
-});
+  processDirectory(inputDir, outputDir);
+}
+// Minifying one or more files specified on the CMD line
+else if (typeof content === 'string') {
+  writeMinify(content);
+}
+// Minifying input coming from STDIN
+else {
+  process.stdin.pipe(concat({ encoding: 'string' }, writeMinify));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "html-minifier",
   "description": "HTML minifier with lint-like capabilities.",
-  "version": "1.2.0",
+  "version": "1.5.0",
   "keywords": [
     "html",
     "minifier",
@@ -33,40 +33,38 @@
     "node": ">=0.10.0"
   },
   "scripts": {
+    "dist": "grunt dist",
     "test": "grunt test"
   },
   "dependencies": {
     "change-case": "2.3.x",
     "clean-css": "3.4.x",
-    "cli": "0.11.x",
+    "commander": "2.9.x",
     "concat-stream": "1.5.x",
+    "he": "1.0.x",
+    "ncname": "1.0.x",
     "relateurl": "0.2.x",
     "uglify-js": "2.6.x"
   },
   "devDependencies": {
-    "brotli": "1.1.x",
+    "brotli": "1.2.x",
     "chalk": "1.1.x",
     "cli-table": "0.3.x",
-    "grunt": "0.4.x",
-    "grunt-contrib-concat": "0.5.x",
-    "grunt-contrib-jshint": "1.0.x",
-    "grunt-contrib-qunit": "1.0.x",
-    "grunt-contrib-uglify": "0.11.x",
-    "grunt-exec": "0.4.x",
-    "grunt-jscs": "2.7.x",
-    "load-grunt-tasks": "3.4.x",
-    "lzma": "2.2.x",
+    "grunt": "1.0.x",
+    "grunt-browserify": "5.0.x",
+    "grunt-contrib-uglify": "1.0.x",
+    "grunt-eslint": "18.0.x",
+    "grunt-lib-phantomjs": "1.0.x",
+    "lzma": "2.3.x",
     "minimize": "1.8.x",
     "progress": "1.1.x",
     "qunit": "0.9.x",
     "time-grunt": "1.3.x"
   },
   "files": [
-    "dist",
     "src",
     "cli.js",
     "sample-cli-config-file.conf",
-    "CHANGELOG.md",
     "LICENSE"
   ]
 }