@oclif/core 2.0.5 → 2.0.7

package/lib/interfaces/parser.d.ts

@@ -58,8 +58,8 @@ export type DefaultContext<T> = {
     options: T;
     flags: Record<string, string>;
 };
-export type FlagDefault<T, P = CustomOptions> = T | ((context: DefaultContext<OptionFlag<T, P> & P>) => Promise<T>);
-export type FlagDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<OptionFlag<T, P> & P>) => Promise<string | undefined>);
+export type FlagDefault<T, P = CustomOptions> = T | ((context: DefaultContext<P & OptionFlag<T, P>>) => Promise<T>);
+export type FlagDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<P & OptionFlag<T, P>>) => Promise<string | undefined>);
 export type ArgDefault<T, P = CustomOptions> = T | ((context: DefaultContext<Arg<T, P>>) => Promise<T>);
 export type ArgDefaultHelp<T, P = CustomOptions> = T | ((context: DefaultContext<Arg<T, P>>) => Promise<string | undefined>);
 export type FlagRelationship = string | {
@@ -174,8 +174,14 @@ export type OptionFlagProps = FlagProps & {
     options?: string[];
     multiple?: boolean;
 };
-export type FlagParser<T, I extends string | boolean, P = CustomOptions> = (input: I, context: Command, opts: P & OptionFlag<T, P>) => Promise<T>;
-export type ArgParser<T, P = CustomOptions> = (input: string, context: Command, opts: P & Arg<T, P>) => Promise<T>;
+export type FlagParserContext = Command & {
+    token: FlagToken;
+};
+export type FlagParser<T, I extends string | boolean, P = CustomOptions> = (input: I, context: FlagParserContext, opts: P & OptionFlag<T, P>) => Promise<T>;
+export type ArgParserContext = Command & {
+    token: ArgToken;
+};
+export type ArgParser<T, P = CustomOptions> = (input: string, context: ArgParserContext, opts: P & Arg<T, P>) => Promise<T>;
 export type Arg<T, P = CustomOptions> = ArgProps & {
     options?: T[];
     defaultHelp?: ArgDefaultHelp<T>;
@@ -199,13 +205,13 @@ export type BooleanFlag<T> = FlagProps & BooleanFlagProps & {
     parse: (input: boolean, context: Command, opts: FlagProps & BooleanFlagProps) => Promise<T>;
 };
 export type OptionFlagDefaults<T, P = CustomOptions, M = false> = FlagProps & OptionFlagProps & {
-    parse: FlagParser<T, string, P & OptionFlag<T, P>>;
+    parse: FlagParser<T, string, P>;
     defaultHelp?: FlagDefaultHelp<T>;
     input: string[];
     default?: M extends true ? FlagDefault<T[] | undefined, P> : FlagDefault<T | undefined, P>;
 };
 export type OptionFlag<T, P = CustomOptions> = FlagProps & OptionFlagProps & {
-    parse: FlagParser<T, string, P & OptionFlag<T, P>>;
+    parse: FlagParser<T, string, P>;
     defaultHelp?: FlagDefaultHelp<T, P>;
     input: string[];
 } & ({
@@ -225,13 +231,13 @@ export type FlagDefinition<T, P = CustomOptions> = {
     }) & Partial<OptionFlag<T, P>>): OptionFlag<T[]>;
     (options: P & {
         multiple: true;
-    } & Partial<OptionFlag<T>>): OptionFlag<T[] | undefined, P>;
+    } & Partial<OptionFlag<T>>): OptionFlag<T[] | undefined>;
     (options: P & ({
         required: true;
     } | {
         default: FlagDefault<T>;
-    }) & Partial<OptionFlag<T>>): OptionFlag<T, P>;
-    (options?: P & Partial<OptionFlag<T>>): OptionFlag<T | undefined, P>;
+    }) & Partial<OptionFlag<T>>): OptionFlag<T>;
+    (options?: P & Partial<OptionFlag<T>>): OptionFlag<T | undefined>;
 };
 export type Flag<T> = BooleanFlag<T> | OptionFlag<T>;
 export type Input<TFlags extends FlagOutput, BFlags extends FlagOutput, AFlags extends ArgOutput> = {

package/lib/parser/parse.js

@@ -185,18 +185,18 @@ class Parser {
                 else {
                     flags[token.flag] = true;
                 }
-                flags[token.flag] = await this._parseFlag(flags[token.flag], flag);
+                flags[token.flag] = await this._parseFlag(flags[token.flag], flag, token);
             }
             else {
                 const input = token.input;
                 this._validateOptions(flag, input);
                 if (flag.delimiter && flag.multiple) {
-                    const values = await Promise.all(input.split(flag.delimiter).map(async (v) => this._parseFlag(v.trim(), flag)));
+                    const values = await Promise.all(input.split(flag.delimiter).map(async (v) => this._parseFlag(v.trim(), flag, token)));
                     flags[token.flag] = flags[token.flag] || [];
                     flags[token.flag].push(...values);
                 }
                 else {
-                    const value = await this._parseFlag(input, flag);
+                    const value = await this._parseFlag(input, flag, token);
                     if (flag.multiple) {
                         flags[token.flag] = flags[token.flag] || [];
                         flags[token.flag].push(value);
@@ -232,14 +232,14 @@ class Parser {
         }
         return flags;
     }
-    async _parseFlag(input, flag) {
+    async _parseFlag(input, flag, token) {
         if (!flag.parse)
             return input;
         try {
             if (flag.type === 'boolean') {
-                return await flag.parse(input, this.context, flag);
+                return await flag.parse(input, { ...this.context, token }, flag);
             }
-            return flag.parse ? await flag.parse(input, this.context, flag) : input;
+            return flag.parse ? await flag.parse(input, { ...this.context, token }, flag) : input;
         }
         catch (error) {
             error.message = `Parsing --${flag.name} \n\t${error.message}\nSee more help with --help`;
@@ -261,7 +261,7 @@ class Parser {
                 if (arg.options && !arg.options.includes(token.input)) {
                     throw new errors_1.ArgInvalidOptionError(arg, token.input);
                 }
-                const parsed = await arg.parse(token.input, this.context, arg);
+                const parsed = await arg.parse(token.input, { ...this.context, token }, arg);
                 argv.push(parsed);
                 args[token.arg] = parsed;
             }
@@ -269,7 +269,7 @@ class Parser {
                 let stdin = await readStdin();
                 if (stdin) {
                     stdin = stdin.trim();
-                    const parsed = await arg.parse(stdin, this.context, arg);
+                    const parsed = await arg.parse(stdin, { ...this.context, token }, arg);
                     argv.push(parsed);
                     args[name] = parsed;
                 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {