coa 2.0.0 → 2.0.2

package/coa.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="q"/>
+
+export const Arg: undefined;
+
+export const Opt: undefined;
+
+export function Cmd(cmd?: classes.Cmd): classes.Cmd;
+
+export namespace classes {
+    class Arg {
+        constructor(cmd: Cmd);
+        name(name: string): Arg;
+        title(title: string): Arg;
+        arr(): Arg;
+        req(): Arg;
+        val(validation: (this: Arg, value: any) => boolean): Arg;
+        def(def: any): Arg;
+        output(): Arg;
+        comp(fn: (opts: any) => any): Arg;
+        end(): Cmd;
+        apply(...args: any[]): Arg;
+        input(): Arg;
+        reject(...args: any[]): Arg;
+    }
+
+    class Cmd {
+        constructor(cmd?: Cmd);
+        static create(cmd?: Cmd): Cmd;
+        api(): any;
+        name(name: string): Cmd;
+        title(title: string): Cmd;
+        cmd(cmd?: Cmd): Cmd;
+        opt(): Opt;
+        arg(): Arg;
+        act(act: (opts: any, args: any[], res: any) => any, force?: boolean): Cmd;
+        apply(fn: Function, args?: any[]): Cmd;
+        comp(fs: (opts: any) => any): Cmd;
+        helpful(): Cmd;
+        completable(): Cmd;
+        usage(): string;
+        run(argv: string[]): Cmd;
+        invoke(cmds?: string|string[], opts?: any, args?: any): Q.Promise<any>;
+        reject(reason: any): Q.Promise<any>;
+        end(): Cmd;
+        do(argv: string[]): any;
+        extendable(pattern?: string): Cmd;
+    }
+
+    class Opt {
+        constructor(cmd?: Cmd);
+        name(name: string): Opt;
+        title(title: string): Opt;
+        short(short: string): Opt;
+        long(long: string): Opt;
+        flag(): Opt;
+        arr(): Opt;
+        req(): Opt;
+        only(): Opt;
+        val(validation: (this: Opt, value: any) => boolean): Opt;
+        def(def: any): Opt;
+        input(): Opt;
+        output(): Opt;
+        act(act: (opts: any, args: any[], res: any) => any): Opt;
+        comp(fn: (opts: any) => any): Opt;
+        end(): Cmd;
+        apply(...args: any[]): void;
+        reject(...args: any[]): void;
+    }
+}
+
+export namespace shell {
+    function escape(w: string): string;
+    function unescape(w: string): string;
+}

package/lib/arg.js

@@ -2,7 +2,7 @@
 
 const
     CoaParam = require('./coaparam'),
-    Color = require('./color');
+    chalk = require('chalk');
 
 /**
  * Argument
@@ -45,9 +45,9 @@ module.exports = class Arg extends CoaParam {
     _usage() {
         const res = [];
 
-        res.push(Color('lpurple', this._name.toUpperCase()), ' : ', this._title);
+        res.push(chalk.magentaBright(this._name.toUpperCase()), ' : ', this._title);
 
-        this._req && res.push(' ', Color('lred', '(required)'));
+        this._req && res.push(' ', chalk.redBright('(required)'));
 
         return res.join('');
     }

package/lib/cmd.js

@@ -1,3 +1,4 @@
+/* eslint-disable class-methods-use-this */
 'use strict';
 
 const
@@ -6,9 +7,9 @@ const
     EOL = require('os').EOL,
 
     Q = require('q'),
+    chalk = require('chalk'),
 
     CoaObject = require('./coaobject'),
-    Color = require('./color'),
     Opt = require('./opt'),
     Arg = require('./arg'),
     completion = require('./completion');
@@ -191,9 +192,9 @@ class Cmd extends CoaObject {
     }
 
     _exit(msg, code) {
-        return process.once('exit', function() {
+        return process.once('exit', function(exitCode) {
             msg && console[code === 0 ? 'log' : 'error'](msg);
-            process.exit(code || 0);
+            process.exit(code || exitCode || 0);
         });
     }
 
@@ -211,14 +212,14 @@ class Cmd extends CoaObject {
 
         this._cmds.length
             && res.push([
-                '', '', Color('lred', this._fullName()), Color('lblue', 'COMMAND'),
-                Color('lgreen', '[OPTIONS]'), Color('lpurple', '[ARGS]')
+                '', '', chalk.redBright(this._fullName()), chalk.blueBright('COMMAND'),
+                chalk.greenBright('[OPTIONS]'), chalk.magentaBright('[ARGS]')
             ].join(' '));
 
         (this._opts.length + this._args.length)
             && res.push([
-                '', '', Color('lred', this._fullName()),
-                Color('lgreen', '[OPTIONS]'), Color('lpurple', '[ARGS]')
+                '', '', chalk.redBright(this._fullName()),
+                chalk.greenBright('[OPTIONS]'), chalk.magentaBright('[ARGS]')
             ].join(' '));
 
         res.push(
@@ -231,7 +232,7 @@ class Cmd extends CoaObject {
     }
 
     _usage() {
-        return Color('lblue', this._name) + ' : ' + this._title;
+        return chalk.blueBright(this._name) + ' : ' + this._title;
     }
 
     _usages(os, title) {
@@ -369,7 +370,7 @@ class Cmd extends CoaObject {
 
     _setDefaults(params, desc) {
         for(const item of desc)
-            item._def &&
+            item._def !== undefined &&
                 !params.hasOwnProperty(item._name) &&
                 item._saveVal(params, item._def);
 

package/lib/coaobject.js

@@ -1,3 +1,4 @@
+/* eslint-disable class-methods-use-this */
 'use strict';
 
 const Q = require('q');

package/lib/completion.js

@@ -62,7 +62,7 @@ function dumpScript(name) {
 
     fs.readFile(path.resolve(__dirname, 'completion.sh'), 'utf8', function(err, d) {
         if(err) return defer.reject(err);
-        d = d.replace(/{{cmd}}/g, path.basename(name)).replace(/^\#\!.*?\n/, '');
+        d = d.replace(/{{cmd}}/g, path.basename(name)).replace(/^#!.*?\n/, '');
 
         process.stdout.on('error', onError);
         process.stdout.write(d, () => defer.resolve());

package/lib/opt.js

@@ -4,7 +4,7 @@ const
     Q = require('q'),
 
     CoaParam = require('./coaparam'),
-    Color = require('./color');
+    chalk = require('chalk');
 
 /**
  * Option
@@ -132,19 +132,19 @@ module.exports = class Opt extends CoaParam {
             nameStr = this._name.toUpperCase();
 
         if(this._short) {
-            res.push('-', Color('lgreen', this._short));
+            res.push('-', chalk.greenBright(this._short));
             this._flag || res.push(' ' + nameStr);
             res.push(', ');
         }
 
         if(this._long) {
-            res.push('--', Color('green', this._long));
+            res.push('--', chalk.green(this._long));
             this._flag || res.push('=' + nameStr);
         }
 
         res.push(' : ', this._title);
 
-        this._req && res.push(' ', Color('lred', '(required)'));
+        this._req && res.push(' ', chalk.redBright('(required)'));
 
         return res.join('');
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "coa",
   "description": "Command-Option-Argument: Yet another parser for command line options.",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "homepage": "http://github.com/veged/coa",
   "author": "Sergey Berezhnoy <veged@ya.ru> (http://github.com/veged)",
   "maintainers": [
@@ -14,6 +14,7 @@
   "files": [
     "lib/",
     "index.js",
+    "coa.d.ts",
     "README.ru.md"
   ],
   "repository": {
@@ -24,13 +25,15 @@
     "lib": "./lib"
   },
   "dependencies": {
+    "@types/q": "^1.5.1",
+    "chalk": "^2.4.1",
     "q": "^1.1.2"
   },
   "devDependencies": {
     "chai": "~1.7.2",
     "coveralls": "^2.11.16",
-    "eslint": "^3.15.0",
-    "eslint-config-pedant": "^0.8.0",
+    "eslint": "^4.15.0",
+    "eslint-config-pedant": "^1.0.0",
     "mocha": "~1.21.4",
     "nyc": "^10.1.2"
   },
@@ -45,5 +48,6 @@
   "engines": {
     "node": ">= 4.0"
   },
+  "types": "./coa.d.ts",
   "license": "MIT"
 }

package/lib/color.js

@@ -1,22 +0,0 @@
-'use strict';
-
-const colors = {
-    black : '30',
-    dgray : '1;30',
-    red : '31',
-    lred : '1;31',
-    green : '32',
-    lgreen : '1;32',
-    brown : '33',
-    yellow : '1;33',
-    blue : '34',
-    lblue : '1;34',
-    purple : '35',
-    lpurple : '1;35',
-    cyan : '36',
-    lcyan : '1;36',
-    lgray : '37',
-    white : '1;37'
-};
-
-module.exports = (c, str) => `\x1B[${colors[c]}m${str}\x1B[m`;