@oclif/core 1.13.10 → 1.14.1

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.14.1](https://github.com/oclif/core/compare/v1.14.0...v1.14.1) (2022-08-16)
+
+
+### Bug Fixes
+
+* parser doesn't validate against options parameter if the value is provided through a env var ([#474](https://github.com/oclif/core/issues/474)) ([fe6dfea](https://github.com/oclif/core/commit/fe6dfea0bcc5cae69c91962430996670decf7887))
+
+## [1.14.0](https://github.com/oclif/core/compare/v1.13.11...v1.14.0) (2022-08-16)
+
+
+### Features
+
+* all oclif flag types support custom parsers ([ad86faf](https://github.com/oclif/core/commit/ad86faf08f7a6d7984afe356819df458aaf04674))
+
+### [1.13.11](https://github.com/oclif/core/compare/v1.13.10...v1.13.11) (2022-08-16)
+
+
+### Bug Fixes
+
+* more custom flag type overloads ([#471](https://github.com/oclif/core/issues/471)) ([ac4baf2](https://github.com/oclif/core/commit/ac4baf260f8e87bb5618c7b790f35372d55096c7))
+
 ### [1.13.10](https://github.com/oclif/core/compare/v1.13.9...v1.13.10) (2022-08-09)
 
 ### [1.13.9](https://github.com/oclif/core/compare/v1.13.8...v1.13.9) (2022-08-09)

package/lib/interfaces/parser.d.ts

@@ -146,7 +146,14 @@ export declare type OptionFlag<T> = FlagBase<T, string> & OptionFlagProps & {
 export declare type Definition<T> = {
     (options: {
         multiple: true;
-    } & Partial<OptionFlag<T[]>>): OptionFlag<T[]>;
+    } & ({
+        required: true;
+    } | {
+        default: Default<T>;
+    }) & Partial<OptionFlag<T>>): OptionFlag<T[]>;
+    (options: {
+        multiple: true;
+    } & Partial<OptionFlag<T[]>>): OptionFlag<T[] | undefined>;
     (options: ({
         required: true;
     } | {

package/lib/parser/flags.d.ts

@@ -6,6 +6,22 @@ export declare function build<T>(defaults: {
 } & Partial<OptionFlag<T>>): Definition<T>;
 export declare function build(defaults: Partial<OptionFlag<string>>): Definition<string>;
 export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>): BooleanFlag<T>;
+export declare function integer(opts: Partial<OptionFlag<number>> & {
+    min?: number;
+    max?: number;
+} & {
+    multiple: true;
+} & ({
+    required: true;
+} | {
+    default: Default<number>;
+})): OptionFlag<number[]>;
+export declare function integer(opts: Partial<OptionFlag<number>> & {
+    min?: number;
+    max?: number;
+} & {
+    multiple: true;
+}): OptionFlag<number[] | undefined>;
 export declare function integer(opts: Partial<OptionFlag<number>> & {
     min?: number;
     max?: number;
@@ -18,6 +34,20 @@ export declare function integer(opts?: Partial<OptionFlag<number>> & {
     min?: number;
     max?: number;
 }): OptionFlag<number | undefined>;
+export declare function directory(opts: Partial<OptionFlag<string>> & {
+    exists?: boolean;
+} & {
+    multiple: true;
+} & ({
+    required: true;
+} | {
+    default: Default<string>;
+})): OptionFlag<string[]>;
+export declare function directory(opts: Partial<OptionFlag<string>> & {
+    exists?: boolean;
+} & {
+    multiple: true;
+}): OptionFlag<string[] | undefined>;
 export declare function directory(opts: {
     exists?: boolean;
 } & Partial<OptionFlag<string>> & ({
@@ -28,6 +58,20 @@ export declare function directory(opts: {
 export declare function directory(opts?: {
     exists?: boolean;
 } & Partial<OptionFlag<string>>): OptionFlag<string | undefined>;
+export declare function file(opts: Partial<OptionFlag<string>> & {
+    exists?: boolean;
+} & {
+    multiple: true;
+} & ({
+    required: true;
+} | {
+    default: Default<string>;
+})): OptionFlag<string[]>;
+export declare function file(opts: Partial<OptionFlag<string>> & {
+    exists?: boolean;
+} & {
+    multiple: true;
+}): OptionFlag<string[] | undefined>;
 export declare function file(opts: {
     exists?: boolean;
 } & Partial<OptionFlag<string>> & ({

package/lib/parser/flags.js

@@ -37,7 +37,7 @@ function integer(opts = {}) {
                 throw new Error(`Expected an integer greater than or equal to ${opts.min} but received: ${input}`);
             if (opts.max !== undefined && num > opts.max)
                 throw new Error(`Expected an integer less than or equal to ${opts.max} but received: ${input}`);
-            return num;
+            return opts.parse ? opts.parse(input, 1) : num;
         },
     })();
 }
@@ -45,14 +45,26 @@ exports.integer = integer;
 function directory(opts = {}) {
     return build({
         ...opts,
-        parse: async (input) => opts.exists ? dirExists(input) : input,
+        parse: async (input) => {
+            if (opts.exists) {
+                // 2nd "context" arg is required but unused
+                return opts.parse ? opts.parse(await dirExists(input), true) : dirExists(input);
+            }
+            return opts.parse ? opts.parse(input, true) : input;
+        },
     })();
 }
 exports.directory = directory;
 function file(opts = {}) {
     return build({
         ...opts,
-        parse: async (input) => opts.exists ? fileExists(input) : input,
+        parse: async (input) => {
+            if (opts.exists) {
+                // 2nd "context" arg is required but unused
+                return opts.parse ? opts.parse(await fileExists(input), true) : fileExists(input);
+            }
+            return opts.parse ? opts.parse(input, true) : input;
+        },
     })();
 }
 exports.file = file;

package/lib/parser/parse.d.ts

@@ -17,6 +17,7 @@ export declare class Parser<T extends ParserInput, TFlags extends OutputFlags<T[
     }>;
     private _args;
     private _flags;
+    private _validateOptions;
     private _argv;
     private _debugOutput;
     private _debugInput;

package/lib/parser/parse.js

@@ -153,9 +153,7 @@ class Parser {
             }
             else {
                 const input = token.input;
-                if (flag.options && !flag.options.includes(input)) {
-                    throw new m.errors.FlagInvalidOptionError(flag, input);
-                }
+                this._validateOptions(flag, input);
                 // eslint-disable-next-line no-await-in-loop
                 const value = flag.parse ? await flag.parse(input, this.context) : input;
                 if (flag.multiple) {
@@ -173,9 +171,11 @@ class Parser {
                 continue;
             if (flag.type === 'option' && flag.env) {
                 const input = process.env[flag.env];
-                // eslint-disable-next-line no-await-in-loop
-                if (input)
+                if (input) {
+                    this._validateOptions(flag, input);
+                    // eslint-disable-next-line no-await-in-loop
                     flags[k] = await flag.parse(input, this.context);
+                }
             }
             if (!(k in flags) && flag.default !== undefined) {
                 this.metaData.flags[k] = { setFromDefault: true };
@@ -186,6 +186,10 @@ class Parser {
         }
         return flags;
     }
+    _validateOptions(flag, input) {
+        if (flag.options && !flag.options.includes(input))
+            throw new m.errors.FlagInvalidOptionError(flag, input);
+    }
     async _argv() {
         const args = [];
         const tokens = this._argTokens;

package/package.json

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