@oclif/core 2.0.4 → 2.0.6
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.
|
@@ -58,8 +58,8 @@ export type DefaultContext<T> = {
|
|
|
58
58
|
options: T;
|
|
59
59
|
flags: Record<string, string>;
|
|
60
60
|
};
|
|
61
|
-
export type FlagDefault<T, P = CustomOptions> = T | ((context: DefaultContext<OptionFlag<T, P
|
|
62
|
-
export type FlagDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<OptionFlag<T, P
|
|
61
|
+
export type FlagDefault<T, P = CustomOptions> = T | ((context: DefaultContext<P & OptionFlag<T, P>>) => Promise<T>);
|
|
62
|
+
export type FlagDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<P & OptionFlag<T, P>>) => Promise<string | undefined>);
|
|
63
63
|
export type ArgDefault<T, P = CustomOptions> = T | ((context: DefaultContext<Arg<T, P>>) => Promise<T>);
|
|
64
64
|
export type ArgDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<Arg<T, P>>) => Promise<string | undefined>);
|
|
65
65
|
export type FlagRelationship = string | {
|
|
@@ -199,13 +199,13 @@ export type BooleanFlag<T> = FlagProps & BooleanFlagProps & {
|
|
|
199
199
|
parse: (input: boolean, context: Command, opts: FlagProps & BooleanFlagProps) => Promise<T>;
|
|
200
200
|
};
|
|
201
201
|
export type OptionFlagDefaults<T, P = CustomOptions, M = false> = FlagProps & OptionFlagProps & {
|
|
202
|
-
parse: FlagParser<T, string, P
|
|
202
|
+
parse: FlagParser<T, string, P>;
|
|
203
203
|
defaultHelp?: FlagDefaultHelp<T>;
|
|
204
204
|
input: string[];
|
|
205
205
|
default?: M extends true ? FlagDefault<T[] | undefined, P> : FlagDefault<T | undefined, P>;
|
|
206
206
|
};
|
|
207
207
|
export type OptionFlag<T, P = CustomOptions> = FlagProps & OptionFlagProps & {
|
|
208
|
-
parse: FlagParser<T, string, P
|
|
208
|
+
parse: FlagParser<T, string, P>;
|
|
209
209
|
defaultHelp?: FlagDefaultHelp<T, P>;
|
|
210
210
|
input: string[];
|
|
211
211
|
} & ({
|
|
@@ -225,13 +225,13 @@ export type FlagDefinition<T, P = CustomOptions> = {
|
|
|
225
225
|
}) & Partial<OptionFlag<T, P>>): OptionFlag<T[]>;
|
|
226
226
|
(options: P & {
|
|
227
227
|
multiple: true;
|
|
228
|
-
} & Partial<OptionFlag<T>>): OptionFlag<T[] | undefined
|
|
228
|
+
} & Partial<OptionFlag<T>>): OptionFlag<T[] | undefined>;
|
|
229
229
|
(options: P & ({
|
|
230
230
|
required: true;
|
|
231
231
|
} | {
|
|
232
232
|
default: FlagDefault<T>;
|
|
233
|
-
}) & Partial<OptionFlag<T>>): OptionFlag<T
|
|
234
|
-
(options?: P & Partial<OptionFlag<T>>): OptionFlag<T | undefined
|
|
233
|
+
}) & Partial<OptionFlag<T>>): OptionFlag<T>;
|
|
234
|
+
(options?: P & Partial<OptionFlag<T>>): OptionFlag<T | undefined>;
|
|
235
235
|
};
|
|
236
236
|
export type Flag<T> = BooleanFlag<T> | OptionFlag<T>;
|
|
237
237
|
export type Input<TFlags extends FlagOutput, BFlags extends FlagOutput, AFlags extends ArgOutput> = {
|
package/lib/parser/errors.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CLIError } from '../errors';
|
|
2
2
|
import { OptionFlag, Flag } from '../interfaces';
|
|
3
|
-
import { Arg, ArgInput,
|
|
3
|
+
import { Arg, ArgInput, CLIParseErrorOptions } from '../interfaces/parser';
|
|
4
4
|
export { CLIError } from '../errors';
|
|
5
5
|
export type Validation = {
|
|
6
6
|
name: string;
|
|
@@ -47,9 +47,6 @@ export declare class NonExistentFlagsError extends CLIParseError {
|
|
|
47
47
|
export declare class FlagInvalidOptionError extends CLIParseError {
|
|
48
48
|
constructor(flag: OptionFlag<any>, input: string);
|
|
49
49
|
}
|
|
50
|
-
export declare class FailedFlagParseError extends CLIParseError {
|
|
51
|
-
constructor(flag: BooleanFlag<any> | OptionFlag<any>, errMsg: string);
|
|
52
|
-
}
|
|
53
50
|
export declare class ArgInvalidOptionError extends CLIParseError {
|
|
54
51
|
constructor(arg: Arg<any>, input: string);
|
|
55
52
|
}
|
package/lib/parser/errors.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.
|
|
3
|
+
exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredFlagError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
|
|
4
4
|
const errors_1 = require("../errors");
|
|
5
5
|
const help_1 = require("./help");
|
|
6
6
|
const list_1 = require("../cli-ux/list");
|
|
@@ -74,13 +74,6 @@ class FlagInvalidOptionError extends CLIParseError {
|
|
|
74
74
|
}
|
|
75
75
|
}
|
|
76
76
|
exports.FlagInvalidOptionError = FlagInvalidOptionError;
|
|
77
|
-
class FailedFlagParseError extends CLIParseError {
|
|
78
|
-
constructor(flag, errMsg) {
|
|
79
|
-
const message = `Parsing --${flag.name} \n\t${errMsg}`;
|
|
80
|
-
super({ parse: {}, message });
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
exports.FailedFlagParseError = FailedFlagParseError;
|
|
84
77
|
class ArgInvalidOptionError extends CLIParseError {
|
|
85
78
|
constructor(arg, input) {
|
|
86
79
|
const message = `Expected ${input} to be one of: ${arg.options.join(', ')}`;
|
package/lib/parser/parse.js
CHANGED
|
@@ -242,7 +242,8 @@ class Parser {
|
|
|
242
242
|
return flag.parse ? await flag.parse(input, this.context, flag) : input;
|
|
243
243
|
}
|
|
244
244
|
catch (error) {
|
|
245
|
-
|
|
245
|
+
error.message = `Parsing --${flag.name} \n\t${error.message}\nSee more help with --help`;
|
|
246
|
+
throw error;
|
|
246
247
|
}
|
|
247
248
|
}
|
|
248
249
|
_validateOptions(flag, input) {
|