minimist 0.0.7 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +22 -14
- package/package.json +1 -1
- package/readme.markdown +11 -0
- package/test/bool.js +119 -0
- package/test/dash.js +7 -0
- package/test/dotted.js +6 -0
- package/test/num.js +36 -0
- package/test/parse.js +44 -144
package/index.js
CHANGED
|
@@ -7,10 +7,6 @@ module.exports = function (args, opts) {
|
|
|
7
7
|
flags.bools[key] = true;
|
|
8
8
|
});
|
|
9
9
|
|
|
10
|
-
[].concat(opts.string).filter(Boolean).forEach(function (key) {
|
|
11
|
-
flags.strings[key] = true;
|
|
12
|
-
});
|
|
13
|
-
|
|
14
10
|
var aliases = {};
|
|
15
11
|
Object.keys(opts.alias || {}).forEach(function (key) {
|
|
16
12
|
aliases[key] = [].concat(opts.alias[key]);
|
|
@@ -20,7 +16,14 @@ module.exports = function (args, opts) {
|
|
|
20
16
|
}));
|
|
21
17
|
});
|
|
22
18
|
});
|
|
23
|
-
|
|
19
|
+
|
|
20
|
+
[].concat(opts.string).filter(Boolean).forEach(function (key) {
|
|
21
|
+
flags.strings[key] = true;
|
|
22
|
+
if (aliases[key]) {
|
|
23
|
+
flags.strings[aliases[key]] = true;
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
|
|
24
27
|
var defaults = opts['default'] || {};
|
|
25
28
|
|
|
26
29
|
var argv = { _ : [] };
|
|
@@ -74,7 +77,7 @@ module.exports = function (args, opts) {
|
|
|
74
77
|
i++;
|
|
75
78
|
}
|
|
76
79
|
else {
|
|
77
|
-
setArg(key, true);
|
|
80
|
+
setArg(key, flags.strings[key] ? '' : true);
|
|
78
81
|
}
|
|
79
82
|
}
|
|
80
83
|
else if (/^-[^-]+/.test(arg)) {
|
|
@@ -102,7 +105,7 @@ module.exports = function (args, opts) {
|
|
|
102
105
|
break;
|
|
103
106
|
}
|
|
104
107
|
else {
|
|
105
|
-
setArg(letters[j], true);
|
|
108
|
+
setArg(letters[j], flags.strings[letters[j]] ? '' : true);
|
|
106
109
|
}
|
|
107
110
|
}
|
|
108
111
|
|
|
@@ -119,7 +122,7 @@ module.exports = function (args, opts) {
|
|
|
119
122
|
i++;
|
|
120
123
|
}
|
|
121
124
|
else {
|
|
122
|
-
setArg(key, true);
|
|
125
|
+
setArg(key, flags.strings[key] ? '' : true);
|
|
123
126
|
}
|
|
124
127
|
}
|
|
125
128
|
}
|
|
@@ -140,9 +143,17 @@ module.exports = function (args, opts) {
|
|
|
140
143
|
}
|
|
141
144
|
});
|
|
142
145
|
|
|
143
|
-
|
|
144
|
-
argv
|
|
145
|
-
|
|
146
|
+
if (opts['--']) {
|
|
147
|
+
argv['--'] = new Array();
|
|
148
|
+
notFlags.forEach(function(key) {
|
|
149
|
+
argv['--'].push(key);
|
|
150
|
+
});
|
|
151
|
+
}
|
|
152
|
+
else {
|
|
153
|
+
notFlags.forEach(function(key) {
|
|
154
|
+
argv._.push(key);
|
|
155
|
+
});
|
|
156
|
+
}
|
|
146
157
|
|
|
147
158
|
return argv;
|
|
148
159
|
};
|
|
@@ -182,6 +193,3 @@ function isNumber (x) {
|
|
|
182
193
|
return /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(x);
|
|
183
194
|
}
|
|
184
195
|
|
|
185
|
-
function longest (xs) {
|
|
186
|
-
return Math.max.apply(null, xs.map(function (x) { return x.length }));
|
|
187
|
-
}
|
package/package.json
CHANGED
package/readme.markdown
CHANGED
|
@@ -59,6 +59,17 @@ strings
|
|
|
59
59
|
* `opts.alias` - an object mapping string names to strings or arrays of string
|
|
60
60
|
argument names to use as aliases
|
|
61
61
|
* `opts.default` - an object mapping string argument names to default values
|
|
62
|
+
* `opts['--']` - when true, populate `argv._` with everything before the `--`
|
|
63
|
+
and `argv['--']` with everything after the `--`. Here's an example:
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
> require('./')('one two three -- four five --six'.split(' '), { '--': true })
|
|
67
|
+
{ _: [ 'one', 'two', 'three' ],
|
|
68
|
+
'--': [ 'four', 'five', '--six' ] }
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Note that with `opts['--']` set, parsing for arguments still stops after the
|
|
72
|
+
`--`.
|
|
62
73
|
|
|
63
74
|
# install
|
|
64
75
|
|
package/test/bool.js
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
var parse = require('../');
|
|
2
|
+
var test = require('tape');
|
|
3
|
+
|
|
4
|
+
test('flag boolean default false', function (t) {
|
|
5
|
+
var argv = parse(['moo'], {
|
|
6
|
+
boolean: ['t', 'verbose'],
|
|
7
|
+
default: { verbose: false, t: false }
|
|
8
|
+
});
|
|
9
|
+
|
|
10
|
+
t.deepEqual(argv, {
|
|
11
|
+
verbose: false,
|
|
12
|
+
t: false,
|
|
13
|
+
_: ['moo']
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
t.deepEqual(typeof argv.verbose, 'boolean');
|
|
17
|
+
t.deepEqual(typeof argv.t, 'boolean');
|
|
18
|
+
t.end();
|
|
19
|
+
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
test('boolean groups', function (t) {
|
|
23
|
+
var argv = parse([ '-x', '-z', 'one', 'two', 'three' ], {
|
|
24
|
+
boolean: ['x','y','z']
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
t.deepEqual(argv, {
|
|
28
|
+
x : true,
|
|
29
|
+
y : false,
|
|
30
|
+
z : true,
|
|
31
|
+
_ : [ 'one', 'two', 'three' ]
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
t.deepEqual(typeof argv.x, 'boolean');
|
|
35
|
+
t.deepEqual(typeof argv.y, 'boolean');
|
|
36
|
+
t.deepEqual(typeof argv.z, 'boolean');
|
|
37
|
+
t.end();
|
|
38
|
+
});
|
|
39
|
+
test('boolean and alias with chainable api', function (t) {
|
|
40
|
+
var aliased = [ '-h', 'derp' ];
|
|
41
|
+
var regular = [ '--herp', 'derp' ];
|
|
42
|
+
var opts = {
|
|
43
|
+
herp: { alias: 'h', boolean: true }
|
|
44
|
+
};
|
|
45
|
+
var aliasedArgv = parse(aliased, {
|
|
46
|
+
boolean: 'herp',
|
|
47
|
+
alias: { h: 'herp' }
|
|
48
|
+
});
|
|
49
|
+
var propertyArgv = parse(regular, {
|
|
50
|
+
boolean: 'herp',
|
|
51
|
+
alias: { h: 'herp' }
|
|
52
|
+
});
|
|
53
|
+
var expected = {
|
|
54
|
+
herp: true,
|
|
55
|
+
h: true,
|
|
56
|
+
'_': [ 'derp' ]
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
t.same(aliasedArgv, expected);
|
|
60
|
+
t.same(propertyArgv, expected);
|
|
61
|
+
t.end();
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
test('boolean and alias with options hash', function (t) {
|
|
65
|
+
var aliased = [ '-h', 'derp' ];
|
|
66
|
+
var regular = [ '--herp', 'derp' ];
|
|
67
|
+
var opts = {
|
|
68
|
+
alias: { 'h': 'herp' },
|
|
69
|
+
boolean: 'herp'
|
|
70
|
+
};
|
|
71
|
+
var aliasedArgv = parse(aliased, opts);
|
|
72
|
+
var propertyArgv = parse(regular, opts);
|
|
73
|
+
var expected = {
|
|
74
|
+
herp: true,
|
|
75
|
+
h: true,
|
|
76
|
+
'_': [ 'derp' ]
|
|
77
|
+
};
|
|
78
|
+
t.same(aliasedArgv, expected);
|
|
79
|
+
t.same(propertyArgv, expected);
|
|
80
|
+
t.end();
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
test('boolean and alias using explicit true', function (t) {
|
|
84
|
+
var aliased = [ '-h', 'true' ];
|
|
85
|
+
var regular = [ '--herp', 'true' ];
|
|
86
|
+
var opts = {
|
|
87
|
+
alias: { h: 'herp' },
|
|
88
|
+
boolean: 'h'
|
|
89
|
+
};
|
|
90
|
+
var aliasedArgv = parse(aliased, opts);
|
|
91
|
+
var propertyArgv = parse(regular, opts);
|
|
92
|
+
var expected = {
|
|
93
|
+
herp: true,
|
|
94
|
+
h: true,
|
|
95
|
+
'_': [ ]
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
t.same(aliasedArgv, expected);
|
|
99
|
+
t.same(propertyArgv, expected);
|
|
100
|
+
t.end();
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
// regression, see https://github.com/substack/node-optimist/issues/71
|
|
104
|
+
test('boolean and --x=true', function(t) {
|
|
105
|
+
var parsed = parse(['--boool', '--other=true'], {
|
|
106
|
+
boolean: 'boool'
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
t.same(parsed.boool, true);
|
|
110
|
+
t.same(parsed.other, 'true');
|
|
111
|
+
|
|
112
|
+
parsed = parse(['--boool', '--other=false'], {
|
|
113
|
+
boolean: 'boool'
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
t.same(parsed.boool, true);
|
|
117
|
+
t.same(parsed.other, 'false');
|
|
118
|
+
t.end();
|
|
119
|
+
});
|
package/test/dash.js
CHANGED
|
@@ -22,3 +22,10 @@ test('-a -- b', function (t) {
|
|
|
22
22
|
t.deepEqual(parse([ '--a', '--', 'b' ]), { a: true, _: [ 'b' ] });
|
|
23
23
|
t.deepEqual(parse([ '--a', '--', 'b' ]), { a: true, _: [ 'b' ] });
|
|
24
24
|
});
|
|
25
|
+
|
|
26
|
+
test('move arguments after the -- into their own `--` array', function(t) {
|
|
27
|
+
t.plan(1);
|
|
28
|
+
t.deepEqual(
|
|
29
|
+
parse([ '--name', 'John', 'before', '--', 'after' ], { '--': true }),
|
|
30
|
+
{ name: 'John', _: [ 'before' ], '--': [ 'after' ] });
|
|
31
|
+
});
|
package/test/dotted.js
CHANGED
package/test/num.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
var parse = require('../');
|
|
2
|
+
var test = require('tape');
|
|
3
|
+
|
|
4
|
+
test('nums', function (t) {
|
|
5
|
+
var argv = parse([
|
|
6
|
+
'-x', '1234',
|
|
7
|
+
'-y', '5.67',
|
|
8
|
+
'-z', '1e7',
|
|
9
|
+
'-w', '10f',
|
|
10
|
+
'--hex', '0xdeadbeef',
|
|
11
|
+
'789'
|
|
12
|
+
]);
|
|
13
|
+
t.deepEqual(argv, {
|
|
14
|
+
x : 1234,
|
|
15
|
+
y : 5.67,
|
|
16
|
+
z : 1e7,
|
|
17
|
+
w : '10f',
|
|
18
|
+
hex : 0xdeadbeef,
|
|
19
|
+
_ : [ 789 ]
|
|
20
|
+
});
|
|
21
|
+
t.deepEqual(typeof argv.x, 'number');
|
|
22
|
+
t.deepEqual(typeof argv.y, 'number');
|
|
23
|
+
t.deepEqual(typeof argv.z, 'number');
|
|
24
|
+
t.deepEqual(typeof argv.w, 'string');
|
|
25
|
+
t.deepEqual(typeof argv.hex, 'number');
|
|
26
|
+
t.deepEqual(typeof argv._[0], 'number');
|
|
27
|
+
t.end();
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
test('already a number', function (t) {
|
|
31
|
+
var argv = parse([ '-x', 1234, 789 ]);
|
|
32
|
+
t.deepEqual(argv, { x : 1234, _ : [ 789 ] });
|
|
33
|
+
t.deepEqual(typeof argv.x, 'number');
|
|
34
|
+
t.deepEqual(typeof argv._[0], 'number');
|
|
35
|
+
t.end();
|
|
36
|
+
});
|
package/test/parse.js
CHANGED
|
@@ -42,32 +42,6 @@ test('comprehensive', function (t) {
|
|
|
42
42
|
t.end();
|
|
43
43
|
});
|
|
44
44
|
|
|
45
|
-
test('nums', function (t) {
|
|
46
|
-
var argv = parse([
|
|
47
|
-
'-x', '1234',
|
|
48
|
-
'-y', '5.67',
|
|
49
|
-
'-z', '1e7',
|
|
50
|
-
'-w', '10f',
|
|
51
|
-
'--hex', '0xdeadbeef',
|
|
52
|
-
'789'
|
|
53
|
-
]);
|
|
54
|
-
t.deepEqual(argv, {
|
|
55
|
-
x : 1234,
|
|
56
|
-
y : 5.67,
|
|
57
|
-
z : 1e7,
|
|
58
|
-
w : '10f',
|
|
59
|
-
hex : 0xdeadbeef,
|
|
60
|
-
_ : [ 789 ]
|
|
61
|
-
});
|
|
62
|
-
t.deepEqual(typeof argv.x, 'number');
|
|
63
|
-
t.deepEqual(typeof argv.y, 'number');
|
|
64
|
-
t.deepEqual(typeof argv.z, 'number');
|
|
65
|
-
t.deepEqual(typeof argv.w, 'string');
|
|
66
|
-
t.deepEqual(typeof argv.hex, 'number');
|
|
67
|
-
t.deepEqual(typeof argv._[0], 'number');
|
|
68
|
-
t.end();
|
|
69
|
-
});
|
|
70
|
-
|
|
71
45
|
test('flag boolean', function (t) {
|
|
72
46
|
var argv = parse([ '-t', 'moo' ], { boolean: 't' });
|
|
73
47
|
t.deepEqual(argv, { t : true, _ : [ 'moo' ] });
|
|
@@ -92,42 +66,6 @@ test('flag boolean value', function (t) {
|
|
|
92
66
|
t.end();
|
|
93
67
|
});
|
|
94
68
|
|
|
95
|
-
test('flag boolean default false', function (t) {
|
|
96
|
-
var argv = parse(['moo'], {
|
|
97
|
-
boolean: ['t', 'verbose'],
|
|
98
|
-
default: { verbose: false, t: false }
|
|
99
|
-
});
|
|
100
|
-
|
|
101
|
-
t.deepEqual(argv, {
|
|
102
|
-
verbose: false,
|
|
103
|
-
t: false,
|
|
104
|
-
_: ['moo']
|
|
105
|
-
});
|
|
106
|
-
|
|
107
|
-
t.deepEqual(typeof argv.verbose, 'boolean');
|
|
108
|
-
t.deepEqual(typeof argv.t, 'boolean');
|
|
109
|
-
t.end();
|
|
110
|
-
|
|
111
|
-
});
|
|
112
|
-
|
|
113
|
-
test('boolean groups', function (t) {
|
|
114
|
-
var argv = parse([ '-x', '-z', 'one', 'two', 'three' ], {
|
|
115
|
-
boolean: ['x','y','z']
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
t.deepEqual(argv, {
|
|
119
|
-
x : true,
|
|
120
|
-
y : false,
|
|
121
|
-
z : true,
|
|
122
|
-
_ : [ 'one', 'two', 'three' ]
|
|
123
|
-
});
|
|
124
|
-
|
|
125
|
-
t.deepEqual(typeof argv.x, 'boolean');
|
|
126
|
-
t.deepEqual(typeof argv.y, 'boolean');
|
|
127
|
-
t.deepEqual(typeof argv.z, 'boolean');
|
|
128
|
-
t.end();
|
|
129
|
-
});
|
|
130
|
-
|
|
131
69
|
test('newlines in params' , function (t) {
|
|
132
70
|
var args = parse([ '-s', "X\nX" ])
|
|
133
71
|
t.deepEqual(args, { _ : [], s : "X\nX" });
|
|
@@ -162,6 +100,50 @@ test('stringArgs', function (t) {
|
|
|
162
100
|
t.end();
|
|
163
101
|
});
|
|
164
102
|
|
|
103
|
+
test('empty strings', function(t) {
|
|
104
|
+
var s = parse([ '-s' ], { string: 's' }).s;
|
|
105
|
+
t.equal(s, '');
|
|
106
|
+
t.equal(typeof s, 'string');
|
|
107
|
+
|
|
108
|
+
var str = parse([ '--str' ], { string: 'str' }).str;
|
|
109
|
+
t.equal(str, '');
|
|
110
|
+
t.equal(typeof str, 'string');
|
|
111
|
+
|
|
112
|
+
var letters = parse([ '-art' ], {
|
|
113
|
+
string: [ 'a', 't' ]
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
t.equal(letters.a, '');
|
|
117
|
+
t.equal(letters.r, true);
|
|
118
|
+
t.equal(letters.t, '');
|
|
119
|
+
|
|
120
|
+
t.end();
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
test('string and alias', function(t) {
|
|
125
|
+
var x = parse([ '--str', '000123' ], {
|
|
126
|
+
string: 's',
|
|
127
|
+
alias: { s: 'str' }
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
t.equal(x.str, '000123');
|
|
131
|
+
t.equal(typeof x.str, 'string');
|
|
132
|
+
t.equal(x.s, '000123');
|
|
133
|
+
t.equal(typeof x.s, 'string');
|
|
134
|
+
|
|
135
|
+
var y = parse([ '-s', '000123' ], {
|
|
136
|
+
string: 'str',
|
|
137
|
+
alias: { str: 's' }
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
t.equal(y.str, '000123');
|
|
141
|
+
t.equal(typeof y.str, 'string');
|
|
142
|
+
t.equal(y.s, '000123');
|
|
143
|
+
t.equal(typeof y.s, 'string');
|
|
144
|
+
t.end();
|
|
145
|
+
});
|
|
146
|
+
|
|
165
147
|
test('slashBreak', function (t) {
|
|
166
148
|
t.same(
|
|
167
149
|
parse([ '-I/foo/bar/baz' ]),
|
|
@@ -213,85 +195,3 @@ test('nested dotted objects', function (t) {
|
|
|
213
195
|
t.same(argv.beep, { boop : true });
|
|
214
196
|
t.end();
|
|
215
197
|
});
|
|
216
|
-
|
|
217
|
-
test('boolean and alias with chainable api', function (t) {
|
|
218
|
-
var aliased = [ '-h', 'derp' ];
|
|
219
|
-
var regular = [ '--herp', 'derp' ];
|
|
220
|
-
var opts = {
|
|
221
|
-
herp: { alias: 'h', boolean: true }
|
|
222
|
-
};
|
|
223
|
-
var aliasedArgv = parse(aliased, {
|
|
224
|
-
boolean: 'herp',
|
|
225
|
-
alias: { h: 'herp' }
|
|
226
|
-
});
|
|
227
|
-
var propertyArgv = parse(regular, {
|
|
228
|
-
boolean: 'herp',
|
|
229
|
-
alias: { h: 'herp' }
|
|
230
|
-
});
|
|
231
|
-
var expected = {
|
|
232
|
-
herp: true,
|
|
233
|
-
h: true,
|
|
234
|
-
'_': [ 'derp' ]
|
|
235
|
-
};
|
|
236
|
-
|
|
237
|
-
t.same(aliasedArgv, expected);
|
|
238
|
-
t.same(propertyArgv, expected);
|
|
239
|
-
t.end();
|
|
240
|
-
});
|
|
241
|
-
|
|
242
|
-
test('boolean and alias with options hash', function (t) {
|
|
243
|
-
var aliased = [ '-h', 'derp' ];
|
|
244
|
-
var regular = [ '--herp', 'derp' ];
|
|
245
|
-
var opts = {
|
|
246
|
-
alias: { 'h': 'herp' },
|
|
247
|
-
boolean: 'herp'
|
|
248
|
-
};
|
|
249
|
-
var aliasedArgv = parse(aliased, opts);
|
|
250
|
-
var propertyArgv = parse(regular, opts);
|
|
251
|
-
var expected = {
|
|
252
|
-
herp: true,
|
|
253
|
-
h: true,
|
|
254
|
-
'_': [ 'derp' ]
|
|
255
|
-
};
|
|
256
|
-
t.same(aliasedArgv, expected);
|
|
257
|
-
t.same(propertyArgv, expected);
|
|
258
|
-
t.end();
|
|
259
|
-
});
|
|
260
|
-
|
|
261
|
-
test('boolean and alias using explicit true', function (t) {
|
|
262
|
-
var aliased = [ '-h', 'true' ];
|
|
263
|
-
var regular = [ '--herp', 'true' ];
|
|
264
|
-
var opts = {
|
|
265
|
-
alias: { h: 'herp' },
|
|
266
|
-
boolean: 'h'
|
|
267
|
-
};
|
|
268
|
-
var aliasedArgv = parse(aliased, opts);
|
|
269
|
-
var propertyArgv = parse(regular, opts);
|
|
270
|
-
var expected = {
|
|
271
|
-
herp: true,
|
|
272
|
-
h: true,
|
|
273
|
-
'_': [ ]
|
|
274
|
-
};
|
|
275
|
-
|
|
276
|
-
t.same(aliasedArgv, expected);
|
|
277
|
-
t.same(propertyArgv, expected);
|
|
278
|
-
t.end();
|
|
279
|
-
});
|
|
280
|
-
|
|
281
|
-
// regression, see https://github.com/substack/node-optimist/issues/71
|
|
282
|
-
test('boolean and --x=true', function(t) {
|
|
283
|
-
var parsed = parse(['--boool', '--other=true'], {
|
|
284
|
-
boolean: 'boool'
|
|
285
|
-
});
|
|
286
|
-
|
|
287
|
-
t.same(parsed.boool, true);
|
|
288
|
-
t.same(parsed.other, 'true');
|
|
289
|
-
|
|
290
|
-
parsed = parse(['--boool', '--other=false'], {
|
|
291
|
-
boolean: 'boool'
|
|
292
|
-
});
|
|
293
|
-
|
|
294
|
-
t.same(parsed.boool, true);
|
|
295
|
-
t.same(parsed.other, 'false');
|
|
296
|
-
t.end();
|
|
297
|
-
});
|