Merge pull request #121 from zxqfox/feature/presets

presets functionality

Author: eGavr

lib/HtmlDiff.js

@@ -5,7 +5,8 @@ var diff = require('diff'),
  * @class HtmlDiff
  * @constructor
  * @augments Diff
- * @param {Object}   [options]
+ * @param {Object|String} [options] options or preset name
+ * @param {String}   [options.preset]
  * @param {String[]} [options.ignoreAttributes]
  * @param {String[]} [options.compareAttributesAsJSON]
  * @param {Boolean}  [options.ignoreWhitespaces=true]

lib/cli.js

@@ -1,6 +1,7 @@
 var path = require('path'),
     vow = require('vow'),
     vfs = require('vow-fs'),
+    colors = require('colors'),
     HtmlDiffer = require('./index').HtmlDiffer,
     diffLogger = require('./logger'),
     defaults = require('./utils/defaults');
@@ -28,18 +29,37 @@ module.exports = require('coa').Cmd()
         .end()
     .opt()
         .name('bem')
-        .title('Uses predefined options for BEM')
+        .title('Uses predefined options for BEM (deprecated)')
         .long('bem')
         .flag()
+        .act(function (opts) {
+            console.error('Option ' +  '--bem'.bold.red + ' is deprecated, use ' +
+                '--preset=bem'.bold.green + ' option instead.');
+            // support legacy
+            opts.preset = 'bem';
+            delete opts.bem;
+        })
+        .end()
+    .opt()
+        .name('preset')
+        .title('Name of preset')
+        .short('p').long('preset')
+        .val(function (val) {
+            if (!defaults.presets.hasOwnProperty(val)) {
+                console.log(val.bold.red + ' is an invalid preset name. Available presets are: ' +
+                    Object.keys(defaults.presets).map(colors.green).map(colors.bold).join(', ') + '.');
+                process.exit(1);
+            }
+            return val;
+        })
         .end()
     .opt()
         .name('charsAroundDiff')
         .title('The number of characters around the diff (default: 40)')
         .long('chars-around-diff')
         .def(40)
         .val(function (val) {
-            /*jshint es3:false */
-            return parseInt(val);
+            return parseInt(val, 10);
         })
         .end()
     .arg()
@@ -58,10 +78,10 @@ module.exports = require('coa').Cmd()
             vfs.read(path.resolve(args.path2), 'utf-8'),
             opts.config ? vfs.read(path.resolve(opts.config)) : undefined
         ]).spread(function (html1, html2, config) {
-            if (!opts.bem) {
-                config = config ? JSON.parse(config) : {};
-            } else {
-                config = 'bem';
+            config = config ? JSON.parse(config) : {};
+
+            if (opts.preset) {
+                config.preset = opts.preset;
             }
 
             var options = defaults(config),

lib/utils/defaults.js

@@ -1,32 +1,34 @@
 var _ = require('lodash');
 
+var presets = {
+    bem: require('../../presets/bem.json')
+};
+
 /**
  * Sets options
- * @param {Object}   [options]
+ * @param {Object|String} [options] options or preset name
+ * @param {String}   [options.preset]
  * @param {String[]} [options.ignoreAttributes]
  * @param {String[]} [options.compareAttributesAsJSON]
  * @param {Boolean}  [options.ignoreWhitespaces=true]
  * @param {Boolean}  [options.ignoreComments=true]
- * @param {Boolean}  [options.ignoreClosingTags=false]
+ * @param {Boolean}  [options.ignoreEndTags=false]
  * @param {Boolean}  [options.ignoreDuplicateAttributes=false]
  * returns {Object}
  */
  module.exports = function (options) {
     if (typeof options === 'string') {
-        if (options === 'bem') {
-            options = {
-                // ignore generated attributes
-                ignoreAttributes: ['id', 'for', 'aria-labelledby', 'aria-describedby'],
-                compareAttributesAsJSON: [
-                    'data-bem',
-                    { name: 'onclick', isFunction: true },
-                    { name: 'ondblclick', isFunction: true }
-                ]
-            };
-        } else {
-            console.error(options.bold.red + ' is an invalid preset name. Use ' + 'bem'.bold.green + ' instead.');
-            process.exit(1);
+        options = { preset: options };
+    }
+
+    if (options && options.preset) {
+        var preset = String(options.preset);
+        if (!presets.hasOwnProperty(preset)) {
+            throw Error(preset + ' is an invalid preset name.');
         }
+
+        delete options.preset;
+        options = _.defaults(options, presets[preset]);
     }
 
     return _.defaults(options || {}, {
@@ -40,3 +42,5 @@ var _ = require('lodash');
         ignoreDuplicateAttributes: false
     });
 };
+
+module.exports.presets = presets;

presets/bem.json

@@ -0,0 +1,8 @@
+{
+    "ignoreAttributes": ["id", "for", "aria-labelledby", "aria-describedby"],
+    "compareAttributesAsJSON": [
+        "data-bem",
+        { "name": "onclick", "isFunction": true },
+        { "name": "ondblclick", "isFunction": true }
+    ]
+}