yargs 15.3.1 → 15.4.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.
Files changed (50) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/LICENSE +2 -3
  3. package/README.md +5 -5
  4. package/build/lib/apply-extends.d.ts +2 -0
  5. package/build/lib/apply-extends.js +65 -0
  6. package/build/lib/argsert.d.ts +2 -0
  7. package/build/lib/argsert.js +65 -0
  8. package/build/lib/command.d.ts +64 -0
  9. package/build/lib/command.js +416 -0
  10. package/build/lib/common-types.d.ts +36 -0
  11. package/build/lib/common-types.js +25 -0
  12. package/build/lib/completion-templates.d.ts +2 -0
  13. package/{lib → build/lib}/completion-templates.js +6 -5
  14. package/build/lib/completion.d.ts +21 -0
  15. package/build/lib/completion.js +135 -0
  16. package/build/lib/is-promise.d.ts +1 -0
  17. package/build/lib/is-promise.js +9 -0
  18. package/build/lib/levenshtein.d.ts +1 -0
  19. package/{lib → build/lib}/levenshtein.js +33 -33
  20. package/build/lib/middleware.d.ts +10 -0
  21. package/build/lib/middleware.js +57 -0
  22. package/build/lib/obj-filter.d.ts +1 -0
  23. package/build/lib/obj-filter.js +14 -0
  24. package/build/lib/parse-command.d.ts +11 -0
  25. package/build/lib/parse-command.js +36 -0
  26. package/build/lib/process-argv.d.ts +2 -0
  27. package/build/lib/process-argv.js +31 -0
  28. package/build/lib/usage.d.ts +49 -0
  29. package/build/lib/usage.js +540 -0
  30. package/build/lib/validation.d.ts +34 -0
  31. package/build/lib/validation.js +330 -0
  32. package/build/lib/yargs.d.ts +274 -0
  33. package/build/lib/yargs.js +1190 -0
  34. package/build/lib/yerror.d.ts +4 -0
  35. package/build/lib/yerror.js +11 -0
  36. package/index.js +1 -1
  37. package/locales/ja.json +6 -4
  38. package/package.json +26 -13
  39. package/yargs.js +2 -1291
  40. package/lib/apply-extends.js +0 -67
  41. package/lib/argsert.js +0 -68
  42. package/lib/command.js +0 -462
  43. package/lib/completion.js +0 -132
  44. package/lib/is-promise.js +0 -3
  45. package/lib/middleware.js +0 -64
  46. package/lib/obj-filter.js +0 -11
  47. package/lib/process-argv.js +0 -34
  48. package/lib/usage.js +0 -571
  49. package/lib/validation.js +0 -394
  50. package/lib/yerror.js +0 -11
@@ -0,0 +1,330 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validation = void 0;
4
+ const argsert_1 = require("./argsert");
5
+ const common_types_1 = require("./common-types");
6
+ const levenshtein_1 = require("./levenshtein");
7
+ const obj_filter_1 = require("./obj-filter");
8
+ const specialKeys = ['$0', '--', '_'];
9
+ // validation-type-stuff, missing params,
10
+ // bad implications, custom checks.
11
+ function validation(yargs, usage, y18n) {
12
+ const __ = y18n.__;
13
+ const __n = y18n.__n;
14
+ const self = {};
15
+ // validate appropriate # of non-option
16
+ // arguments were provided, i.e., '_'.
17
+ self.nonOptionCount = function nonOptionCount(argv) {
18
+ const demandedCommands = yargs.getDemandedCommands();
19
+ // don't count currently executing commands
20
+ const _s = argv._.length - yargs.getContext().commands.length;
21
+ if (demandedCommands._ && (_s < demandedCommands._.min || _s > demandedCommands._.max)) {
22
+ if (_s < demandedCommands._.min) {
23
+ if (demandedCommands._.minMsg !== undefined) {
24
+ usage.fail(
25
+ // replace $0 with observed, $1 with expected.
26
+ demandedCommands._.minMsg
27
+ ? demandedCommands._.minMsg.replace(/\$0/g, _s.toString()).replace(/\$1/, demandedCommands._.min.toString())
28
+ : null);
29
+ }
30
+ else {
31
+ usage.fail(__n('Not enough non-option arguments: got %s, need at least %s', 'Not enough non-option arguments: got %s, need at least %s', _s, _s, demandedCommands._.min));
32
+ }
33
+ }
34
+ else if (_s > demandedCommands._.max) {
35
+ if (demandedCommands._.maxMsg !== undefined) {
36
+ usage.fail(
37
+ // replace $0 with observed, $1 with expected.
38
+ demandedCommands._.maxMsg
39
+ ? demandedCommands._.maxMsg.replace(/\$0/g, _s.toString()).replace(/\$1/, demandedCommands._.max.toString())
40
+ : null);
41
+ }
42
+ else {
43
+ usage.fail(__n('Too many non-option arguments: got %s, maximum of %s', 'Too many non-option arguments: got %s, maximum of %s', _s, _s, demandedCommands._.max));
44
+ }
45
+ }
46
+ }
47
+ };
48
+ // validate the appropriate # of <required>
49
+ // positional arguments were provided:
50
+ self.positionalCount = function positionalCount(required, observed) {
51
+ if (observed < required) {
52
+ usage.fail(__n('Not enough non-option arguments: got %s, need at least %s', 'Not enough non-option arguments: got %s, need at least %s', observed, observed, required));
53
+ }
54
+ };
55
+ // make sure all the required arguments are present.
56
+ self.requiredArguments = function requiredArguments(argv) {
57
+ const demandedOptions = yargs.getDemandedOptions();
58
+ let missing = null;
59
+ for (const key of Object.keys(demandedOptions)) {
60
+ if (!Object.prototype.hasOwnProperty.call(argv, key) || typeof argv[key] === 'undefined') {
61
+ missing = missing || {};
62
+ missing[key] = demandedOptions[key];
63
+ }
64
+ }
65
+ if (missing) {
66
+ const customMsgs = [];
67
+ for (const key of Object.keys(missing)) {
68
+ const msg = missing[key];
69
+ if (msg && customMsgs.indexOf(msg) < 0) {
70
+ customMsgs.push(msg);
71
+ }
72
+ }
73
+ const customMsg = customMsgs.length ? `\n${customMsgs.join('\n')}` : '';
74
+ usage.fail(__n('Missing required argument: %s', 'Missing required arguments: %s', Object.keys(missing).length, Object.keys(missing).join(', ') + customMsg));
75
+ }
76
+ };
77
+ // check for unknown arguments (strict-mode).
78
+ self.unknownArguments = function unknownArguments(argv, aliases, positionalMap, isDefaultCommand) {
79
+ const commandKeys = yargs.getCommandInstance().getCommands();
80
+ const unknown = [];
81
+ const currentContext = yargs.getContext();
82
+ Object.keys(argv).forEach((key) => {
83
+ if (specialKeys.indexOf(key) === -1 &&
84
+ !Object.prototype.hasOwnProperty.call(positionalMap, key) &&
85
+ !Object.prototype.hasOwnProperty.call(yargs._getParseContext(), key) &&
86
+ !self.isValidAndSomeAliasIsNotNew(key, aliases)) {
87
+ unknown.push(key);
88
+ }
89
+ });
90
+ if ((currentContext.commands.length > 0) || (commandKeys.length > 0) || isDefaultCommand) {
91
+ argv._.slice(currentContext.commands.length).forEach((key) => {
92
+ if (commandKeys.indexOf(key) === -1) {
93
+ unknown.push(key);
94
+ }
95
+ });
96
+ }
97
+ if (unknown.length > 0) {
98
+ usage.fail(__n('Unknown argument: %s', 'Unknown arguments: %s', unknown.length, unknown.join(', ')));
99
+ }
100
+ };
101
+ self.unknownCommands = function unknownCommands(argv) {
102
+ const commandKeys = yargs.getCommandInstance().getCommands();
103
+ const unknown = [];
104
+ const currentContext = yargs.getContext();
105
+ if ((currentContext.commands.length > 0) || (commandKeys.length > 0)) {
106
+ argv._.slice(currentContext.commands.length).forEach((key) => {
107
+ if (commandKeys.indexOf(key) === -1) {
108
+ unknown.push(key);
109
+ }
110
+ });
111
+ }
112
+ if (unknown.length > 0) {
113
+ usage.fail(__n('Unknown command: %s', 'Unknown commands: %s', unknown.length, unknown.join(', ')));
114
+ return true;
115
+ }
116
+ else {
117
+ return false;
118
+ }
119
+ };
120
+ // check for a key that is not an alias, or for which every alias is new,
121
+ // implying that it was invented by the parser, e.g., during camelization
122
+ self.isValidAndSomeAliasIsNotNew = function isValidAndSomeAliasIsNotNew(key, aliases) {
123
+ if (!Object.prototype.hasOwnProperty.call(aliases, key)) {
124
+ return false;
125
+ }
126
+ const newAliases = yargs.parsed.newAliases;
127
+ for (const a of [key, ...aliases[key]]) {
128
+ if (!Object.prototype.hasOwnProperty.call(newAliases, a) || !newAliases[key]) {
129
+ return true;
130
+ }
131
+ }
132
+ return false;
133
+ };
134
+ // validate arguments limited to enumerated choices
135
+ self.limitedChoices = function limitedChoices(argv) {
136
+ const options = yargs.getOptions();
137
+ const invalid = {};
138
+ if (!Object.keys(options.choices).length)
139
+ return;
140
+ Object.keys(argv).forEach((key) => {
141
+ if (specialKeys.indexOf(key) === -1 &&
142
+ Object.prototype.hasOwnProperty.call(options.choices, key)) {
143
+ [].concat(argv[key]).forEach((value) => {
144
+ // TODO case-insensitive configurability
145
+ if (options.choices[key].indexOf(value) === -1 &&
146
+ value !== undefined) {
147
+ invalid[key] = (invalid[key] || []).concat(value);
148
+ }
149
+ });
150
+ }
151
+ });
152
+ const invalidKeys = Object.keys(invalid);
153
+ if (!invalidKeys.length)
154
+ return;
155
+ let msg = __('Invalid values:');
156
+ invalidKeys.forEach((key) => {
157
+ msg += `\n ${__('Argument: %s, Given: %s, Choices: %s', key, usage.stringifiedValues(invalid[key]), usage.stringifiedValues(options.choices[key]))}`;
158
+ });
159
+ usage.fail(msg);
160
+ };
161
+ // custom checks, added using the `check` option on yargs.
162
+ let checks = [];
163
+ self.check = function check(f, global) {
164
+ checks.push({
165
+ func: f,
166
+ global
167
+ });
168
+ };
169
+ self.customChecks = function customChecks(argv, aliases) {
170
+ for (let i = 0, f; (f = checks[i]) !== undefined; i++) {
171
+ const func = f.func;
172
+ let result = null;
173
+ try {
174
+ result = func(argv, aliases);
175
+ }
176
+ catch (err) {
177
+ usage.fail(err.message ? err.message : err, err);
178
+ continue;
179
+ }
180
+ if (!result) {
181
+ usage.fail(__('Argument check failed: %s', func.toString()));
182
+ }
183
+ else if (typeof result === 'string' || result instanceof Error) {
184
+ usage.fail(result.toString(), result);
185
+ }
186
+ }
187
+ };
188
+ // check implications, argument foo implies => argument bar.
189
+ let implied = {};
190
+ self.implies = function implies(key, value) {
191
+ argsert_1.argsert('<string|object> [array|number|string]', [key, value], arguments.length);
192
+ if (typeof key === 'object') {
193
+ Object.keys(key).forEach((k) => {
194
+ self.implies(k, key[k]);
195
+ });
196
+ }
197
+ else {
198
+ yargs.global(key);
199
+ if (!implied[key]) {
200
+ implied[key] = [];
201
+ }
202
+ if (Array.isArray(value)) {
203
+ value.forEach((i) => self.implies(key, i));
204
+ }
205
+ else {
206
+ common_types_1.assertNotStrictEqual(value, undefined);
207
+ implied[key].push(value);
208
+ }
209
+ }
210
+ };
211
+ self.getImplied = function getImplied() {
212
+ return implied;
213
+ };
214
+ function keyExists(argv, val) {
215
+ // convert string '1' to number 1
216
+ const num = Number(val);
217
+ val = isNaN(num) ? val : num;
218
+ if (typeof val === 'number') {
219
+ // check length of argv._
220
+ val = argv._.length >= val;
221
+ }
222
+ else if (val.match(/^--no-.+/)) {
223
+ // check if key/value doesn't exist
224
+ val = val.match(/^--no-(.+)/)[1];
225
+ val = !argv[val];
226
+ }
227
+ else {
228
+ // check if key/value exists
229
+ val = argv[val];
230
+ }
231
+ return val;
232
+ }
233
+ self.implications = function implications(argv) {
234
+ const implyFail = [];
235
+ Object.keys(implied).forEach((key) => {
236
+ const origKey = key;
237
+ (implied[key] || []).forEach((value) => {
238
+ let key = origKey;
239
+ const origValue = value;
240
+ key = keyExists(argv, key);
241
+ value = keyExists(argv, value);
242
+ if (key && !value) {
243
+ implyFail.push(` ${origKey} -> ${origValue}`);
244
+ }
245
+ });
246
+ });
247
+ if (implyFail.length) {
248
+ let msg = `${__('Implications failed:')}\n`;
249
+ implyFail.forEach((value) => {
250
+ msg += (value);
251
+ });
252
+ usage.fail(msg);
253
+ }
254
+ };
255
+ let conflicting = {};
256
+ self.conflicts = function conflicts(key, value) {
257
+ argsert_1.argsert('<string|object> [array|string]', [key, value], arguments.length);
258
+ if (typeof key === 'object') {
259
+ Object.keys(key).forEach((k) => {
260
+ self.conflicts(k, key[k]);
261
+ });
262
+ }
263
+ else {
264
+ yargs.global(key);
265
+ if (!conflicting[key]) {
266
+ conflicting[key] = [];
267
+ }
268
+ if (Array.isArray(value)) {
269
+ value.forEach((i) => self.conflicts(key, i));
270
+ }
271
+ else {
272
+ conflicting[key].push(value);
273
+ }
274
+ }
275
+ };
276
+ self.getConflicting = () => conflicting;
277
+ self.conflicting = function conflictingFn(argv) {
278
+ Object.keys(argv).forEach((key) => {
279
+ if (conflicting[key]) {
280
+ conflicting[key].forEach((value) => {
281
+ // we default keys to 'undefined' that have been configured, we should not
282
+ // apply conflicting check unless they are a value other than 'undefined'.
283
+ if (value && argv[key] !== undefined && argv[value] !== undefined) {
284
+ usage.fail(__('Arguments %s and %s are mutually exclusive', key, value));
285
+ }
286
+ });
287
+ }
288
+ });
289
+ };
290
+ self.recommendCommands = function recommendCommands(cmd, potentialCommands) {
291
+ const threshold = 3; // if it takes more than three edits, let's move on.
292
+ potentialCommands = potentialCommands.sort((a, b) => b.length - a.length);
293
+ let recommended = null;
294
+ let bestDistance = Infinity;
295
+ for (let i = 0, candidate; (candidate = potentialCommands[i]) !== undefined; i++) {
296
+ const d = levenshtein_1.levenshtein(cmd, candidate);
297
+ if (d <= threshold && d < bestDistance) {
298
+ bestDistance = d;
299
+ recommended = candidate;
300
+ }
301
+ }
302
+ if (recommended)
303
+ usage.fail(__('Did you mean %s?', recommended));
304
+ };
305
+ self.reset = function reset(localLookup) {
306
+ implied = obj_filter_1.objFilter(implied, k => !localLookup[k]);
307
+ conflicting = obj_filter_1.objFilter(conflicting, k => !localLookup[k]);
308
+ checks = checks.filter(c => c.global);
309
+ return self;
310
+ };
311
+ const frozens = [];
312
+ self.freeze = function freeze() {
313
+ frozens.push({
314
+ implied,
315
+ checks,
316
+ conflicting
317
+ });
318
+ };
319
+ self.unfreeze = function unfreeze() {
320
+ const frozen = frozens.pop();
321
+ common_types_1.assertNotStrictEqual(frozen, undefined);
322
+ ({
323
+ implied,
324
+ checks,
325
+ conflicting
326
+ } = frozen);
327
+ };
328
+ return self;
329
+ }
330
+ exports.validation = validation;
@@ -0,0 +1,274 @@
1
+ /// <reference types="node" />
2
+ import { CommandInstance, CommandHandler, CommandBuilderDefinition, CommandBuilder, CommandHandlerCallback, FinishCommandHandler } from './command';
3
+ import { Dictionary } from './common-types';
4
+ import { Arguments as ParserArguments, DetailedArguments as ParserDetailedArguments, Configuration as ParserConfiguration, Options as ParserOptions, ConfigCallback, CoerceCallback } from 'yargs-parser';
5
+ import { YError } from './yerror';
6
+ import { UsageInstance, FailureFunction } from './usage';
7
+ import { CompletionFunction } from './completion';
8
+ import { ValidationInstance, KeyOrPos } from './validation';
9
+ import { Y18N } from 'y18n';
10
+ import { MiddlewareCallback, Middleware } from './middleware';
11
+ import { RequireDirectoryOptions } from 'require-directory';
12
+ export declare function Yargs(processArgs?: string | string[], cwd?: string, parentRequire?: NodeRequire): YargsInstance;
13
+ export declare function rebase(base: string, dir: string): string;
14
+ /** Instance of the yargs module. */
15
+ export interface YargsInstance {
16
+ $0: string;
17
+ argv: Arguments;
18
+ customScriptName: boolean;
19
+ parsed: DetailedArguments | false;
20
+ _copyDoubleDash<T extends Arguments | Promise<Arguments>>(argv: T): T;
21
+ _getLoggerInstance(): LoggerInstance;
22
+ _getParseContext(): Object;
23
+ _hasOutput(): boolean;
24
+ _hasParseCallback(): boolean;
25
+ _parseArgs: {
26
+ (args: null, shortCircuit: null, _calledFromCommand: boolean, commandIndex?: number): Arguments | Promise<Arguments>;
27
+ (args: string | string[], shortCircuit?: boolean): Arguments | Promise<Arguments>;
28
+ };
29
+ _runValidation(argv: Arguments, aliases: Dictionary<string[]>, positionalMap: Dictionary<string[]>, parseErrors: Error | null, isDefaultCommand?: boolean): void;
30
+ _setHasOutput(): void;
31
+ addHelpOpt: {
32
+ (opt?: string | false): YargsInstance;
33
+ (opt?: string, msg?: string): YargsInstance;
34
+ };
35
+ addShowHiddenOpt: {
36
+ (opt?: string | false): YargsInstance;
37
+ (opt?: string, msg?: string): YargsInstance;
38
+ };
39
+ alias: {
40
+ (keys: string | string[], aliases: string | string[]): YargsInstance;
41
+ (keyAliases: Dictionary<string | string[]>): YargsInstance;
42
+ };
43
+ array(keys: string | string[]): YargsInstance;
44
+ boolean(keys: string | string[]): YargsInstance;
45
+ check(f: (argv: Arguments, aliases: Dictionary<string[]>) => any, _global?: boolean): YargsInstance;
46
+ choices: {
47
+ (keys: string | string[], choices: string | string[]): YargsInstance;
48
+ (keyChoices: Dictionary<string | string[]>): YargsInstance;
49
+ };
50
+ coerce: {
51
+ (keys: string | string[], coerceCallback: CoerceCallback): YargsInstance;
52
+ (keyCoerceCallbacks: Dictionary<CoerceCallback>): YargsInstance;
53
+ };
54
+ command(cmd: string | string[], description: CommandHandler['description'], builder?: CommandBuilderDefinition | CommandBuilder, handler?: CommandHandlerCallback, commandMiddleware?: Middleware[], deprecated?: boolean): YargsInstance;
55
+ commandDir(dir: string, opts?: RequireDirectoryOptions<any>): YargsInstance;
56
+ completion: {
57
+ (cmd?: string, fn?: CompletionFunction): YargsInstance;
58
+ (cmd?: string, desc?: string | false, fn?: CompletionFunction): YargsInstance;
59
+ };
60
+ config: {
61
+ (config: Dictionary): YargsInstance;
62
+ (keys?: string | string[], configCallback?: ConfigCallback): YargsInstance;
63
+ (keys?: string | string[], msg?: string, configCallback?: ConfigCallback): YargsInstance;
64
+ };
65
+ conflicts: {
66
+ (key: string, conflictsWith: string | string[]): YargsInstance;
67
+ (keyConflicts: Dictionary<string | string[]>): YargsInstance;
68
+ };
69
+ count(keys: string | string[]): YargsInstance;
70
+ default: {
71
+ (key: string, value: any, defaultDescription?: string): YargsInstance;
72
+ (keys: string[], value: Exclude<any, Function>): YargsInstance;
73
+ (keys: Dictionary<any>): YargsInstance;
74
+ };
75
+ defaults: YargsInstance['default'];
76
+ demand: {
77
+ (min: number, max?: number | string, msg?: string): YargsInstance;
78
+ (keys: string | string[], msg?: string | true): YargsInstance;
79
+ (keys: string | string[], max: string[], msg?: string | true): YargsInstance;
80
+ (keyMsgs: Dictionary<string | undefined>): YargsInstance;
81
+ (keyMsgs: Dictionary<string | undefined>, max: string[], msg?: string): YargsInstance;
82
+ };
83
+ demandCommand(): YargsInstance;
84
+ demandCommand(min: number, minMsg?: string): YargsInstance;
85
+ demandCommand(min: number, max: number, minMsg?: string | null, maxMsg?: string | null): YargsInstance;
86
+ demandOption: {
87
+ (keys: string | string[], msg?: string): YargsInstance;
88
+ (keyMsgs: Dictionary<string | undefined>): YargsInstance;
89
+ };
90
+ deprecateOption(option: string, message?: string | boolean): YargsInstance;
91
+ describe: {
92
+ (keys: string | string[], description?: string): YargsInstance;
93
+ (keyDescriptions: Dictionary<string>): YargsInstance;
94
+ };
95
+ detectLocale(detect: boolean): YargsInstance;
96
+ env(prefix?: string | false): YargsInstance;
97
+ epilog: YargsInstance['epilogue'];
98
+ epilogue(msg: string): YargsInstance;
99
+ example(cmd: string | [string, string?][], description?: string): YargsInstance;
100
+ exit(code: number, err?: YError | string): void;
101
+ exitProcess(enabled: boolean): YargsInstance;
102
+ fail(f: FailureFunction): YargsInstance;
103
+ getCommandInstance(): CommandInstance;
104
+ getCompletion(args: string[], done: (completions: string[]) => any): void;
105
+ getContext(): Context;
106
+ getDemandedCommands(): Options['demandedCommands'];
107
+ getDemandedOptions(): Options['demandedOptions'];
108
+ getDeprecatedOptions(): Options['deprecatedOptions'];
109
+ getDetectLocale(): boolean;
110
+ getExitProcess(): boolean;
111
+ getGroups(): Dictionary<string[]>;
112
+ getHandlerFinishCommand(): FinishCommandHandler | null;
113
+ getOptions(): Options;
114
+ getParserConfiguration(): Configuration;
115
+ getStrict(): boolean;
116
+ getStrictCommands(): boolean;
117
+ getUsageInstance(): UsageInstance;
118
+ getValidationInstance(): ValidationInstance;
119
+ global(keys: string | string[], global?: boolean): YargsInstance;
120
+ group(keys: string | string[], groupName: string): YargsInstance;
121
+ help: YargsInstance['addHelpOpt'];
122
+ hide(key: string): YargsInstance;
123
+ implies: {
124
+ (key: string, implication: KeyOrPos | KeyOrPos[]): YargsInstance;
125
+ (keyImplications: Dictionary<KeyOrPos | KeyOrPos[]>): YargsInstance;
126
+ };
127
+ locale: {
128
+ (): string;
129
+ (locale: string): YargsInstance;
130
+ };
131
+ middleware(callback: MiddlewareCallback | MiddlewareCallback[], applyBeforeValidation?: boolean): YargsInstance;
132
+ nargs: {
133
+ (keys: string | string[], nargs: number): YargsInstance;
134
+ (keyNargs: Dictionary<number>): YargsInstance;
135
+ };
136
+ normalize(keys: string | string[]): YargsInstance;
137
+ number(keys: string | string[]): YargsInstance;
138
+ onFinishCommand(f: FinishCommandHandler): YargsInstance;
139
+ option: {
140
+ (key: string, optionDefinition: OptionDefinition): YargsInstance;
141
+ (keyOptionDefinitions: Dictionary<OptionDefinition>): YargsInstance;
142
+ };
143
+ options: YargsInstance['option'];
144
+ parse: {
145
+ (): Arguments | Promise<Arguments>;
146
+ (args: string | string[], context: object, parseCallback?: ParseCallback): Arguments | Promise<Arguments>;
147
+ (args: string | string[], parseCallback: ParseCallback): Arguments | Promise<Arguments>;
148
+ (args: string | string[], shortCircuit: boolean): Arguments | Promise<Arguments>;
149
+ };
150
+ parserConfiguration(config: Configuration): YargsInstance;
151
+ pkgConf(key: string, rootPath?: string): YargsInstance;
152
+ positional(key: string, positionalDefinition: PositionalDefinition): YargsInstance;
153
+ recommendCommands(recommend: boolean): YargsInstance;
154
+ require: YargsInstance['demand'];
155
+ required: YargsInstance['demand'];
156
+ requiresArg(keys: string | string[] | Dictionary): YargsInstance;
157
+ reset(aliases?: DetailedArguments['aliases']): YargsInstance;
158
+ resetOptions(aliases?: DetailedArguments['aliases']): YargsInstance;
159
+ scriptName(scriptName: string): YargsInstance;
160
+ showCompletionScript($0?: string, cmd?: string): YargsInstance;
161
+ showHelp(level: 'error' | 'log' | ((message: string) => void)): YargsInstance;
162
+ showHelpOnFail: {
163
+ (message?: string): YargsInstance;
164
+ (enabled: boolean, message: string): YargsInstance;
165
+ };
166
+ showHidden: YargsInstance['addShowHiddenOpt'];
167
+ skipValidation(keys: string | string[]): YargsInstance;
168
+ strict(enable?: boolean): YargsInstance;
169
+ strictCommands(enable?: boolean): YargsInstance;
170
+ string(key: string | string[]): YargsInstance;
171
+ terminalWidth(): number | null;
172
+ updateStrings(obj: Dictionary<string>): YargsInstance;
173
+ updateLocale: YargsInstance['updateStrings'];
174
+ usage: {
175
+ (msg: string | null): YargsInstance;
176
+ (msg: string, description: CommandHandler['description'], builder?: CommandBuilderDefinition | CommandBuilder, handler?: CommandHandlerCallback): YargsInstance;
177
+ };
178
+ version: {
179
+ (ver?: string | false): YargsInstance;
180
+ (key?: string, ver?: string): YargsInstance;
181
+ (key?: string, msg?: string, ver?: string): YargsInstance;
182
+ };
183
+ wrap(cols: number | null | undefined): YargsInstance;
184
+ }
185
+ export declare function isYargsInstance(y: YargsInstance | void): y is YargsInstance;
186
+ /** Yargs' context. */
187
+ export interface Context {
188
+ commands: string[];
189
+ files: string[];
190
+ fullCommands: string[];
191
+ }
192
+ declare type LoggerInstance = Pick<Console, 'error' | 'log'>;
193
+ export interface Options extends ParserOptions {
194
+ __: Y18N['__'];
195
+ alias: Dictionary<string[]>;
196
+ array: string[];
197
+ boolean: string[];
198
+ choices: Dictionary<string[]>;
199
+ config: Dictionary<ConfigCallback | boolean>;
200
+ configObjects: Dictionary[];
201
+ configuration: Configuration;
202
+ count: string[];
203
+ defaultDescription: Dictionary<string | undefined>;
204
+ demandedCommands: Dictionary<{
205
+ min: number;
206
+ max: number;
207
+ minMsg?: string | null;
208
+ maxMsg?: string | null;
209
+ }>;
210
+ demandedOptions: Dictionary<string | undefined>;
211
+ deprecatedOptions: Dictionary<string | boolean | undefined>;
212
+ hiddenOptions: string[];
213
+ /** Manually set keys */
214
+ key: Dictionary<boolean | string>;
215
+ local: string[];
216
+ normalize: string[];
217
+ number: string[];
218
+ showHiddenOpt: string;
219
+ skipValidation: string[];
220
+ string: string[];
221
+ }
222
+ export interface Configuration extends Partial<ParserConfiguration> {
223
+ /** Should a config object be deep-merged with the object config it extends? */
224
+ 'deep-merge-config'?: boolean;
225
+ /** Should commands be sorted in help? */
226
+ 'sort-commands'?: boolean;
227
+ }
228
+ export interface OptionDefinition {
229
+ alias?: string | string[];
230
+ array?: boolean;
231
+ boolean?: boolean;
232
+ choices?: string | string[];
233
+ coerce?: CoerceCallback;
234
+ config?: boolean;
235
+ configParser?: ConfigCallback;
236
+ conflicts?: string | string[];
237
+ count?: boolean;
238
+ default?: any;
239
+ defaultDescription?: string;
240
+ deprecate?: string | boolean;
241
+ deprecated?: OptionDefinition['deprecate'];
242
+ desc?: string;
243
+ describe?: OptionDefinition['desc'];
244
+ description?: OptionDefinition['desc'];
245
+ demand?: string | true;
246
+ demandOption?: OptionDefinition['demand'];
247
+ global?: boolean;
248
+ group?: string;
249
+ hidden?: boolean;
250
+ implies?: string | number | KeyOrPos[];
251
+ nargs?: number;
252
+ normalize?: boolean;
253
+ number?: boolean;
254
+ require?: OptionDefinition['demand'];
255
+ required?: OptionDefinition['demand'];
256
+ requiresArg?: boolean;
257
+ skipValidation?: boolean;
258
+ string?: boolean;
259
+ type?: 'array' | 'boolean' | 'count' | 'number' | 'string';
260
+ }
261
+ interface PositionalDefinition extends Pick<OptionDefinition, 'alias' | 'array' | 'coerce' | 'choices' | 'conflicts' | 'default' | 'defaultDescription' | 'demand' | 'desc' | 'describe' | 'description' | 'implies' | 'normalize'> {
262
+ type?: 'boolean' | 'number' | 'string';
263
+ }
264
+ interface ParseCallback {
265
+ (err: YError | string | undefined | null, argv: Arguments | Promise<Arguments>, output: string): void;
266
+ }
267
+ export interface Arguments extends ParserArguments {
268
+ /** The script name or node command */
269
+ $0: string;
270
+ }
271
+ export interface DetailedArguments extends ParserDetailedArguments {
272
+ argv: Arguments;
273
+ }
274
+ export {};