All files / coa/lib opt.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
 
 
1x
 
1x
1x
 
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
16x
 
16x
16x
16x
16x
16x
 
 
 
 
 
 
 
 
 
7x
7x
7x
 
 
 
 
 
 
 
 
 
9x
9x
9x
 
 
 
 
 
 
 
 
1x
1x
 
 
 
 
 
 
 
 
 
1x
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
1x
 
1x
1x
 
1x
2x
 
 
 
 
1x
 
 
 
20x
 
20x
20x
 
 
 
20x
 
 
 
18x
 
 
 
2x
 
 
 
1x
1x
 
1x
1x
1x
1x
 
 
1x
 
 
 
 
1x
 
1x
 
1x
 
 
 
1x
 
 
 
'use strict';
 
const
    Q = require('q'),
 
    CoaParam = require('./coaparam'),
    Color = require('./color');
 
/**
 * 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 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;
    }
 
    /**
     * Make an option boolean, i.e. option without value.
     *
     * @returns {COA.Opt} - this instance (for chainability)
     */
    flag() {
        this._flag = 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)
     */
    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) {
        this._cmd.act((opts) => {
            Iif(!opts.hasOwnProperty(this._name)) return;
 
            const res = act.apply(this._cmd, arguments);
            Iif(!this._only) return res;
 
            return Q.when(res, (out) => this._cmd.reject({
                toString : () => out.toString(),
                exitCode : 0
            }));
        });
 
        return this;
    }
 
    _saveVal(opts, val) {
        this._val && (val = this._val(val));
 
        const name = this._name;
        this._arr
            ? (opts[name] || (opts[name] = [])).push(val)
            : (opts[name] = val);
 
        return val;
    }
 
    _parse(argv, opts) {
        return this._saveVal(opts, this._flag ? true : argv.shift());
    }
 
    _checkParsed(opts) {
        return !opts.hasOwnProperty(this._name);
    }
 
    _usage() {
        const res = [],
            nameStr = this._name.toUpperCase();
 
        Eif(this._short) {
            res.push('-', Color('lgreen', this._short));
            this._flag || res.push(' ' + nameStr);
            res.push(', ');
        }
 
        Iif(this._long) {
            res.push('--', Color('green', this._long));
            this._flag || res.push('=' + nameStr);
        }
 
        res.push(' : ', this._title);
 
        this._req && res.push(' ', Color('lred', '(required)'));
 
        return res.join('');
    }
 
    _requiredText() {
        return `Missing required option:\n  ${this._usage()}`;
    }
};