coa 0.4.1 → 1.0.3

package/lib/opt.js

@@ -1,338 +1,155 @@
-// Generated by CoffeeScript 1.6.3
-var Cmd, Color, Opt, Q, fs;
+'use strict';
 
-fs = require('fs');
+const
+    Q = require('q'),
 
-Q = require('q');
-
-Color = require('./color').Color;
-
-Cmd = require('./cmd').Cmd;
+    CoaParam = require('./coaparam'),
+    Color = require('./color');
 
 /**
-Option
-
-Named entity. Options may have short and long keys for use from command line.
-@namespace
-@class Presents option
-*/
-
-
-exports.Opt = Opt = (function() {
-  /**
-  @constructs
-  @param {COA.Cmd} cmd parent command
-  */
-
-  function Opt(_cmd) {
-    this._cmd = _cmd;
-    this._cmd._opts.push(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)
-  */
-
-
-  Opt.prototype.name = function(_name) {
-    this._name = _name;
-    return this;
-  };
-
-  /**
-  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)
-  */
-
-
-  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;
-  };
+ * 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);
+    }
 
-  /**
-  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)
-  */
+    /**
+     * 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;
+    }
 
+    /**
+     * 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;
+    }
 
-  Opt.prototype.val = function(_val) {
-    this._val = _val;
-    return this;
-  };
+    /**
+     * Make an option boolean, i.e. option without value.
+     *
+     * @returns {COA.Opt} - this instance (for chainability)
+     */
+    flag() {
+        this._flag = true;
+        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)
-  */
+    /**
+     * 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;
+    }
 
+    /**
+     * 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;
+    }
 
-  Opt.prototype.def = function(_def) {
-    this._def = _def;
-    return this;
-  };
+    _saveVal(opts, val) {
+        this._val && (val = this._val(val));
 
-  /**
-  Make option value inputting stream.
-  It's add useful validation and shortcut for STDIN.
-  @returns {COA.Opt} this instance (for chainability)
-  */
+        const name = this._name;
+        this._arr
+            ? (opts[name] || (opts[name] = [])).push(val)
+            : (opts[name] = val);
 
+        return val;
+    }
 
-  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;
-      }
-    });
-  };
+    _parse(argv, opts) {
+        return this._saveVal(opts, this._flag ? true : argv.shift());
+    }
 
-  /**
-  Make option value outputing stream.
-  It's add useful validation and shortcut for STDOUT.
-  @returns {COA.Opt} this instance (for chainability)
-  */
+    _checkParsed(opts) {
+        return !opts.hasOwnProperty(this._name);
+    }
 
+    _usage() {
+        const res = [],
+            nameStr = this._name.toUpperCase();
 
-  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'
-          });
+        if(this._short) {
+            res.push('-', Color('lgreen', this._short));
+            this._flag || res.push(' ' + nameStr);
+            res.push(', ');
         }
-      } else {
-        return v;
-      }
-    });
-  };
-
-  /**
-  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)
-  */
-
 
-  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;
+        if(this._long) {
+            res.push('--', Color('green', this._long));
+            this._flag || res.push('=' + nameStr);
         }
-      }
-    });
-    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)
-  */
+        res.push(' : ', this._title);
 
+        this._req && res.push(' ', Color('lred', '(required)'));
 
-  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 res.join('');
     }
-    return val;
-  };
-
-  Opt.prototype._parse = function(argv, opts) {
-    return this._saveVal(opts, this._flag ? true : argv.shift());
-  };
 
-  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);
-      }
+    _requiredText() {
+        return `Missing required option:\n  ${this._usage()}`;
     }
-    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 @@
-// 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');
-};
+module.exports = { escape, unescape };
 
-exports.escape = function(w) {
-  w = w.replace(/(["'$`\\])/g, '\\$1');
-  if (w.match(/\s+/)) {
-    return '"' + w + '"';
-  } else {
-    return w;
-  }
-};
+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;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "coa",
   "description": "Command-Option-Argument: Yet another parser for command line options.",
-  "version": "0.4.1",
+  "version": "1.0.3",
   "homepage": "http://github.com/veged/coa",
   "author": "Sergey Berezhnoy <veged@ya.ru> (http://github.com/veged)",
   "maintainers": [
@@ -11,6 +11,11 @@
   "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"
@@ -19,27 +24,26 @@
     "lib": "./lib"
   },
   "dependencies": {
-    "q": "~0.9.6"
+    "q": "^1.1.2"
   },
   "devDependencies": {
-    "coffee-script": "~1.6.3",
-    "istanbul": "~0.1.40",
-    "mocha-as-promised": "*",
-    "mocha-istanbul": "*",
-    "mocha": "~1.12.0",
-    "chai": "~1.7.2"
+    "chai": "~1.7.2",
+    "coveralls": "^2.11.16",
+    "eslint": "^3.15.0",
+    "eslint-config-pedant": "^0.8.0",
+    "mocha": "~1.21.4",
+    "nyc": "^10.1.2"
   },
   "scripts": {
-    "test": "make test",
-    "coverage": "make coverage"
+    "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"
   },
   "engines": {
-    "node": ">= 0.6.0"
+    "node": ">= 4.0"
   },
-  "licenses": [
-    {
-      "type": "MIT"
-    }
-  ],
-  "optionalDependencies": {}
+  "license": "MIT"
 }

package/.npmignore

@@ -1,6 +0,0 @@
-.idea
-*.iml
-node_modules/
-!node_modules/coa*.js
-lib-cov/
-html-report/

package/.travis.yml

@@ -1,11 +0,0 @@
-language: node_js
-
-node_js:
-  - "0.6"
-  - "0.8"
-  - "0.10"
-  - "0.11"
-
-matrix:
-  allow_failures:
-    - node_js: 0.11

package/GNUmakefile

@@ -1,34 +0,0 @@
-BIN = ./node_modules/.bin
-
-.PHONY: all
-all: lib
-
-lib: $(foreach s,$(wildcard src/*.coffee),$(patsubst src/%.coffee,lib/%.js,$s))
-
-lib-cov: clean-coverage lib
-	$(BIN)/istanbul instrument --output lib-cov --no-compact --variable global.__coverage__ lib
-
-lib/%.js: src/%.coffee
-	$(BIN)/coffee -cb -o $(@D) $<
-
-.PHONY: test
-test: lib
-	$(BIN)/mocha
-
-.PHONY: coverage
-coverage: lib-cov
-	COVER=1 $(BIN)/mocha --reporter mocha-istanbul
-	@echo
-	@echo Open html-report/index.html file in your browser
-
-.PHONY: watch
-watch:
-	$(BIN)/coffee --watch --bare --output lib src/*.coffee
-
-.PHONY: clean
-clean: clean-coverage
-
-.PHONY: clean-coverage
-clean-coverage:
-	-rm -rf lib-cov
-	-rm -rf html-report