@oclif/core 1.3.6 → 1.5.1

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.5.1](https://github.com/oclif/core/compare/v1.5.0...v1.5.1) (2022-03-03)
+
+## [1.5.0](https://github.com/oclif/core/compare/v1.4.0...v1.5.0) (2022-03-02)
+
+
+### Features
+
+* dir and file flags that validate existence and type ([#384](https://github.com/oclif/core/issues/384)) ([44dff41](https://github.com/oclif/core/commit/44dff41c5a3ffcdcbf2f10dcefb7c1ab233bfc4f))
+
+## [1.4.0](https://github.com/oclif/core/compare/v1.3.6...v1.4.0) (2022-03-01)
+
+
+### Features
+
+* make global flags settable ([#385](https://github.com/oclif/core/issues/385)) ([e14061c](https://github.com/oclif/core/commit/e14061ca7e6a4c288eb50e0e9954b38e042682df))
+
 ### [1.3.6](https://github.com/oclif/core/compare/v1.3.5...v1.3.6) (2022-02-28)
 
 

package/lib/command.d.ts

@@ -63,9 +63,11 @@ export default abstract class Command {
      * @param {Interfaces.LoadOptions} opts options
      */
     static run: Interfaces.Command.Class['run'];
-    private static globalFlags;
+    protected static _globalFlags: Interfaces.FlagInput<any>;
+    static get globalFlags(): Interfaces.FlagInput<any>;
+    static set globalFlags(flags: Interfaces.FlagInput<any>);
     /** A hash of flags for the command */
-    private static _flags;
+    protected static _flags: Interfaces.FlagInput<any>;
     static get flags(): Interfaces.FlagInput<any>;
     static set flags(flags: Interfaces.FlagInput<any>);
     id: string | undefined;

package/lib/command.js

@@ -17,6 +17,12 @@ process.stdout.on('error', (err) => {
         return;
     throw err;
 });
+const jsonFlag = {
+    json: Flags.boolean({
+        description: 'Format output as json.',
+        helpGroup: 'GLOBAL',
+    }),
+};
 /**
  * An abstract class which acts as the base for each command
  * in your project.
@@ -33,11 +39,20 @@ class Command {
             this.debug = () => { };
         }
     }
+    static get globalFlags() {
+        return this._globalFlags;
+    }
+    static set globalFlags(flags) {
+        this._globalFlags = this.enableJsonFlag ?
+            Object.assign({}, jsonFlag, this.globalFlags, flags) :
+            Object.assign({}, this.globalFlags, flags);
+    }
     static get flags() {
         return this._flags;
     }
     static set flags(flags) {
-        this._flags = this.enableJsonFlag ? Object.assign({}, Command.globalFlags, flags) : flags;
+        this.globalFlags = {};
+        this._flags = Object.assign({}, this.globalFlags, flags);
     }
     get ctor() {
         return this.constructor;
@@ -169,9 +184,3 @@ Command.run = async function (argv, opts) {
     const cmd = new this(argv, config);
     return cmd._run(argv);
 };
-Command.globalFlags = {
-    json: Flags.boolean({
-        description: 'Format output as json.',
-        helpGroup: 'GLOBAL',
-    }),
-};

package/lib/config/config.js

@@ -473,6 +473,28 @@ class Config {
     }
 }
 exports.Config = Config;
+// when no manifest exists, the default is calculated.  This may throw, so we need to catch it
+const defaultToCached = async (flag) => {
+    // Prefer the helpDefaultValue function (returns a friendly string for complex types)
+    if (typeof flag.defaultHelp === 'function') {
+        try {
+            return await flag.defaultHelp();
+        }
+        catch {
+            return;
+        }
+    }
+    // if not specified, try the default function
+    if (typeof flag.default === 'function') {
+        try {
+            return await flag.default({ options: {}, flags: {} });
+        }
+        catch { }
+    }
+    else {
+        return flag.default;
+    }
+};
 async function toCached(c, plugin) {
     const flags = {};
     for (const [name, flag] of Object.entries(c.flags || {})) {
@@ -508,8 +530,12 @@ async function toCached(c, plugin) {
                 options: flag.options,
                 dependsOn: flag.dependsOn,
                 exclusive: flag.exclusive,
-                default: typeof flag.default === 'function' ? await flag.default({ options: {}, flags: {} }) : flag.default,
+                default: await defaultToCached(flag),
             };
+            // a command-level placeholder in the manifest so that oclif knows it should regenerate the command during help-time
+            if (typeof flag.defaultHelp === 'function') {
+                c.hasDynamicHelp = true;
+            }
         }
     }
     const argsPromise = (c.args || []).map(async (a) => ({

package/lib/flags.d.ts

@@ -10,6 +10,6 @@ declare const _enum: <T = string>(opts: EnumFlagOptions<T>) => OptionFlag<T>;
 export { _enum as enum };
 declare const stringFlag: Definition<string>;
 export { stringFlag as string };
-export { boolean, integer, url } from './parser';
+export { boolean, integer, url, directory, file } from './parser';
 export declare const version: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;
 export declare const help: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.help = exports.version = 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.option = exports.build = void 0;
 const Parser = require("./parser");
 function build(defaults) {
     return Parser.flags.build(defaults);
@@ -28,6 +28,8 @@ var parser_1 = require("./parser");
 Object.defineProperty(exports, "boolean", { enumerable: true, get: function () { return parser_1.boolean; } });
 Object.defineProperty(exports, "integer", { enumerable: true, get: function () { return parser_1.integer; } });
 Object.defineProperty(exports, "url", { enumerable: true, get: function () { return parser_1.url; } });
+Object.defineProperty(exports, "directory", { enumerable: true, get: function () { return parser_1.directory; } });
+Object.defineProperty(exports, "file", { enumerable: true, get: function () { return parser_1.file; } });
 const version = (opts = {}) => {
     return Parser.flags.boolean({
         description: 'Show CLI version.',

package/lib/help/index.d.ts

@@ -25,6 +25,7 @@ export declare class Help extends HelpBase {
     protected get sortedTopics(): Interfaces.Topic[];
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);
     showHelp(argv: string[]): Promise<void>;
+    private getDynamicCommand;
     showCommandHelp(command: Interfaces.Command): Promise<void>;
     protected showRootHelp(): Promise<void>;
     protected showTopicHelp(topic: Interfaces.Topic): Promise<void>;

package/lib/help/index.js

@@ -8,6 +8,8 @@ const root_1 = require("./root");
 const util_1 = require("../util");
 const util_2 = require("./util");
 const formatter_1 = require("./formatter");
+const plugin_1 = require("../config/plugin");
+const config_1 = require("../config/config");
 var command_2 = require("./command");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return command_2.CommandHelp; } });
 var util_3 = require("./util");
@@ -89,7 +91,13 @@ class Help extends HelpBase {
         }
         const command = this.config.findCommand(subject);
         if (command) {
-            await this.showCommandHelp(command);
+            if (command.hasDynamicHelp) {
+                const dynamicCommand = await (0, config_1.toCached)(await this.getDynamicCommand(command.id));
+                await this.showCommandHelp(dynamicCommand);
+            }
+            else {
+                await this.showCommandHelp(command);
+            }
             return;
         }
         const topic = this.config.findTopic(subject);
@@ -99,6 +107,15 @@ class Help extends HelpBase {
         }
         (0, errors_1.error)(`Command ${subject} not found.`);
     }
+    async getDynamicCommand(cmdName) {
+        const plugin = new plugin_1.Plugin({ ignoreManifest: true, root: this.config.root });
+        await plugin.load();
+        const cmd = await plugin.findCommand(cmdName);
+        if (!cmd) {
+            throw new Error(`Command ${cmdName} not found.`);
+        }
+        return cmd;
+    }
     async showCommandHelp(command) {
         var _a, _b, _c, _d;
         const name = command.id;
@@ -110,8 +127,9 @@ class Help extends HelpBase {
         if (state)
             console.log(`This command is in ${state}.\n`);
         const summary = this.summary(command);
-        if (summary)
+        if (summary) {
             console.log(summary + '\n');
+        }
         console.log(this.formatCommand(command));
         console.log('');
         if (subTopics.length > 0) {

package/lib/interfaces/command.d.ts

@@ -54,6 +54,7 @@ export interface Command extends CommandProps {
     };
     args: Command.Arg[];
     strict: boolean;
+    hasDynamicHelp?: boolean;
 }
 export declare namespace Command {
     interface Arg {
@@ -70,6 +71,7 @@ export declare namespace Command {
         }
         interface Option extends OptionFlagProps {
             default?: string;
+            defaultHelp?: () => Promise<string>;
         }
     }
     interface Base extends CommandProps {
@@ -80,6 +82,7 @@ export declare namespace Command {
         flags?: FlagInput<any>;
         args?: ArgInput;
         strict: boolean;
+        hasDynamicHelp?: boolean;
         new (argv: string[], config: Config): Instance;
         run(argv?: string[], config?: LoadOptions): PromiseLike<any>;
     }

package/lib/interfaces/index.d.ts

@@ -6,7 +6,7 @@ export { HelpOptions } from './help';
 export { Hook, Hooks } from './hooks';
 export { Manifest } from './manifest';
 export { S3Manifest } from './s3-manifest';
-export { ParserArg, Arg, ParseFn, ParserOutput, ParserInput, ArgToken, OptionalArg, FlagOutput, OutputArgs, OutputFlags, FlagUsageOptions, CLIParseErrorOptions, ArgInput, RequiredArg, Metadata, ParsingToken, FlagToken, List, ListItem, BooleanFlag, Flag, FlagBase, OptionFlag, Input, EnumFlagOptions, DefaultContext, Default, Definition, CompletableOptionFlag, Completion, CompletionContext, FlagInput, CompletableFlag, } from './parser';
+export { ParserArg, Arg, ParseFn, ParserOutput, ParserInput, ArgToken, OptionalArg, FlagOutput, OutputArgs, OutputFlags, FlagUsageOptions, CLIParseErrorOptions, ArgInput, RequiredArg, Metadata, ParsingToken, FlagToken, List, ListItem, BooleanFlag, Flag, FlagBase, OptionFlag, Input, EnumFlagOptions, DefaultContext, Default, Definition, CompletableOptionFlag, Completion, CompletionContext, FlagInput, CompletableFlag, OptionFlagProps, } from './parser';
 export { PJSON } from './pjson';
 export { Plugin, PluginOptions, Options } from './plugin';
 export { Topic } from './topic';

package/lib/interfaces/parser.d.ts

@@ -85,6 +85,7 @@ export declare type DefaultContext<T> = {
     };
 };
 export declare type Default<T> = T | ((context: DefaultContext<T>) => Promise<T>);
+export declare type DefaultHelp<T> = T | ((context: DefaultContext<T>) => Promise<string | undefined>);
 export declare type FlagProps = {
     name: string;
     char?: AlphabetLowercase | AlphabetUppercase;
@@ -139,6 +140,7 @@ export declare type BooleanFlag<T> = FlagBase<T, boolean> & BooleanFlagProps & {
 };
 export declare type OptionFlag<T> = FlagBase<T, string> & OptionFlagProps & {
     default?: Default<T | undefined>;
+    defaultHelp?: DefaultHelp<T>;
     input: string[];
 };
 export declare type Definition<T> = {

package/lib/parser/flags.d.ts

@@ -7,6 +7,12 @@ export declare function build<T>(defaults: {
 export declare function build(defaults: Partial<OptionFlag<string>>): Definition<string>;
 export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>): BooleanFlag<T>;
 export declare const integer: Definition<number>;
+export declare const directory: (opts?: {
+    exists?: boolean;
+} & Partial<OptionFlag<string>>) => OptionFlag<string | undefined>;
+export declare const file: (opts?: {
+    exists?: boolean;
+} & Partial<OptionFlag<string>>) => OptionFlag<string | undefined>;
 /**
  * Initializes a string as a URL. Throws an error
  * if the string is not a valid URL.

package/lib/parser/flags.js

@@ -1,8 +1,9 @@
 "use strict";
 // tslint:disable interface-over-type-literal
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultFlags = exports.string = exports.option = exports.url = exports.integer = exports.boolean = exports.build = void 0;
+exports.defaultFlags = exports.string = exports.option = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = exports.build = void 0;
 const url_1 = require("url");
+const fs = require("fs");
 function build(defaults) {
     return (options = {}) => {
         return {
@@ -32,6 +33,20 @@ exports.integer = build({
         return Number.parseInt(input, 10);
     },
 });
+const directory = (opts = {}) => {
+    return build({
+        ...opts,
+        parse: async (input) => opts.exists ? dirExists(input) : input,
+    })();
+};
+exports.directory = directory;
+const file = (opts = {}) => {
+    return build({
+        ...opts,
+        parse: async (input) => opts.exists ? fileExists(input) : input,
+    })();
+};
+exports.file = file;
 /**
  * Initializes a string as a URL. Throws an error
  * if the string is not a valid URL.
@@ -55,3 +70,21 @@ exports.string = stringFlag;
 exports.defaultFlags = {
     color: boolean({ allowNo: true }),
 };
+const dirExists = async (input) => {
+    if (!fs.existsSync(input)) {
+        throw new Error(`No directory found at ${input}`);
+    }
+    if (!(await fs.promises.stat(input)).isDirectory()) {
+        throw new Error(`${input} exists but is not a directory`);
+    }
+    return input;
+};
+const fileExists = async (input) => {
+    if (!fs.existsSync(input)) {
+        throw new Error(`No file found at ${input}`);
+    }
+    if (!(await fs.promises.stat(input)).isFile()) {
+        throw new Error(`${input} exists but is not a file`);
+    }
+    return input;
+};

package/lib/parser/index.d.ts

@@ -8,5 +8,9 @@ export { flagUsages } from './help';
 export declare function parse<TFlags, TArgs extends {
     [name: string]: string;
 }>(argv: string[], options: Input<TFlags>): Promise<ParserOutput<TFlags, TArgs>>;
-declare const boolean: typeof flags.boolean, integer: import("../interfaces").Definition<number>, url: import("../interfaces").Definition<import("url").URL>;
-export { boolean, integer, url };
+declare const boolean: typeof flags.boolean, integer: import("../interfaces").Definition<number>, url: import("../interfaces").Definition<import("url").URL>, directory: (opts?: {
+    exists?: boolean | undefined;
+} & Partial<import("../interfaces").OptionFlag<string>>) => import("../interfaces").OptionFlag<string | undefined>, file: (opts?: {
+    exists?: boolean | undefined;
+} & Partial<import("../interfaces").OptionFlag<string>>) => import("../interfaces").OptionFlag<string | undefined>;
+export { boolean, integer, url, directory, file };

package/lib/parser/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // tslint:disable interface-over-type-literal
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = exports.integer = exports.boolean = exports.parse = exports.flagUsages = exports.flags = exports.args = void 0;
+exports.file = exports.directory = exports.url = exports.integer = exports.boolean = exports.parse = exports.flagUsages = exports.flags = exports.args = void 0;
 const args = require("./args");
 exports.args = args;
 const deps_1 = require("./deps");
@@ -32,7 +32,9 @@ async function parse(argv, options) {
     return output;
 }
 exports.parse = parse;
-const { boolean, integer, url } = flags;
+const { boolean, integer, url, directory, file } = flags;
 exports.boolean = boolean;
 exports.integer = integer;
 exports.url = url;
+exports.directory = directory;
+exports.file = file;

package/package.json

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