flags 0.1.3 → 0.2.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/README.md +16 -17
- package/dist/flags.cjs +347 -0
- package/dist/flags.cjs.map +1 -0
- package/dist/flags.d.cts +82 -0
- package/dist/flags.d.ts +82 -0
- package/dist/flags.js +311 -0
- package/dist/flags.js.map +1 -0
- package/package.json +37 -19
- package/examples/example.js +0 -34
- package/lib/flags.js +0 -505
- package/lib/flags_test.js +0 -214
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# Node-Flags
|
|
2
2
|
|
|
3
|
-
This is a flags library for use with [node.js](http://nodejs.org/).
|
|
3
|
+
This is a flags library for use with [node.js](http://nodejs.org/). Flag definitions can be distributed across multiple files, as long as they are defined before `flags.parse()` is called.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
Fork the latest source from github, or else use
|
|
7
|
+
Fork the latest source from github, or else use your favorite package manager:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
pnpm install flags
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
import * as flags from 'flags';
|
|
14
14
|
|
|
15
15
|
flags.defineString('name', 'Billy Noone', 'Your name');
|
|
16
16
|
flags.defineInteger('age', 21, 'Your age in whole years');
|
|
@@ -37,10 +37,10 @@ Then on the command line:
|
|
|
37
37
|
|
|
38
38
|
## Passing Flags
|
|
39
39
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
40
|
+
- Flag names should be prefixed with two dashes: e.g. `--flagname`
|
|
41
|
+
- Values can be separated from the name with either an equal sign or a space: e.g. `--flagname=flagvalue` or `--flagname flagvalue`
|
|
42
|
+
- Complex string flags should be quoted: e.g. `--flag="some flag with spaces"`
|
|
43
|
+
- Additional non-flag arguments can be passed by adding `--` before the subsequent args. The remaining args will be returned from `flags.parse()` as an array, e.g. `--one --two -- other stuff here`
|
|
44
44
|
|
|
45
45
|
## Defining Flags
|
|
46
46
|
|
|
@@ -48,16 +48,15 @@ To define flags, use one of the defineX functions exported by the `flags` module
|
|
|
48
48
|
|
|
49
49
|
**flags.defineString** - Takes the raw input from the command line.
|
|
50
50
|
|
|
51
|
-
**flags.defineBoolean** - Usually doesn't take a value, passing --flag will set the corresponding flag to true.
|
|
51
|
+
**flags.defineBoolean** - Usually doesn't take a value, passing --flag will set the corresponding flag to true. Also supported are --noflag to set it to false and --flag=true or --flag=false or --flag=0 or --flag=1 or --flag=f or --flag=t
|
|
52
52
|
|
|
53
|
-
**flags.defineInteger** - Must take a value and will be cast to a Number.
|
|
53
|
+
**flags.defineInteger** - Must take a value and will be cast to a Number. Passing a non-integer arg will throw.
|
|
54
54
|
|
|
55
|
-
**flags.defineNumber** - Must take a value and will be cast to a number.
|
|
55
|
+
**flags.defineNumber** - Must take a value and will be cast to a number. Passing an arg that evaluates to NaN will throw.
|
|
56
56
|
|
|
57
57
|
**flags.defineStringList** - Takes a comma separated argument list and returns an array as it's value.
|
|
58
58
|
|
|
59
|
-
**flags.defineMultiString** - Same as defineString but allows multiple flags to be passed.
|
|
60
|
-
|
|
59
|
+
**flags.defineMultiString** - Same as defineString but allows multiple flags to be passed. All values will be returned in an array.
|
|
61
60
|
|
|
62
61
|
All the define methods take the same arguments:
|
|
63
62
|
|
|
@@ -72,7 +71,7 @@ The methods return a Flag object that exposes the following methods, for additio
|
|
|
72
71
|
`flag.setDefault({*} defaultValue)` - Sets the flag's default value.
|
|
73
72
|
`flag.setDescription({string} description)` - Sets the flag's description field.
|
|
74
73
|
`flag.setValidator({function(string)} validator)` - Sets a function for validating the input, should throw if the input isn't valid.
|
|
75
|
-
`flag.setSecret({boolean} secret)` - If set to true then the flag won't show up in the help text.
|
|
74
|
+
`flag.setSecret({boolean} secret)` - If set to true then the flag won't show up in the help text.
|
|
76
75
|
|
|
77
76
|
These setters return the flag instance so they can be chained:
|
|
78
77
|
|
|
@@ -98,7 +97,7 @@ The flag object also contains the following properties you may be interested in:
|
|
|
98
97
|
|
|
99
98
|
## Testing
|
|
100
99
|
|
|
101
|
-
By default `flags.parse` uses process.argv and slices off the first 2 elements.
|
|
100
|
+
By default `flags.parse` uses process.argv and slices off the first 2 elements. For tests you can pass a predefined set of arguments as an array:
|
|
102
101
|
|
|
103
102
|
flags.parse(['--flag', '--nofood', '--foo=bar']);
|
|
104
103
|
|
|
@@ -108,8 +107,8 @@ If you want to change flags between test cases, you may call:
|
|
|
108
107
|
|
|
109
108
|
## TODOs
|
|
110
109
|
|
|
111
|
-
|
|
112
|
-
|
|
110
|
+
- Support --flagsfile
|
|
111
|
+
- Support multi space separated flags, e.g. --files file1 file2 file3
|
|
113
112
|
|
|
114
113
|
## Licence
|
|
115
114
|
|
package/dist/flags.cjs
ADDED
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
7
|
+
var __export = (target, all) => {
|
|
8
|
+
for (var name in all)
|
|
9
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
10
|
+
};
|
|
11
|
+
var __copyProps = (to, from, except, desc) => {
|
|
12
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
13
|
+
for (let key of __getOwnPropNames(from))
|
|
14
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
15
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
16
|
+
}
|
|
17
|
+
return to;
|
|
18
|
+
};
|
|
19
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
20
|
+
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
21
|
+
|
|
22
|
+
// src/flags.ts
|
|
23
|
+
var flags_exports = {};
|
|
24
|
+
__export(flags_exports, {
|
|
25
|
+
FLAGS: () => FLAGS,
|
|
26
|
+
defineBoolean: () => defineBoolean,
|
|
27
|
+
defineInteger: () => defineInteger,
|
|
28
|
+
defineMultiString: () => defineMultiString,
|
|
29
|
+
defineNumber: () => defineNumber,
|
|
30
|
+
defineString: () => defineString,
|
|
31
|
+
defineStringList: () => defineStringList,
|
|
32
|
+
get: () => get,
|
|
33
|
+
help: () => help,
|
|
34
|
+
isSet: () => isSet,
|
|
35
|
+
parse: () => parse,
|
|
36
|
+
reset: () => reset,
|
|
37
|
+
setExitOnError: () => setExitOnError,
|
|
38
|
+
setUsageInfo: () => setUsageInfo
|
|
39
|
+
});
|
|
40
|
+
module.exports = __toCommonJS(flags_exports);
|
|
41
|
+
if (typeof global.GLOBAL_FLAGS === "undefined") {
|
|
42
|
+
global.GLOBAL_FLAGS = {};
|
|
43
|
+
}
|
|
44
|
+
var FLAGS = global.GLOBAL_FLAGS;
|
|
45
|
+
var exitOnError = true;
|
|
46
|
+
var usageInfo = "Usage: node " + (process.argv[1] || "").split("/").pop() + " [options]";
|
|
47
|
+
function setExitOnError(value) {
|
|
48
|
+
exitOnError = value;
|
|
49
|
+
}
|
|
50
|
+
function setUsageInfo(value) {
|
|
51
|
+
usageInfo = value;
|
|
52
|
+
}
|
|
53
|
+
function defineString(name, defaultValue, description) {
|
|
54
|
+
return addFlag(name, new StringFlag(name, defaultValue, description));
|
|
55
|
+
}
|
|
56
|
+
function defineBoolean(name, defaultValue, description) {
|
|
57
|
+
return addFlag(name, new BooleanFlag(name, defaultValue, description));
|
|
58
|
+
}
|
|
59
|
+
function defineInteger(name, defaultValue, description) {
|
|
60
|
+
return addFlag(name, new IntegerFlag(name, defaultValue, description));
|
|
61
|
+
}
|
|
62
|
+
function defineNumber(name, defaultValue, description) {
|
|
63
|
+
return addFlag(name, new NumberFlag(name, defaultValue, description));
|
|
64
|
+
}
|
|
65
|
+
function defineStringList(name, defaultValue, description) {
|
|
66
|
+
return addFlag(name, new StringListFlag(name, defaultValue, description));
|
|
67
|
+
}
|
|
68
|
+
function defineMultiString(name, defaultValue, description) {
|
|
69
|
+
return addFlag(name, new MultiStringFlag(name, defaultValue, description));
|
|
70
|
+
}
|
|
71
|
+
function help() {
|
|
72
|
+
if (usageInfo) {
|
|
73
|
+
console.log(usageInfo + "\n");
|
|
74
|
+
}
|
|
75
|
+
console.log("Options:");
|
|
76
|
+
for (const flag in FLAGS) {
|
|
77
|
+
if (!FLAGS[flag].isSecret) {
|
|
78
|
+
console.log(FLAGS[flag].toHelpString());
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
function reset() {
|
|
83
|
+
parseCalled = false;
|
|
84
|
+
Object.keys(FLAGS).forEach((key) => delete FLAGS[key]);
|
|
85
|
+
registerInternalFlags();
|
|
86
|
+
}
|
|
87
|
+
function get(name) {
|
|
88
|
+
if (!FLAGS[name]) throw Error('Unknown flag "' + name + '"');
|
|
89
|
+
return FLAGS[name].get();
|
|
90
|
+
}
|
|
91
|
+
function isSet(name) {
|
|
92
|
+
if (!FLAGS[name]) throw Error('Unknown flag "' + name + '"');
|
|
93
|
+
return FLAGS[name].isSet;
|
|
94
|
+
}
|
|
95
|
+
function parse(args = process.argv.slice(2), ignoreUnrecognized) {
|
|
96
|
+
if (parseCalled) return [];
|
|
97
|
+
for (let i = 0; i < args.length; i++) {
|
|
98
|
+
const arg = args[i];
|
|
99
|
+
if (arg == "--") {
|
|
100
|
+
return args.slice(i + 1);
|
|
101
|
+
} else if (arg.startsWith("--")) {
|
|
102
|
+
let flag = arg.slice(2);
|
|
103
|
+
let value = null;
|
|
104
|
+
if (flag.indexOf("=") > -1) {
|
|
105
|
+
const parts = flag.split("=");
|
|
106
|
+
flag = parts[0];
|
|
107
|
+
value = parts.slice(1).join("=");
|
|
108
|
+
}
|
|
109
|
+
if (value == null && args[i + 1] && !args[i + 1].startsWith("--")) {
|
|
110
|
+
args[i] = args[i] + " " + args[i + 1];
|
|
111
|
+
value = args[i + 1];
|
|
112
|
+
args.splice(i + 1, 1);
|
|
113
|
+
}
|
|
114
|
+
if (!FLAGS[flag] && value == null && flag.startsWith("no")) {
|
|
115
|
+
flag = flag.slice(2);
|
|
116
|
+
value = "0";
|
|
117
|
+
}
|
|
118
|
+
if (FLAGS[flag]) {
|
|
119
|
+
try {
|
|
120
|
+
FLAGS[flag].set(value);
|
|
121
|
+
} catch (e) {
|
|
122
|
+
throwFlagParseError(args, i, e.message);
|
|
123
|
+
}
|
|
124
|
+
} else if (!ignoreUnrecognized) {
|
|
125
|
+
throwFlagParseError(args, i, 'Unrecognized flag name "' + arg + '"');
|
|
126
|
+
}
|
|
127
|
+
} else {
|
|
128
|
+
throwFlagParseError(args, i, 'Invalid argument "' + arg + '"');
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
parseCalled = true;
|
|
132
|
+
if (FLAGS.help.get()) {
|
|
133
|
+
help();
|
|
134
|
+
process.exit(0);
|
|
135
|
+
}
|
|
136
|
+
return [];
|
|
137
|
+
}
|
|
138
|
+
var parseCalled = false;
|
|
139
|
+
function throwFlagParseError(args, i, msg) {
|
|
140
|
+
const errorMsg = "FLAG PARSING ERROR: " + msg + "\n " + args.join(" ") + "\n " + new Array(args.slice(0, i).join(" ").length + 2).join(" ") + new Array(args[i].length + 1).join("^");
|
|
141
|
+
if (exitOnError) {
|
|
142
|
+
console.error(errorMsg);
|
|
143
|
+
process.exit(1);
|
|
144
|
+
} else {
|
|
145
|
+
throw Error(errorMsg);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
function addFlag(name, flag) {
|
|
149
|
+
if (parseCalled) throw Error("Can not register new flags after parse()");
|
|
150
|
+
if (FLAGS[name]) throw Error('Flag already defined: "' + name + '"');
|
|
151
|
+
FLAGS[name] = flag;
|
|
152
|
+
return flag;
|
|
153
|
+
}
|
|
154
|
+
function wrapText(text, maxLen) {
|
|
155
|
+
const lines = text.split("\n");
|
|
156
|
+
const out = [];
|
|
157
|
+
lines.forEach((line) => {
|
|
158
|
+
const maxLenx = maxLen + (out.length == 0 ? 4 : 0);
|
|
159
|
+
if (line.length < maxLenx) {
|
|
160
|
+
out.push(line);
|
|
161
|
+
} else {
|
|
162
|
+
const current = wrapLine(line, " ", maxLenx, out);
|
|
163
|
+
if (current != "") {
|
|
164
|
+
out.push(current);
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
});
|
|
168
|
+
return out.join("\n ");
|
|
169
|
+
}
|
|
170
|
+
function wrapLine(line, delimiter, maxLen, out) {
|
|
171
|
+
const parts = line.split(delimiter);
|
|
172
|
+
let current = "";
|
|
173
|
+
parts.forEach((part) => {
|
|
174
|
+
const next = current + part + delimiter;
|
|
175
|
+
if (next.length > maxLen) {
|
|
176
|
+
out.push(current);
|
|
177
|
+
current = part + delimiter;
|
|
178
|
+
} else {
|
|
179
|
+
current = next;
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
return current;
|
|
183
|
+
}
|
|
184
|
+
var Flag = class {
|
|
185
|
+
constructor(name, defaultValue, description) {
|
|
186
|
+
__publicField(this, "name");
|
|
187
|
+
__publicField(this, "defaultValue");
|
|
188
|
+
__publicField(this, "description");
|
|
189
|
+
__publicField(this, "currentValue");
|
|
190
|
+
__publicField(this, "validator");
|
|
191
|
+
__publicField(this, "isSecret");
|
|
192
|
+
__publicField(this, "isSet");
|
|
193
|
+
this.name = name;
|
|
194
|
+
this.defaultValue = defaultValue;
|
|
195
|
+
this.description = description;
|
|
196
|
+
this.currentValue = null;
|
|
197
|
+
this.isSecret = false;
|
|
198
|
+
this.isSet = false;
|
|
199
|
+
}
|
|
200
|
+
setDefault(defaultValue) {
|
|
201
|
+
this.defaultValue = defaultValue;
|
|
202
|
+
return this;
|
|
203
|
+
}
|
|
204
|
+
setDescription(description) {
|
|
205
|
+
this.description = description;
|
|
206
|
+
return this;
|
|
207
|
+
}
|
|
208
|
+
setValidator(validator) {
|
|
209
|
+
this.validator = validator;
|
|
210
|
+
return this;
|
|
211
|
+
}
|
|
212
|
+
setSecret(isSecret) {
|
|
213
|
+
this.isSecret = isSecret;
|
|
214
|
+
return this;
|
|
215
|
+
}
|
|
216
|
+
set(input) {
|
|
217
|
+
if (this.isSet) {
|
|
218
|
+
throw Error("Flag already set");
|
|
219
|
+
}
|
|
220
|
+
if (typeof input === "string") {
|
|
221
|
+
this.currentValue = this.parseInput(input);
|
|
222
|
+
} else if (input === null) {
|
|
223
|
+
this.currentValue = this.parseInput(null);
|
|
224
|
+
} else {
|
|
225
|
+
this.currentValue = input;
|
|
226
|
+
}
|
|
227
|
+
if (this.validator) this.validator(this.currentValue);
|
|
228
|
+
this.isSet = true;
|
|
229
|
+
}
|
|
230
|
+
get() {
|
|
231
|
+
return this.isSet ? this.currentValue : this.defaultValue;
|
|
232
|
+
}
|
|
233
|
+
parseInput(_inp) {
|
|
234
|
+
throw Error("Not implemented");
|
|
235
|
+
}
|
|
236
|
+
toHelpString() {
|
|
237
|
+
return wrapText(" --" + this.name + ": " + this.description, 70) + "\n (default: " + JSON.stringify(this.defaultValue) + ")";
|
|
238
|
+
}
|
|
239
|
+
};
|
|
240
|
+
var BooleanFlag = class extends Flag {
|
|
241
|
+
constructor(name, defaultValue, description) {
|
|
242
|
+
super(name, defaultValue ?? false, description);
|
|
243
|
+
}
|
|
244
|
+
parseInput(inp) {
|
|
245
|
+
if (inp === null) {
|
|
246
|
+
return true;
|
|
247
|
+
}
|
|
248
|
+
inp = inp.toLowerCase();
|
|
249
|
+
if (inp === "1" || inp === "true" || inp == "t") {
|
|
250
|
+
return true;
|
|
251
|
+
} else if (inp === "0" || inp === "false" || inp == "f") {
|
|
252
|
+
return false;
|
|
253
|
+
} else {
|
|
254
|
+
throw Error('Invalid Boolean flag "' + inp + '"');
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
get() {
|
|
258
|
+
return !!super.get();
|
|
259
|
+
}
|
|
260
|
+
toHelpString() {
|
|
261
|
+
return wrapText(" --[no]" + this.name + ": " + this.description, 70) + "\n (default: " + JSON.stringify(this.defaultValue) + ")";
|
|
262
|
+
}
|
|
263
|
+
};
|
|
264
|
+
var IntegerFlag = class extends Flag {
|
|
265
|
+
constructor(name, defaultValue, description) {
|
|
266
|
+
super(name, defaultValue ?? 0, description);
|
|
267
|
+
}
|
|
268
|
+
parseInput(inp) {
|
|
269
|
+
if (isNaN(Number(inp)) || parseInt(inp, 10) !== Number(inp)) {
|
|
270
|
+
throw Error('Invalid Integer flag "' + inp + '"');
|
|
271
|
+
}
|
|
272
|
+
return Number(inp);
|
|
273
|
+
}
|
|
274
|
+
toHelpString() {
|
|
275
|
+
return super.toHelpString() + "\n (an integer)";
|
|
276
|
+
}
|
|
277
|
+
};
|
|
278
|
+
var NumberFlag = class extends Flag {
|
|
279
|
+
constructor(name, defaultValue, description) {
|
|
280
|
+
super(name, defaultValue ?? 0, description);
|
|
281
|
+
}
|
|
282
|
+
parseInput(inp) {
|
|
283
|
+
if (isNaN(Number(inp))) {
|
|
284
|
+
throw Error('Invalid Number flag "' + inp + '"');
|
|
285
|
+
}
|
|
286
|
+
return Number(inp);
|
|
287
|
+
}
|
|
288
|
+
toHelpString() {
|
|
289
|
+
return super.toHelpString() + "\n (a number)";
|
|
290
|
+
}
|
|
291
|
+
};
|
|
292
|
+
var StringFlag = class extends Flag {
|
|
293
|
+
constructor(name, defaultValue, description) {
|
|
294
|
+
super(name, defaultValue ?? "", description);
|
|
295
|
+
}
|
|
296
|
+
parseInput(inp) {
|
|
297
|
+
if (inp === null) {
|
|
298
|
+
throw Error('Invalid String flag "' + inp + '"');
|
|
299
|
+
}
|
|
300
|
+
return inp;
|
|
301
|
+
}
|
|
302
|
+
toHelpString() {
|
|
303
|
+
return super.toHelpString() + "\n (a string)";
|
|
304
|
+
}
|
|
305
|
+
};
|
|
306
|
+
var StringListFlag = class extends Flag {
|
|
307
|
+
constructor(name, defaultValue, description) {
|
|
308
|
+
super(name, defaultValue ?? [], description);
|
|
309
|
+
}
|
|
310
|
+
parseInput(inp) {
|
|
311
|
+
if (inp === null) return [];
|
|
312
|
+
else return inp.split(",");
|
|
313
|
+
}
|
|
314
|
+
};
|
|
315
|
+
var MultiStringFlag = class extends Flag {
|
|
316
|
+
constructor(name, defaultValue, description) {
|
|
317
|
+
super(name, defaultValue ?? [], description);
|
|
318
|
+
}
|
|
319
|
+
set(input) {
|
|
320
|
+
if (this.validator) this.validator(input);
|
|
321
|
+
if (!this.currentValue) this.currentValue = [];
|
|
322
|
+
this.currentValue.push(...input);
|
|
323
|
+
this.isSet = true;
|
|
324
|
+
}
|
|
325
|
+
};
|
|
326
|
+
function registerInternalFlags() {
|
|
327
|
+
defineBoolean("help").setDescription("Shows this help text.").setSecret(true);
|
|
328
|
+
}
|
|
329
|
+
registerInternalFlags();
|
|
330
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
331
|
+
0 && (module.exports = {
|
|
332
|
+
FLAGS,
|
|
333
|
+
defineBoolean,
|
|
334
|
+
defineInteger,
|
|
335
|
+
defineMultiString,
|
|
336
|
+
defineNumber,
|
|
337
|
+
defineString,
|
|
338
|
+
defineStringList,
|
|
339
|
+
get,
|
|
340
|
+
help,
|
|
341
|
+
isSet,
|
|
342
|
+
parse,
|
|
343
|
+
reset,
|
|
344
|
+
setExitOnError,
|
|
345
|
+
setUsageInfo
|
|
346
|
+
});
|
|
347
|
+
//# sourceMappingURL=flags.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/flags.ts"],"sourcesContent":["// Define interfaces for our flag types\ninterface IFlag<T> {\n name: string;\n defaultValue: T;\n description?: string;\n currentValue: T | null;\n validator?: (input: T | null) => boolean;\n isSecret: boolean;\n isSet: boolean;\n setDefault(defaultValue: T): this;\n setDescription(description: string): this;\n setValidator(validator: (input: T | null) => boolean): this;\n setSecret(isSecret: boolean): this;\n set(input: T): void;\n get(): T | null;\n parseInput(inp: string): T | null;\n toHelpString(): string;\n}\n\n// Define the global flags object\ndeclare global {\n var GLOBAL_FLAGS: { [key: string]: IFlag<any> };\n}\n\nif (typeof global.GLOBAL_FLAGS === \"undefined\") {\n global.GLOBAL_FLAGS = {};\n}\n\nconst FLAGS: { [key: string]: IFlag<any> } = global.GLOBAL_FLAGS;\n\n/**\n * An object containing a map of flag objects. If different modules are\n * importing different versions of the library we want them to use the same\n * FLAGS object. This does mean that the flags library needs to be backwards\n * compatible.\n */\nexport { FLAGS };\n\nlet exitOnError = true;\n\nlet usageInfo =\n \"Usage: node \" + (process.argv[1] || \"\").split(\"/\").pop() + \" [options]\";\n\n/**\n * If true, then the process will be nicely exit on a parse error. If false,\n * an Error will be thrown. Set to false in tests.\n */\nexport function setExitOnError(value: boolean) {\n exitOnError = value;\n}\n\n/**\n * Allows an app to add extra usage information that will be shown in the help\n * message, above the flags.\n */\nexport function setUsageInfo(value: string) {\n usageInfo = value;\n}\n\n/**\n * Defines a string flag. e.g. --servername=bob\n */\nexport function defineString(\n name: string,\n defaultValue?: string,\n description?: string\n): IFlag<string> {\n return addFlag(name, new StringFlag(name, defaultValue, description));\n}\n\n/**\n * Defines a boolean flag. e.g. --turnonlights\n */\nexport function defineBoolean(\n name: string,\n defaultValue?: boolean,\n description?: string\n): IFlag<boolean> {\n return addFlag(name, new BooleanFlag(name, defaultValue, description));\n}\n\n/**\n * Defines an integer flag. e.g. --age=12\n */\nexport function defineInteger(\n name: string,\n defaultValue?: number,\n description?: string\n): IFlag<number> {\n return addFlag(name, new IntegerFlag(name, defaultValue, description));\n}\n\n/**\n * Defines a number flag. e.g. --number=1.345\n */\nexport function defineNumber(\n name: string,\n defaultValue?: number,\n description?: string\n): IFlag<number> {\n return addFlag(name, new NumberFlag(name, defaultValue, description));\n}\n\n/**\n * Defines a string list flag. e.g. --anmial=frog,bat,chicken\n */\nexport function defineStringList(\n name: string,\n defaultValue?: string[],\n description?: string\n): IFlag<string[]> {\n return addFlag(name, new StringListFlag(name, defaultValue, description));\n}\n\n/**\n * Defines a multi string flag. e.g. --allowedip=127.0.0.1 --allowedip=127.0.0.2\n */\nexport function defineMultiString(\n name: string,\n defaultValue?: string[],\n description?: string\n): IFlag<string[]> {\n return addFlag(name, new MultiStringFlag(name, defaultValue, description));\n}\n\n/**\n * Dumps the help text to the console.\n */\nexport function help(): void {\n if (usageInfo) {\n console.log(usageInfo + \"\\n\");\n }\n console.log(\"Options:\");\n for (const flag in FLAGS) {\n if (!FLAGS[flag].isSecret) {\n console.log(FLAGS[flag].toHelpString());\n }\n }\n}\n\n/**\n * Resets the flag values.\n */\nexport function reset(): void {\n parseCalled = false;\n Object.keys(FLAGS).forEach((key) => delete FLAGS[key]);\n registerInternalFlags();\n}\n\n/**\n * Gets the current value of the given flag.\n */\nexport function get(name: string): unknown {\n if (!FLAGS[name]) throw Error('Unknown flag \"' + name + '\"');\n return FLAGS[name].get();\n}\n\n/**\n * Gets whether or not the flag was set.\n */\nexport function isSet(name: string): boolean {\n if (!FLAGS[name]) throw Error('Unknown flag \"' + name + '\"');\n return FLAGS[name].isSet;\n}\n\n/**\n * Parses process.argv for flags. Idempotent if called multiple times.\n */\nexport function parse(\n args: string[] = process.argv.slice(2),\n ignoreUnrecognized?: boolean\n): string[] {\n if (parseCalled) return [];\n\n for (let i = 0; i < args.length; i++) {\n const arg = args[i];\n\n if (arg == \"--\") {\n return args.slice(i + 1);\n } else if (arg.startsWith(\"--\")) {\n let flag = arg.slice(2);\n let value: string | null = null;\n if (flag.indexOf(\"=\") > -1) {\n const parts = flag.split(\"=\");\n flag = parts[0];\n value = parts.slice(1).join(\"=\");\n }\n\n if (value == null && args[i + 1] && !args[i + 1].startsWith(\"--\")) {\n args[i] = args[i] + \" \" + args[i + 1];\n value = args[i + 1];\n args.splice(i + 1, 1);\n }\n\n if (!FLAGS[flag] && value == null && flag.startsWith(\"no\")) {\n flag = flag.slice(2);\n value = \"0\";\n }\n\n if (FLAGS[flag]) {\n try {\n FLAGS[flag].set(value);\n } catch (e) {\n throwFlagParseError(args, i, (e as Error).message);\n }\n } else if (!ignoreUnrecognized) {\n throwFlagParseError(args, i, 'Unrecognized flag name \"' + arg + '\"');\n }\n } else {\n throwFlagParseError(args, i, 'Invalid argument \"' + arg + '\"');\n }\n }\n\n parseCalled = true;\n\n if (FLAGS.help.get()) {\n help();\n process.exit(0);\n }\n\n return [];\n}\n\n// Private helpers\nlet parseCalled = false;\n\nfunction throwFlagParseError(args: string[], i: number, msg: string): void {\n const errorMsg =\n \"FLAG PARSING ERROR: \" +\n msg +\n \"\\n \" +\n args.join(\" \") +\n \"\\n \" +\n new Array(args.slice(0, i).join(\" \").length + 2).join(\" \") +\n new Array(args[i].length + 1).join(\"^\");\n\n if (exitOnError) {\n console.error(errorMsg);\n process.exit(1);\n } else {\n throw Error(errorMsg);\n }\n}\n\nfunction addFlag<T>(name: string, flag: IFlag<T>): IFlag<T> {\n if (parseCalled) throw Error(\"Can not register new flags after parse()\");\n if (FLAGS[name]) throw Error('Flag already defined: \"' + name + '\"');\n FLAGS[name] = flag;\n return flag;\n}\n\nfunction wrapText(text: string, maxLen: number): string {\n const lines = text.split(\"\\n\");\n const out: string[] = [];\n lines.forEach((line) => {\n const maxLenx = maxLen + (out.length == 0 ? 4 : 0);\n if (line.length < maxLenx) {\n out.push(line);\n } else {\n const current = wrapLine(line, \" \", maxLenx, out);\n if (current != \"\") {\n out.push(current);\n }\n }\n });\n return out.join(\"\\n \");\n}\n\nfunction wrapLine(\n line: string,\n delimiter: string,\n maxLen: number,\n out: string[]\n): string {\n const parts = line.split(delimiter);\n let current = \"\";\n parts.forEach((part) => {\n const next = current + part + delimiter;\n if (next.length > maxLen) {\n out.push(current);\n current = part + delimiter;\n } else {\n current = next;\n }\n });\n return current;\n}\n\nclass Flag<T> implements IFlag<T> {\n name: string;\n defaultValue: T;\n description?: string;\n currentValue: T | null;\n validator?: (input: T | null) => boolean;\n isSecret: boolean;\n isSet: boolean;\n\n constructor(name: string, defaultValue: T, description?: string) {\n this.name = name;\n this.defaultValue = defaultValue;\n this.description = description;\n this.currentValue = null;\n this.isSecret = false;\n this.isSet = false;\n }\n\n setDefault(defaultValue: T): this {\n this.defaultValue = defaultValue;\n return this;\n }\n\n setDescription(description: string): this {\n this.description = description;\n return this;\n }\n\n setValidator(validator: (input: T | null) => boolean): this {\n this.validator = validator;\n return this;\n }\n\n setSecret(isSecret: boolean): this {\n this.isSecret = isSecret;\n return this;\n }\n\n set(input: T | string): void {\n if (this.isSet) {\n throw Error(\"Flag already set\");\n }\n if (typeof input === \"string\") {\n this.currentValue = this.parseInput(input);\n } else if (input === null) {\n this.currentValue = this.parseInput(null);\n } else {\n this.currentValue = input;\n }\n if (this.validator) this.validator(this.currentValue);\n this.isSet = true;\n }\n\n get(): T | null {\n return this.isSet ? this.currentValue : this.defaultValue;\n }\n\n parseInput(_inp: string | null): T | null {\n throw Error(\"Not implemented\");\n }\n\n toHelpString(): string {\n return (\n wrapText(\" --\" + this.name + \": \" + this.description, 70) +\n \"\\n\" +\n \" (default: \" +\n JSON.stringify(this.defaultValue) +\n \")\"\n );\n }\n}\n\nclass BooleanFlag extends Flag<boolean> implements IFlag<boolean> {\n constructor(name: string, defaultValue?: boolean, description?: string) {\n super(name, defaultValue ?? false, description);\n }\n\n parseInput(inp: string | null): boolean {\n if (inp === null) {\n // Empty flag value means true for a boolean flag.\n return true;\n }\n inp = inp.toLowerCase();\n if (inp === \"1\" || inp === \"true\" || inp == \"t\") {\n return true;\n } else if (inp === \"0\" || inp === \"false\" || inp == \"f\") {\n return false;\n } else {\n throw Error('Invalid Boolean flag \"' + inp + '\"');\n }\n }\n\n get(): boolean {\n return !!super.get();\n }\n\n toHelpString(): string {\n return (\n wrapText(\" --[no]\" + this.name + \": \" + this.description, 70) +\n \"\\n\" +\n \" (default: \" +\n JSON.stringify(this.defaultValue) +\n \")\"\n );\n }\n}\n\nclass IntegerFlag extends Flag<number> implements IFlag<number> {\n constructor(name: string, defaultValue?: number, description?: string) {\n super(name, defaultValue ?? 0, description);\n }\n\n parseInput(inp: string): number {\n if (isNaN(Number(inp)) || parseInt(inp, 10) !== Number(inp)) {\n throw Error('Invalid Integer flag \"' + inp + '\"');\n }\n return Number(inp);\n }\n\n toHelpString(): string {\n return super.toHelpString() + \"\\n (an integer)\";\n }\n}\n\nclass NumberFlag extends Flag<number> implements IFlag<number> {\n constructor(name: string, defaultValue?: number, description?: string) {\n super(name, defaultValue ?? 0, description);\n }\n\n parseInput(inp: string | null): number {\n if (isNaN(Number(inp))) {\n throw Error('Invalid Number flag \"' + inp + '\"');\n }\n return Number(inp);\n }\n\n toHelpString(): string {\n return super.toHelpString() + \"\\n (a number)\";\n }\n}\n\nclass StringFlag extends Flag<string> implements IFlag<string> {\n constructor(name: string, defaultValue?: string, description?: string) {\n super(name, defaultValue ?? \"\", description);\n }\n\n parseInput(inp: string | null): string {\n if (inp === null) {\n throw Error('Invalid String flag \"' + inp + '\"');\n }\n return inp;\n }\n\n toHelpString(): string {\n return super.toHelpString() + \"\\n (a string)\";\n }\n}\n\nclass StringListFlag extends Flag<string[]> implements IFlag<string[]> {\n constructor(name: string, defaultValue?: string[], description?: string) {\n super(name, defaultValue ?? [], description);\n }\n\n parseInput(inp: string | null): string[] {\n if (inp === null) return [];\n else return inp.split(\",\");\n }\n}\n\nclass MultiStringFlag extends Flag<string[]> implements IFlag<string[]> {\n constructor(name: string, defaultValue?: string[], description?: string) {\n super(name, defaultValue ?? [], description);\n }\n\n set(input: string[]): void {\n if (this.validator) this.validator(input);\n if (!this.currentValue) this.currentValue = [];\n this.currentValue.push(...input);\n this.isSet = true;\n }\n}\n\n// Internal flags\nfunction registerInternalFlags(): void {\n defineBoolean(\"help\").setDescription(\"Shows this help text.\").setSecret(true);\n // TODO: --flagsfile\n}\n\nregisterInternalFlags();\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwBA,IAAI,OAAO,OAAO,iBAAiB,aAAa;AAC9C,SAAO,eAAe,CAAC;AACzB;AAEA,IAAM,QAAuC,OAAO;AAUpD,IAAI,cAAc;AAElB,IAAI,YACF,kBAAkB,QAAQ,KAAK,CAAC,KAAK,IAAI,MAAM,GAAG,EAAE,IAAI,IAAI;AAMvD,SAAS,eAAe,OAAgB;AAC7C,gBAAc;AAChB;AAMO,SAAS,aAAa,OAAe;AAC1C,cAAY;AACd;AAKO,SAAS,aACd,MACA,cACA,aACe;AACf,SAAO,QAAQ,MAAM,IAAI,WAAW,MAAM,cAAc,WAAW,CAAC;AACtE;AAKO,SAAS,cACd,MACA,cACA,aACgB;AAChB,SAAO,QAAQ,MAAM,IAAI,YAAY,MAAM,cAAc,WAAW,CAAC;AACvE;AAKO,SAAS,cACd,MACA,cACA,aACe;AACf,SAAO,QAAQ,MAAM,IAAI,YAAY,MAAM,cAAc,WAAW,CAAC;AACvE;AAKO,SAAS,aACd,MACA,cACA,aACe;AACf,SAAO,QAAQ,MAAM,IAAI,WAAW,MAAM,cAAc,WAAW,CAAC;AACtE;AAKO,SAAS,iBACd,MACA,cACA,aACiB;AACjB,SAAO,QAAQ,MAAM,IAAI,eAAe,MAAM,cAAc,WAAW,CAAC;AAC1E;AAKO,SAAS,kBACd,MACA,cACA,aACiB;AACjB,SAAO,QAAQ,MAAM,IAAI,gBAAgB,MAAM,cAAc,WAAW,CAAC;AAC3E;AAKO,SAAS,OAAa;AAC3B,MAAI,WAAW;AACb,YAAQ,IAAI,YAAY,IAAI;AAAA,EAC9B;AACA,UAAQ,IAAI,UAAU;AACtB,aAAW,QAAQ,OAAO;AACxB,QAAI,CAAC,MAAM,IAAI,EAAE,UAAU;AACzB,cAAQ,IAAI,MAAM,IAAI,EAAE,aAAa,CAAC;AAAA,IACxC;AAAA,EACF;AACF;AAKO,SAAS,QAAc;AAC5B,gBAAc;AACd,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ,OAAO,MAAM,GAAG,CAAC;AACrD,wBAAsB;AACxB;AAKO,SAAS,IAAI,MAAuB;AACzC,MAAI,CAAC,MAAM,IAAI,EAAG,OAAM,MAAM,mBAAmB,OAAO,GAAG;AAC3D,SAAO,MAAM,IAAI,EAAE,IAAI;AACzB;AAKO,SAAS,MAAM,MAAuB;AAC3C,MAAI,CAAC,MAAM,IAAI,EAAG,OAAM,MAAM,mBAAmB,OAAO,GAAG;AAC3D,SAAO,MAAM,IAAI,EAAE;AACrB;AAKO,SAAS,MACd,OAAiB,QAAQ,KAAK,MAAM,CAAC,GACrC,oBACU;AACV,MAAI,YAAa,QAAO,CAAC;AAEzB,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,UAAM,MAAM,KAAK,CAAC;AAElB,QAAI,OAAO,MAAM;AACf,aAAO,KAAK,MAAM,IAAI,CAAC;AAAA,IACzB,WAAW,IAAI,WAAW,IAAI,GAAG;AAC/B,UAAI,OAAO,IAAI,MAAM,CAAC;AACtB,UAAI,QAAuB;AAC3B,UAAI,KAAK,QAAQ,GAAG,IAAI,IAAI;AAC1B,cAAM,QAAQ,KAAK,MAAM,GAAG;AAC5B,eAAO,MAAM,CAAC;AACd,gBAAQ,MAAM,MAAM,CAAC,EAAE,KAAK,GAAG;AAAA,MACjC;AAEA,UAAI,SAAS,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,EAAE,WAAW,IAAI,GAAG;AACjE,aAAK,CAAC,IAAI,KAAK,CAAC,IAAI,MAAM,KAAK,IAAI,CAAC;AACpC,gBAAQ,KAAK,IAAI,CAAC;AAClB,aAAK,OAAO,IAAI,GAAG,CAAC;AAAA,MACtB;AAEA,UAAI,CAAC,MAAM,IAAI,KAAK,SAAS,QAAQ,KAAK,WAAW,IAAI,GAAG;AAC1D,eAAO,KAAK,MAAM,CAAC;AACnB,gBAAQ;AAAA,MACV;AAEA,UAAI,MAAM,IAAI,GAAG;AACf,YAAI;AACF,gBAAM,IAAI,EAAE,IAAI,KAAK;AAAA,QACvB,SAAS,GAAG;AACV,8BAAoB,MAAM,GAAI,EAAY,OAAO;AAAA,QACnD;AAAA,MACF,WAAW,CAAC,oBAAoB;AAC9B,4BAAoB,MAAM,GAAG,6BAA6B,MAAM,GAAG;AAAA,MACrE;AAAA,IACF,OAAO;AACL,0BAAoB,MAAM,GAAG,uBAAuB,MAAM,GAAG;AAAA,IAC/D;AAAA,EACF;AAEA,gBAAc;AAEd,MAAI,MAAM,KAAK,IAAI,GAAG;AACpB,SAAK;AACL,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,SAAO,CAAC;AACV;AAGA,IAAI,cAAc;AAElB,SAAS,oBAAoB,MAAgB,GAAW,KAAmB;AACzE,QAAM,WACJ,yBACA,MACA,SACA,KAAK,KAAK,GAAG,IACb,QACA,IAAI,MAAM,KAAK,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,IACzD,IAAI,MAAM,KAAK,CAAC,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG;AAExC,MAAI,aAAa;AACf,YAAQ,MAAM,QAAQ;AACtB,YAAQ,KAAK,CAAC;AAAA,EAChB,OAAO;AACL,UAAM,MAAM,QAAQ;AAAA,EACtB;AACF;AAEA,SAAS,QAAW,MAAc,MAA0B;AAC1D,MAAI,YAAa,OAAM,MAAM,0CAA0C;AACvE,MAAI,MAAM,IAAI,EAAG,OAAM,MAAM,4BAA4B,OAAO,GAAG;AACnE,QAAM,IAAI,IAAI;AACd,SAAO;AACT;AAEA,SAAS,SAAS,MAAc,QAAwB;AACtD,QAAM,QAAQ,KAAK,MAAM,IAAI;AAC7B,QAAM,MAAgB,CAAC;AACvB,QAAM,QAAQ,CAAC,SAAS;AACtB,UAAM,UAAU,UAAU,IAAI,UAAU,IAAI,IAAI;AAChD,QAAI,KAAK,SAAS,SAAS;AACzB,UAAI,KAAK,IAAI;AAAA,IACf,OAAO;AACL,YAAM,UAAU,SAAS,MAAM,KAAK,SAAS,GAAG;AAChD,UAAI,WAAW,IAAI;AACjB,YAAI,KAAK,OAAO;AAAA,MAClB;AAAA,IACF;AAAA,EACF,CAAC;AACD,SAAO,IAAI,KAAK,QAAQ;AAC1B;AAEA,SAAS,SACP,MACA,WACA,QACA,KACQ;AACR,QAAM,QAAQ,KAAK,MAAM,SAAS;AAClC,MAAI,UAAU;AACd,QAAM,QAAQ,CAAC,SAAS;AACtB,UAAM,OAAO,UAAU,OAAO;AAC9B,QAAI,KAAK,SAAS,QAAQ;AACxB,UAAI,KAAK,OAAO;AAChB,gBAAU,OAAO;AAAA,IACnB,OAAO;AACL,gBAAU;AAAA,IACZ;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAEA,IAAM,OAAN,MAAkC;AAAA,EAShC,YAAY,MAAc,cAAiB,aAAsB;AARjE;AACA;AACA;AACA;AACA;AACA;AACA;AAGE,SAAK,OAAO;AACZ,SAAK,eAAe;AACpB,SAAK,cAAc;AACnB,SAAK,eAAe;AACpB,SAAK,WAAW;AAChB,SAAK,QAAQ;AAAA,EACf;AAAA,EAEA,WAAW,cAAuB;AAChC,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,aAA2B;AACxC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,WAA+C;AAC1D,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,UAAyB;AACjC,SAAK,WAAW;AAChB,WAAO;AAAA,EACT;AAAA,EAEA,IAAI,OAAyB;AAC3B,QAAI,KAAK,OAAO;AACd,YAAM,MAAM,kBAAkB;AAAA,IAChC;AACA,QAAI,OAAO,UAAU,UAAU;AAC7B,WAAK,eAAe,KAAK,WAAW,KAAK;AAAA,IAC3C,WAAW,UAAU,MAAM;AACzB,WAAK,eAAe,KAAK,WAAW,IAAI;AAAA,IAC1C,OAAO;AACL,WAAK,eAAe;AAAA,IACtB;AACA,QAAI,KAAK,UAAW,MAAK,UAAU,KAAK,YAAY;AACpD,SAAK,QAAQ;AAAA,EACf;AAAA,EAEA,MAAgB;AACd,WAAO,KAAK,QAAQ,KAAK,eAAe,KAAK;AAAA,EAC/C;AAAA,EAEA,WAAW,MAA+B;AACxC,UAAM,MAAM,iBAAiB;AAAA,EAC/B;AAAA,EAEA,eAAuB;AACrB,WACE,SAAS,SAAS,KAAK,OAAO,OAAO,KAAK,aAAa,EAAE,IACzD,qBAEA,KAAK,UAAU,KAAK,YAAY,IAChC;AAAA,EAEJ;AACF;AAEA,IAAM,cAAN,cAA0B,KAAwC;AAAA,EAChE,YAAY,MAAc,cAAwB,aAAsB;AACtE,UAAM,MAAM,gBAAgB,OAAO,WAAW;AAAA,EAChD;AAAA,EAEA,WAAW,KAA6B;AACtC,QAAI,QAAQ,MAAM;AAEhB,aAAO;AAAA,IACT;AACA,UAAM,IAAI,YAAY;AACtB,QAAI,QAAQ,OAAO,QAAQ,UAAU,OAAO,KAAK;AAC/C,aAAO;AAAA,IACT,WAAW,QAAQ,OAAO,QAAQ,WAAW,OAAO,KAAK;AACvD,aAAO;AAAA,IACT,OAAO;AACL,YAAM,MAAM,2BAA2B,MAAM,GAAG;AAAA,IAClD;AAAA,EACF;AAAA,EAEA,MAAe;AACb,WAAO,CAAC,CAAC,MAAM,IAAI;AAAA,EACrB;AAAA,EAEA,eAAuB;AACrB,WACE,SAAS,aAAa,KAAK,OAAO,OAAO,KAAK,aAAa,EAAE,IAC7D,qBAEA,KAAK,UAAU,KAAK,YAAY,IAChC;AAAA,EAEJ;AACF;AAEA,IAAM,cAAN,cAA0B,KAAsC;AAAA,EAC9D,YAAY,MAAc,cAAuB,aAAsB;AACrE,UAAM,MAAM,gBAAgB,GAAG,WAAW;AAAA,EAC5C;AAAA,EAEA,WAAW,KAAqB;AAC9B,QAAI,MAAM,OAAO,GAAG,CAAC,KAAK,SAAS,KAAK,EAAE,MAAM,OAAO,GAAG,GAAG;AAC3D,YAAM,MAAM,2BAA2B,MAAM,GAAG;AAAA,IAClD;AACA,WAAO,OAAO,GAAG;AAAA,EACnB;AAAA,EAEA,eAAuB;AACrB,WAAO,MAAM,aAAa,IAAI;AAAA,EAChC;AACF;AAEA,IAAM,aAAN,cAAyB,KAAsC;AAAA,EAC7D,YAAY,MAAc,cAAuB,aAAsB;AACrE,UAAM,MAAM,gBAAgB,GAAG,WAAW;AAAA,EAC5C;AAAA,EAEA,WAAW,KAA4B;AACrC,QAAI,MAAM,OAAO,GAAG,CAAC,GAAG;AACtB,YAAM,MAAM,0BAA0B,MAAM,GAAG;AAAA,IACjD;AACA,WAAO,OAAO,GAAG;AAAA,EACnB;AAAA,EAEA,eAAuB;AACrB,WAAO,MAAM,aAAa,IAAI;AAAA,EAChC;AACF;AAEA,IAAM,aAAN,cAAyB,KAAsC;AAAA,EAC7D,YAAY,MAAc,cAAuB,aAAsB;AACrE,UAAM,MAAM,gBAAgB,IAAI,WAAW;AAAA,EAC7C;AAAA,EAEA,WAAW,KAA4B;AACrC,QAAI,QAAQ,MAAM;AAChB,YAAM,MAAM,0BAA0B,MAAM,GAAG;AAAA,IACjD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,eAAuB;AACrB,WAAO,MAAM,aAAa,IAAI;AAAA,EAChC;AACF;AAEA,IAAM,iBAAN,cAA6B,KAA0C;AAAA,EACrE,YAAY,MAAc,cAAyB,aAAsB;AACvE,UAAM,MAAM,gBAAgB,CAAC,GAAG,WAAW;AAAA,EAC7C;AAAA,EAEA,WAAW,KAA8B;AACvC,QAAI,QAAQ,KAAM,QAAO,CAAC;AAAA,QACrB,QAAO,IAAI,MAAM,GAAG;AAAA,EAC3B;AACF;AAEA,IAAM,kBAAN,cAA8B,KAA0C;AAAA,EACtE,YAAY,MAAc,cAAyB,aAAsB;AACvE,UAAM,MAAM,gBAAgB,CAAC,GAAG,WAAW;AAAA,EAC7C;AAAA,EAEA,IAAI,OAAuB;AACzB,QAAI,KAAK,UAAW,MAAK,UAAU,KAAK;AACxC,QAAI,CAAC,KAAK,aAAc,MAAK,eAAe,CAAC;AAC7C,SAAK,aAAa,KAAK,GAAG,KAAK;AAC/B,SAAK,QAAQ;AAAA,EACf;AACF;AAGA,SAAS,wBAA8B;AACrC,gBAAc,MAAM,EAAE,eAAe,uBAAuB,EAAE,UAAU,IAAI;AAE9E;AAEA,sBAAsB;","names":[]}
|
package/dist/flags.d.cts
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
interface IFlag<T> {
|
|
2
|
+
name: string;
|
|
3
|
+
defaultValue: T;
|
|
4
|
+
description?: string;
|
|
5
|
+
currentValue: T | null;
|
|
6
|
+
validator?: (input: T | null) => boolean;
|
|
7
|
+
isSecret: boolean;
|
|
8
|
+
isSet: boolean;
|
|
9
|
+
setDefault(defaultValue: T): this;
|
|
10
|
+
setDescription(description: string): this;
|
|
11
|
+
setValidator(validator: (input: T | null) => boolean): this;
|
|
12
|
+
setSecret(isSecret: boolean): this;
|
|
13
|
+
set(input: T): void;
|
|
14
|
+
get(): T | null;
|
|
15
|
+
parseInput(inp: string): T | null;
|
|
16
|
+
toHelpString(): string;
|
|
17
|
+
}
|
|
18
|
+
declare global {
|
|
19
|
+
var GLOBAL_FLAGS: {
|
|
20
|
+
[key: string]: IFlag<any>;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
declare const FLAGS: {
|
|
24
|
+
[key: string]: IFlag<any>;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* If true, then the process will be nicely exit on a parse error. If false,
|
|
29
|
+
* an Error will be thrown. Set to false in tests.
|
|
30
|
+
*/
|
|
31
|
+
declare function setExitOnError(value: boolean): void;
|
|
32
|
+
/**
|
|
33
|
+
* Allows an app to add extra usage information that will be shown in the help
|
|
34
|
+
* message, above the flags.
|
|
35
|
+
*/
|
|
36
|
+
declare function setUsageInfo(value: string): void;
|
|
37
|
+
/**
|
|
38
|
+
* Defines a string flag. e.g. --servername=bob
|
|
39
|
+
*/
|
|
40
|
+
declare function defineString(name: string, defaultValue?: string, description?: string): IFlag<string>;
|
|
41
|
+
/**
|
|
42
|
+
* Defines a boolean flag. e.g. --turnonlights
|
|
43
|
+
*/
|
|
44
|
+
declare function defineBoolean(name: string, defaultValue?: boolean, description?: string): IFlag<boolean>;
|
|
45
|
+
/**
|
|
46
|
+
* Defines an integer flag. e.g. --age=12
|
|
47
|
+
*/
|
|
48
|
+
declare function defineInteger(name: string, defaultValue?: number, description?: string): IFlag<number>;
|
|
49
|
+
/**
|
|
50
|
+
* Defines a number flag. e.g. --number=1.345
|
|
51
|
+
*/
|
|
52
|
+
declare function defineNumber(name: string, defaultValue?: number, description?: string): IFlag<number>;
|
|
53
|
+
/**
|
|
54
|
+
* Defines a string list flag. e.g. --anmial=frog,bat,chicken
|
|
55
|
+
*/
|
|
56
|
+
declare function defineStringList(name: string, defaultValue?: string[], description?: string): IFlag<string[]>;
|
|
57
|
+
/**
|
|
58
|
+
* Defines a multi string flag. e.g. --allowedip=127.0.0.1 --allowedip=127.0.0.2
|
|
59
|
+
*/
|
|
60
|
+
declare function defineMultiString(name: string, defaultValue?: string[], description?: string): IFlag<string[]>;
|
|
61
|
+
/**
|
|
62
|
+
* Dumps the help text to the console.
|
|
63
|
+
*/
|
|
64
|
+
declare function help(): void;
|
|
65
|
+
/**
|
|
66
|
+
* Resets the flag values.
|
|
67
|
+
*/
|
|
68
|
+
declare function reset(): void;
|
|
69
|
+
/**
|
|
70
|
+
* Gets the current value of the given flag.
|
|
71
|
+
*/
|
|
72
|
+
declare function get(name: string): unknown;
|
|
73
|
+
/**
|
|
74
|
+
* Gets whether or not the flag was set.
|
|
75
|
+
*/
|
|
76
|
+
declare function isSet(name: string): boolean;
|
|
77
|
+
/**
|
|
78
|
+
* Parses process.argv for flags. Idempotent if called multiple times.
|
|
79
|
+
*/
|
|
80
|
+
declare function parse(args?: string[], ignoreUnrecognized?: boolean): string[];
|
|
81
|
+
|
|
82
|
+
export { FLAGS, defineBoolean, defineInteger, defineMultiString, defineNumber, defineString, defineStringList, get, help, isSet, parse, reset, setExitOnError, setUsageInfo };
|
package/dist/flags.d.ts
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
interface IFlag<T> {
|
|
2
|
+
name: string;
|
|
3
|
+
defaultValue: T;
|
|
4
|
+
description?: string;
|
|
5
|
+
currentValue: T | null;
|
|
6
|
+
validator?: (input: T | null) => boolean;
|
|
7
|
+
isSecret: boolean;
|
|
8
|
+
isSet: boolean;
|
|
9
|
+
setDefault(defaultValue: T): this;
|
|
10
|
+
setDescription(description: string): this;
|
|
11
|
+
setValidator(validator: (input: T | null) => boolean): this;
|
|
12
|
+
setSecret(isSecret: boolean): this;
|
|
13
|
+
set(input: T): void;
|
|
14
|
+
get(): T | null;
|
|
15
|
+
parseInput(inp: string): T | null;
|
|
16
|
+
toHelpString(): string;
|
|
17
|
+
}
|
|
18
|
+
declare global {
|
|
19
|
+
var GLOBAL_FLAGS: {
|
|
20
|
+
[key: string]: IFlag<any>;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
declare const FLAGS: {
|
|
24
|
+
[key: string]: IFlag<any>;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* If true, then the process will be nicely exit on a parse error. If false,
|
|
29
|
+
* an Error will be thrown. Set to false in tests.
|
|
30
|
+
*/
|
|
31
|
+
declare function setExitOnError(value: boolean): void;
|
|
32
|
+
/**
|
|
33
|
+
* Allows an app to add extra usage information that will be shown in the help
|
|
34
|
+
* message, above the flags.
|
|
35
|
+
*/
|
|
36
|
+
declare function setUsageInfo(value: string): void;
|
|
37
|
+
/**
|
|
38
|
+
* Defines a string flag. e.g. --servername=bob
|
|
39
|
+
*/
|
|
40
|
+
declare function defineString(name: string, defaultValue?: string, description?: string): IFlag<string>;
|
|
41
|
+
/**
|
|
42
|
+
* Defines a boolean flag. e.g. --turnonlights
|
|
43
|
+
*/
|
|
44
|
+
declare function defineBoolean(name: string, defaultValue?: boolean, description?: string): IFlag<boolean>;
|
|
45
|
+
/**
|
|
46
|
+
* Defines an integer flag. e.g. --age=12
|
|
47
|
+
*/
|
|
48
|
+
declare function defineInteger(name: string, defaultValue?: number, description?: string): IFlag<number>;
|
|
49
|
+
/**
|
|
50
|
+
* Defines a number flag. e.g. --number=1.345
|
|
51
|
+
*/
|
|
52
|
+
declare function defineNumber(name: string, defaultValue?: number, description?: string): IFlag<number>;
|
|
53
|
+
/**
|
|
54
|
+
* Defines a string list flag. e.g. --anmial=frog,bat,chicken
|
|
55
|
+
*/
|
|
56
|
+
declare function defineStringList(name: string, defaultValue?: string[], description?: string): IFlag<string[]>;
|
|
57
|
+
/**
|
|
58
|
+
* Defines a multi string flag. e.g. --allowedip=127.0.0.1 --allowedip=127.0.0.2
|
|
59
|
+
*/
|
|
60
|
+
declare function defineMultiString(name: string, defaultValue?: string[], description?: string): IFlag<string[]>;
|
|
61
|
+
/**
|
|
62
|
+
* Dumps the help text to the console.
|
|
63
|
+
*/
|
|
64
|
+
declare function help(): void;
|
|
65
|
+
/**
|
|
66
|
+
* Resets the flag values.
|
|
67
|
+
*/
|
|
68
|
+
declare function reset(): void;
|
|
69
|
+
/**
|
|
70
|
+
* Gets the current value of the given flag.
|
|
71
|
+
*/
|
|
72
|
+
declare function get(name: string): unknown;
|
|
73
|
+
/**
|
|
74
|
+
* Gets whether or not the flag was set.
|
|
75
|
+
*/
|
|
76
|
+
declare function isSet(name: string): boolean;
|
|
77
|
+
/**
|
|
78
|
+
* Parses process.argv for flags. Idempotent if called multiple times.
|
|
79
|
+
*/
|
|
80
|
+
declare function parse(args?: string[], ignoreUnrecognized?: boolean): string[];
|
|
81
|
+
|
|
82
|
+
export { FLAGS, defineBoolean, defineInteger, defineMultiString, defineNumber, defineString, defineStringList, get, help, isSet, parse, reset, setExitOnError, setUsageInfo };
|