@oclif/core 1.13.11 → 1.14.2

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.2](https://github.com/oclif/core/compare/v1.14.1...v1.14.2) (2022-08-18)
+
+
+### Bug Fixes
+
+* add overloads to enum flag ([799455b](https://github.com/oclif/core/commit/799455bbb526b221c806bf8feff6b625dcf50a56))
+
+### [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)
 
 

package/lib/flags.d.ts

@@ -1,4 +1,4 @@
-import { OptionFlag, Definition, BooleanFlag, EnumFlagOptions } from './interfaces';
+import { OptionFlag, Definition, BooleanFlag, EnumFlagOptions, Default } from './interfaces';
 export declare function build<T>(defaults: {
     parse: OptionFlag<T>['parse'];
 } & Partial<OptionFlag<T>>): Definition<T>;
@@ -6,7 +6,22 @@ export declare function build(defaults: Partial<OptionFlag<string>>): Definition
 export declare function option<T>(options: {
     parse: OptionFlag<T>['parse'];
 } & Partial<OptionFlag<T>>): OptionFlag<T | undefined>;
-declare const _enum: <T = string>(opts: EnumFlagOptions<T>) => OptionFlag<T>;
+export declare function _enum<T = string>(opts: EnumFlagOptions<T> & {
+    multiple: true;
+} & ({
+    required: true;
+} | {
+    default: Default<T>;
+})): OptionFlag<T[]>;
+export declare function _enum<T = string>(opts: EnumFlagOptions<T> & {
+    multiple: true;
+}): OptionFlag<T[] | undefined>;
+export declare function _enum<T = string>(opts: EnumFlagOptions<T> & ({
+    required: true;
+} | {
+    default: Default<T>;
+})): OptionFlag<T>;
+export declare function _enum<T = string>(opts: EnumFlagOptions<T>): OptionFlag<T | undefined>;
 export { _enum as enum };
 declare const stringFlag: Definition<string>;
 export { stringFlag as string };

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.help = exports.version = exports.file = exports.directory = exports.url = exports.integer = exports.boolean = exports.string = exports.enum = exports.option = exports.build = void 0;
+exports.help = exports.version = exports.file = exports.directory = exports.url = exports.integer = exports.boolean = exports.string = exports.enum = exports._enum = exports.option = exports.build = void 0;
 const Parser = require("./parser");
 function build(defaults) {
     return Parser.flags.build(defaults);
@@ -10,7 +10,7 @@ function option(options) {
     return build(options)();
 }
 exports.option = option;
-const _enum = (opts) => {
+function _enum(opts) {
     return build({
         async parse(input) {
             if (!opts.options.includes(input))
@@ -20,7 +20,8 @@ const _enum = (opts) => {
         helpValue: `(${opts.options.join('|')})`,
         ...opts,
     })();
-};
+}
+exports._enum = _enum;
 exports.enum = _enum;
 const stringFlag = build({});
 exports.string = stringFlag;

package/lib/parser/flags.d.ts

@@ -77,7 +77,7 @@ export declare function file(opts: {
 } & Partial<OptionFlag<string>> & ({
     required: true;
 } | {
-    default: string;
+    default: Default<string>;
 })): OptionFlag<string>;
 export declare function file(opts?: {
     exists?: boolean;

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.11",
+  "version": "1.14.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {