coa 1.0.3 → 1.0.4

package/lib/opt.js

@@ -1,155 +1,338 @@
-'use strict';
+// Generated by CoffeeScript 1.6.3
+var Cmd, Color, Opt, Q, fs;
 
-const
-    Q = require('q'),
+fs = require('fs');
 
-    CoaParam = require('./coaparam'),
-    Color = require('./color');
+Q = require('q');
+
+Color = require('./color').Color;
+
+Cmd = require('./cmd').Cmd;
 
 /**
- * Option
- *
- * Named entity. Options may have short and long keys for use from command line.
- *
- * @namespace
- * @class Opt
- * @extends CoaParam
- */
-module.exports = class Opt extends CoaParam {
-    /**
-     * @constructs
-     * @param {COA.Cmd} cmd - parent command
-     */
-    constructor(cmd) {
-        super(cmd);
-
-        this._short = null;
-        this._long = null;
-        this._flag = false;
-        this._only = false;
-        this._cmd._opts.push(this);
-    }
+Option
 
-    /**
-     * Set a short key for option to be used with one hyphen from command line.
-     *
-     * @param {String} short - short name
-     * @returns {COA.Opt} - this instance (for chainability)
-     */
-    short(short) {
-        this._short = short;
-        this._cmd._optsByKey[`-${short}`] = this;
-        return this;
-    }
+Named entity. Options may have short and long keys for use from command line.
+@namespace
+@class Presents option
+*/
 
-    /**
-     * Set a short key for option to be used with double hyphens from command line.
-     *
-     * @param {String} long - long name
-     * @returns {COA.Opt} - this instance (for chainability)
-     */
-    long(long) {
-        this._long = long;
-        this._cmd._optsByKey[`--${long}`] = this;
-        return this;
-    }
 
-    /**
-     * Make an option boolean, i.e. option without value.
-     *
-     * @returns {COA.Opt} - this instance (for chainability)
-     */
-    flag() {
-        this._flag = true;
-        return this;
-    }
+exports.Opt = Opt = (function() {
+  /**
+  @constructs
+  @param {COA.Cmd} cmd parent command
+  */
 
-    /**
-     * Makes an option to act as a command,
-     * i.e. program will exit just after option action.
-     *
-     * @returns {COA.Opt} - this instance (for chainability)
-     */
-    only() {
-        this._only = true;
-        return this;
-    }
+  function Opt(_cmd) {
+    this._cmd = _cmd;
+    this._cmd._opts.push(this);
+  }
 
-    /**
-     * Add action for current option command.
-     * This action is performed if the current option
-     * is present in parsed options (with any value).
-     *
-     * @param {Function} act - action function,
-     *         invoked in the context of command instance
-     *         and has the parameters:
-     *                 - {Object} opts - parsed options
-     *                 - {Array} args - parsed arguments
-     *                 - {Object} res - actions result accumulator
-     *         It can return rejected promise by Cmd.reject (in case of error)
-     *         or any other value treated as result.
-     * @returns {COA.Opt} - this instance (for chainability)
-     */
-    act(act) {
-        // Need function here for arguments
-        const opt = this;
-        this._cmd.act(function(opts) {
-            if(!opts.hasOwnProperty(opt._name)) return;
-
-            const res = act.apply(this, arguments);
-            if(!opt._only) return res;
-
-            return Q.when(res, out => this.reject({
-                toString : () => out.toString(),
-                exitCode : 0
-            }));
-        });
-
-        return this;
-    }
+  /**
+  Set a canonical option identifier to be used anywhere in the API.
+  @param {String} _name option name
+  @returns {COA.Opt} this instance (for chainability)
+  */
 
-    _saveVal(opts, val) {
-        this._val && (val = this._val(val));
 
-        const name = this._name;
-        this._arr
-            ? (opts[name] || (opts[name] = [])).push(val)
-            : (opts[name] = val);
+  Opt.prototype.name = function(_name) {
+    this._name = _name;
+    return this;
+  };
 
-        return val;
-    }
+  /**
+  Set a long description for option to be used anywhere in text messages.
+  @param {String} _title option title
+  @returns {COA.Opt} this instance (for chainability)
+  */
 
-    _parse(argv, opts) {
-        return this._saveVal(opts, this._flag ? true : argv.shift());
-    }
 
-    _checkParsed(opts) {
-        return !opts.hasOwnProperty(this._name);
-    }
+  Opt.prototype.title = Cmd.prototype.title;
+
+  /**
+  Set a short key for option to be used with one hyphen from command line.
+  @param {String} _short
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.short = function(_short) {
+    this._short = _short;
+    return this._cmd._optsByKey['-' + _short] = this;
+  };
+
+  /**
+  Set a short key for option to be used with double hyphens from command line.
+  @param {String} _long
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.long = function(_long) {
+    this._long = _long;
+    return this._cmd._optsByKey['--' + _long] = this;
+  };
+
+  /**
+  Make an option boolean, i.e. option without value.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.flag = function() {
+    this._flag = true;
+    return this;
+  };
+
+  /**
+  Makes an option accepts multiple values.
+  Otherwise, the value will be used by the latter passed.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.arr = function() {
+    this._arr = true;
+    return this;
+  };
+
+  /**
+  Makes an option required.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.req = function() {
+    this._req = true;
+    return this;
+  };
+
+  /**
+  Makes an option to act as a command,
+  i.e. program will exit just after option action.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.only = function() {
+    this._only = true;
+    return this;
+  };
+
+  /**
+  Set a validation (or value) function for option.
+  Value from command line passes through before becoming available from API.
+  Using for validation and convertion simple types to any values.
+  @param {Function} _val validating function,
+      invoked in the context of option instance
+      and has one parameter with value from command line
+  @returns {COA.Opt} this instance (for chainability)
+  */
 
-    _usage() {
-        const res = [],
-            nameStr = this._name.toUpperCase();
 
-        if(this._short) {
-            res.push('-', Color('lgreen', this._short));
-            this._flag || res.push(' ' + nameStr);
-            res.push(', ');
+  Opt.prototype.val = function(_val) {
+    this._val = _val;
+    return this;
+  };
+
+  /**
+  Set a default value for option.
+  Default value passed through validation function as ordinary value.
+  @param {Object} _def
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.def = function(_def) {
+    this._def = _def;
+    return this;
+  };
+
+  /**
+  Make option value inputting stream.
+  It's add useful validation and shortcut for STDIN.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.input = function() {
+    process.stdin.pause();
+    return this.def(process.stdin).val(function(v) {
+      var s;
+      if (typeof v === 'string') {
+        if (v === '-') {
+          return process.stdin;
+        } else {
+          s = fs.createReadStream(v, {
+            encoding: 'utf8'
+          });
+          s.pause();
+          return s;
         }
+      } else {
+        return v;
+      }
+    });
+  };
+
+  /**
+  Make option value outputing stream.
+  It's add useful validation and shortcut for STDOUT.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
 
-        if(this._long) {
-            res.push('--', Color('green', this._long));
-            this._flag || res.push('=' + nameStr);
+  Opt.prototype.output = function() {
+    return this.def(process.stdout).val(function(v) {
+      if (typeof v === 'string') {
+        if (v === '-') {
+          return process.stdout;
+        } else {
+          return fs.createWriteStream(v, {
+            encoding: 'utf8'
+          });
         }
+      } else {
+        return v;
+      }
+    });
+  };
 
-        res.push(' : ', this._title);
+  /**
+  Add action for current option command.
+  This action is performed if the current option
+  is present in parsed options (with any value).
+  @param {Function} act action function,
+      invoked in the context of command instance
+      and has the parameters:
+          - {Object} opts parsed options
+          - {Array} args parsed arguments
+          - {Object} res actions result accumulator
+      It can return rejected promise by Cmd.reject (in case of error)
+      or any other value treated as result.
+  @returns {COA.Opt} this instance (for chainability)
+  */
 
-        this._req && res.push(' ', Color('lred', '(required)'));
 
-        return res.join('');
+  Opt.prototype.act = function(act) {
+    var name, opt;
+    opt = this;
+    name = this._name;
+    this._cmd.act(function(opts) {
+      var res,
+        _this = this;
+      if (name in opts) {
+        res = act.apply(this, arguments);
+        if (opt._only) {
+          return Q.when(res, function(res) {
+            return _this.reject({
+              toString: function() {
+                return res.toString();
+              },
+              exitCode: 0
+            });
+          });
+        } else {
+          return res;
+        }
+      }
+    });
+    return this;
+  };
+
+  /**
+  Set custom additional completion for current option.
+  @param {Function} completion generation function,
+      invoked in the context of option instance.
+      Accepts parameters:
+          - {Object} opts completion options
+      It can return promise or any other value treated as result.
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.comp = Cmd.prototype.comp;
+
+  Opt.prototype._saveVal = function(opts, val) {
+    var _name;
+    if (this._val) {
+      val = this._val(val);
+    }
+    if (this._arr) {
+      (opts[_name = this._name] || (opts[_name] = [])).push(val);
+    } else {
+      opts[this._name] = val;
     }
+    return val;
+  };
+
+  Opt.prototype._parse = function(argv, opts) {
+    return this._saveVal(opts, this._flag ? true : argv.shift());
+  };
 
-    _requiredText() {
-        return `Missing required option:\n  ${this._usage()}`;
+  Opt.prototype._checkParsed = function(opts, args) {
+    return !opts.hasOwnProperty(this._name);
+  };
+
+  Opt.prototype._usage = function() {
+    var nameStr, res;
+    res = [];
+    nameStr = this._name.toUpperCase();
+    if (this._short) {
+      res.push('-', Color('lgreen', this._short));
+      if (!this._flag) {
+        res.push(' ' + nameStr);
+      }
+      res.push(', ');
+    }
+    if (this._long) {
+      res.push('--', Color('green', this._long));
+      if (!this._flag) {
+        res.push('=' + nameStr);
+      }
     }
-};
+    res.push(' : ', this._title);
+    if (this._req) {
+      res.push(' ', Color('lred', '(required)'));
+    }
+    return res.join('');
+  };
+
+  Opt.prototype._requiredText = function() {
+    return 'Missing required option:\n  ' + this._usage();
+  };
+
+  /**
+  Return rejected promise with error code.
+  Use in .val() for return with error.
+  @param {Object} reject reason
+      You can customize toString() method and exitCode property
+      of reason object.
+  @returns {Q.promise} rejected promise
+  */
+
+
+  Opt.prototype.reject = Cmd.prototype.reject;
+
+  /**
+  Finish chain for current option and return parent command instance.
+  @returns {COA.Cmd} parent command
+  */
+
+
+  Opt.prototype.end = Cmd.prototype.end;
+
+  /**
+  Apply function with arguments in context of option instance.
+  @param {Function} fn
+  @param {Array} args
+  @returns {COA.Opt} this instance (for chainability)
+  */
+
+
+  Opt.prototype.apply = Cmd.prototype.apply;
+
+  return Opt;
+
+})();

package/lib/shell.js

@@ -1,14 +1,14 @@
-module.exports = { escape, unescape };
+// Generated by CoffeeScript 1.6.3
+exports.unescape = function(w) {
+  w = w.charAt(0) === '"' ? w.replace(/^"|([^\\])"$/g, '$1') : w.replace(/\\ /g, ' ');
+  return w.replace(/\\("|'|\$|`|\\)/g, '$1');
+};
 
-function unescape(w) {
-    w = w.charAt(0) === '"'
-        ? w.replace(/^"|([^\\])"$/g, '$1')
-        : w.replace(/\\ /g, ' ');
-
-    return w.replace(/\\("|'|\$|`|\\)/g, '$1');
-}
-
-function escape(w) {
-    w = w.replace(/(["'$`\\])/g,'\\$1');
-    return w.match(/\s+/) ? `"${w}"` : w;
-}
+exports.escape = function(w) {
+  w = w.replace(/(["'$`\\])/g, '\\$1');
+  if (w.match(/\s+/)) {
+    return '"' + w + '"';
+  } else {
+    return w;
+  }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "coa",
   "description": "Command-Option-Argument: Yet another parser for command line options.",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "homepage": "http://github.com/veged/coa",
   "author": "Sergey Berezhnoy <veged@ya.ru> (http://github.com/veged)",
   "maintainers": [
@@ -11,11 +11,6 @@
   "contributors": [
     "Sergey Belov <peimei@ya.ru> (http://github.com/arikon)"
   ],
-  "files": [
-    "lib/",
-    "index.js",
-    "README.ru.md"
-  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/veged/coa.git"
@@ -27,23 +22,23 @@
     "q": "^1.1.2"
   },
   "devDependencies": {
-    "chai": "~1.7.2",
-    "coveralls": "^2.11.16",
-    "eslint": "^3.15.0",
-    "eslint-config-pedant": "^0.8.0",
+    "coffee-script": "~1.6.3",
+    "istanbul": "~0.1.40",
+    "mocha-istanbul": "*",
     "mocha": "~1.21.4",
-    "nyc": "^10.1.2"
+    "chai": "~1.7.2"
   },
   "scripts": {
-    "clean": "rm -r .nyc_output coverage",
-    "coverage": "nyc --reporter=text --reporter=html mocha; echo; echo 'Open coverage/index.html file in your browser'",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls",
-    "lint": "eslint .",
-    "pretest": "npm run lint",
-    "test": "nyc mocha"
+    "test": "make test",
+    "coverage": "make coverage"
   },
   "engines": {
-    "node": ">= 4.0"
+    "node": ">= 0.8.0"
   },
-  "license": "MIT"
+  "licenses": [
+    {
+      "type": "MIT"
+    }
+  ],
+  "optionalDependencies": {}
 }

package/qq.js

@@ -0,0 +1,17 @@
+const run = require('./test/util').run;
+
+// run(cmd => cmd.arg().name('qwe').end().arg().name('zxc').end().act(function(opts, args) { console.log({opts, args}); }), ['qwe', 'zxc']) // cmd and args
+//     .then(res => {
+//         // code
+//         // stdout
+//         // stderr
+//         console.log(res);
+//     });
+
+run(cmd => cmd.opt().name('version').short('v').only().flag().act((opts) => { return 'aasd'; }), ['-v']) // cmd and args
+    .then(res => {
+        // code
+        // stdout
+        // stderr
+        console.log(res);
+    });

package/src/arg.coffee

@@ -0,0 +1,130 @@
+Color = require('./color').Color
+Cmd = require('./cmd').Cmd
+Opt = require('./opt').Opt
+
+###*
+Argument
+
+Unnamed entity. From command line arguments passed as list of unnamed values.
+@namespace
+@class Presents argument
+###
+exports.Arg = class Arg
+
+    ###*
+    @constructs
+    @param {COA.Cmd} cmd parent command
+    ###
+    constructor: (@_cmd) -> @_cmd._args.push @
+
+    ###*
+    Set a canonical argument identifier to be used anywhere in text messages.
+    @param {String} _name argument name
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    name: Opt::name
+
+    ###*
+    Set a long description for argument to be used anywhere in text messages.
+    @param {String} _title argument title
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    title: Cmd::title
+
+    ###*
+    Makes an argument accepts multiple values.
+    Otherwise, the value will be used by the latter passed.
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    arr: Opt::arr
+
+    ###*
+    Makes an argument required.
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    req: Opt::req
+
+    ###*
+    Set a validation (or value) function for argument.
+    Value from command line passes through before becoming available from API.
+    Using for validation and convertion simple types to any values.
+    @param {Function} _val validating function,
+        invoked in the context of argument instance
+        and has one parameter with value from command line
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    val: Opt::val
+
+    ###*
+    Set a default value for argument.
+    Default value passed through validation function as ordinary value.
+    @param {Object} _def
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    def: Opt::def
+
+    ###*
+    Set custom additional completion for current argument.
+    @param {Function} completion generation function,
+        invoked in the context of argument instance.
+        Accepts parameters:
+            - {Object} opts completion options
+        It can return promise or any other value treated as result.
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    comp: Cmd::comp
+
+    ###*
+    Make argument value inputting stream.
+    It's add useful validation and shortcut for STDIN.
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    input: Opt::input
+
+    ###*
+    Make argument value outputing stream.
+    It's add useful validation and shortcut for STDOUT.
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    output: Opt::output
+
+    _parse: (arg, args) ->
+        @_saveVal(args, arg)
+
+    _saveVal: Opt::_saveVal
+
+    _checkParsed: (opts, args) -> not args.hasOwnProperty(@_name)
+
+    _usage: ->
+        res = []
+
+        res.push Color('lpurple', @_name.toUpperCase()), ' : ', @_title
+        if @_req then res.push ' ', Color('lred', '(required)')
+
+        res.join ''
+
+    _requiredText: -> 'Missing required argument:\n  ' + @_usage()
+
+    ###*
+    Return rejected promise with error code.
+    Use in .val() for return with error.
+    @param {Object} reject reason
+        You can customize toString() method and exitCode property
+        of reason object.
+    @returns {Q.promise} rejected promise
+    ###
+    reject: Cmd::reject
+
+    ###*
+    Finish chain for current option and return parent command instance.
+    @returns {COA.Cmd} parent command
+    ###
+    end: Cmd::end
+
+    ###*
+    Apply function with arguments in context of arg instance.
+    @param {Function} fn
+    @param {Array} args
+    @returns {COA.Arg} this instance (for chainability)
+    ###
+    apply: Cmd::apply