@oclif/core 2.0.2-beta.1 → 2.0.2-beta.11

package/lib/cli-ux/styled/progress.d.ts

@@ -1,2 +1,2 @@
-import * as cliProgress from 'cli-progress';
-export default function progress(options?: cliProgress.Options): cliProgress.SingleBar;
+import { Options, SingleBar } from 'cli-progress';
+export default function progress(options?: Options): SingleBar;

package/lib/cli-ux/styled/progress.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 // 3pp
-const cliProgress = require("cli-progress");
+const cli_progress_1 = require("cli-progress");
 function progress(options = {}) {
     // set noTTYOutput for options
     options.noTTYOutput = Boolean(process.env.TERM === 'dumb' || !process.stdin.isTTY);
-    return new cliProgress.SingleBar(options);
+    return new cli_progress_1.SingleBar(options);
 }
 exports.default = progress;

package/lib/config/config.d.ts

@@ -40,6 +40,7 @@ export declare class Config implements IConfig {
     constructor(options: Options);
     static load(opts?: LoadOptions): Promise<Config>;
     load(): Promise<void>;
+    loadPluginsAndCommands(): Promise<void>;
     loadCorePlugins(): Promise<void>;
     loadDevPlugins(): Promise<void>;
     loadUserPlugins(): Promise<void>;
@@ -106,6 +107,7 @@ export declare class Config implements IConfig {
         detail: string;
     }, scope?: string): void;
     protected get isProd(): boolean;
+    private isJitPluginCommand;
     private getCmdLookupId;
     private getTopicLookupId;
     private loadCommands;

package/lib/config/config.js

@@ -134,6 +134,10 @@ class Config {
                 ...s3.templates && s3.templates.vanilla,
             },
         };
+        await this.loadPluginsAndCommands();
+        debug('config done');
+    }
+    async loadPluginsAndCommands() {
         await this.loadUserPlugins();
         await this.loadDevPlugins();
         await this.loadCorePlugins();
@@ -141,7 +145,6 @@ class Config {
             this.loadCommands(plugin);
             this.loadTopics(plugin);
         }
-        debug('config done');
     }
     async loadCorePlugins() {
         if (this.pjson.oclif.plugins) {
@@ -250,21 +253,44 @@ class Config {
     }
     async runCommand(id, argv = [], cachedCommand = null) {
         debug('runCommand %s %o', id, argv);
-        const c = cachedCommand ?? this.findCommand(id);
+        let c = cachedCommand ?? this.findCommand(id);
         if (!c) {
             const matches = this.flexibleTaxonomy ? this.findMatches(id, argv) : [];
             const hookResult = this.flexibleTaxonomy && matches.length > 0 ?
                 await this.runHook('command_incomplete', { id, argv, matches }) :
                 await this.runHook('command_not_found', { id, argv });
-            if (hookResult.successes[0]) {
-                const cmdResult = hookResult.successes[0].result;
-                return cmdResult;
-            }
-            if (hookResult.failures[0]) {
+            if (hookResult.successes[0])
+                return hookResult.successes[0].result;
+            if (hookResult.failures[0])
                 throw hookResult.failures[0].error;
-            }
             throw new errors_1.CLIError(`command ${id} not found`);
         }
+        if (this.isJitPluginCommand(c)) {
+            const pluginName = c.pluginName;
+            const pluginVersion = this.pjson.oclif.jitPlugins[pluginName];
+            const jitResult = await this.runHook('jit_plugin_not_installed', {
+                id,
+                argv,
+                command: c,
+                pluginName,
+                pluginVersion,
+            });
+            if (jitResult.failures[0])
+                throw jitResult.failures[0].error;
+            if (jitResult.successes[0]) {
+                await this.loadPluginsAndCommands();
+                c = this.findCommand(id) ?? c;
+            }
+            else {
+                // this means that no jit_plugin_not_installed hook exists, so we should run the default behavior
+                const result = await this.runHook('command_not_found', { id, argv });
+                if (result.successes[0])
+                    return result.successes[0].result;
+                if (result.failures[0])
+                    throw result.failures[0].error;
+                throw new errors_1.CLIError(`command ${id} not found`);
+            }
+        }
         const command = await c.load();
         await this.runHook('prerun', { Command: command, argv });
         const result = (await command.run(argv, this));
@@ -487,6 +513,9 @@ class Config {
     get isProd() {
         return (0, util_3.isProd)();
     }
+    isJitPluginCommand(c) {
+        return Object.keys(this.pjson.oclif.jitPlugins ?? {}).includes(c.pluginName ?? '') && !this.plugins.find(p => p.name === c?.pluginName);
+    }
     getCmdLookupId(id) {
         if (this._commands.has(id))
             return id;
@@ -595,6 +624,14 @@ class Config {
             if (a.pluginType === 'core' && b.pluginType !== 'core') {
                 return -1;
             }
+            // if a is a jit plugin and b is not sort b first
+            if (a.pluginType === 'jit' && b.pluginType !== 'jit') {
+                return 1;
+            }
+            // if b is a jit plugin and a is not sort a first
+            if (b.pluginType === 'jit' && a.pluginType !== 'jit') {
+                return -1;
+            }
             // neither plugin is core, so do not change the order
             return 0;
         });
@@ -698,12 +735,8 @@ async function toCached(c, plugin) {
             }
         }
     }
-    // v1 commands have args as an array, so we need to normalize it to an object for backwards compatibility
-    const normalized = (Array.isArray(c.args) ? (c.args ?? []).reduce((x, y) => {
-        return { ...x, [y.name]: y };
-    }, {}) : c.args ?? {});
     const args = {};
-    for (const [name, arg] of Object.entries(normalized)) {
+    for (const [name, arg] of Object.entries((0, util_3.ensureArgObject)(c.args))) {
         args[name] = {
             name,
             description: arg.description,
@@ -731,7 +764,8 @@ async function toCached(c, plugin) {
         flags,
         args,
     };
-    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_baseFlags'];
+    // do not include these properties in manifest
+    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags', '_baseFlags'];
     const stdKeys = Object.keys(stdProperties);
     const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property));
     const additionalProperties = {};

package/lib/config/plugin.js

@@ -127,7 +127,12 @@ class Plugin {
         this.manifest = await this._manifest(Boolean(this.options.ignoreManifest), Boolean(this.options.errorOnManifestCreate));
         this.commands = Object
             .entries(this.manifest.commands)
-            .map(([id, c]) => ({ ...c, pluginAlias: this.alias, pluginType: this.type, load: async () => this.findCommand(id, { must: true }) }))
+            .map(([id, c]) => ({
+            ...c,
+            pluginAlias: this.alias,
+            pluginType: c.pluginType === 'jit' ? 'jit' : this.type,
+            load: async () => this.findCommand(id, { must: true }),
+        }))
             .sort((a, b) => a.id.localeCompare(b.id));
     }
     get topics() {

package/lib/help/command.js

@@ -31,7 +31,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
             v.name = k;
             return v;
         }), f => [!f.char, f.char, f.name]);
-        const args = Object.values(cmd.args ?? {}).filter(a => !a.hidden);
+        const args = Object.values((0, util_1.ensureArgObject)(cmd.args)).filter(a => !a.hidden);
         const output = (0, util_1.compact)(this.sections().map(({ header, generate }) => {
             const body = generate({ cmd, flags, args }, header);
             // Generate can return a list of sections

package/lib/help/docopts.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocOpts = void 0;
+const util_1 = require("../util");
 /**
  * DocOpts - See http://docopt.org/.
  *
@@ -75,7 +76,7 @@ class DocOpts {
     toString() {
         const opts = this.cmd.id === '.' || this.cmd.id === '' ? [] : ['<%= command.id %>'];
         if (this.cmd.args) {
-            const a = Object.values(this.cmd.args ?? {}).map(arg => `[${arg.name.toUpperCase()}]`) || [];
+            const a = Object.values((0, util_1.ensureArgObject)(this.cmd.args)).map(arg => `[${arg.name.toUpperCase()}]`) || [];
             opts.push(...a);
         }
         try {

package/lib/help/util.d.ts

@@ -1,11 +1,10 @@
-import * as ejs from 'ejs';
 import { Config as IConfig, HelpOptions, Deprecation } from '../interfaces';
 import { HelpBase } from '.';
 interface HelpBaseDerived {
     new (config: IConfig, opts?: Partial<HelpOptions>): HelpBase;
 }
 export declare function loadHelpClass(config: IConfig): Promise<HelpBaseDerived>;
-export declare function template(context: ejs.Data): (t: string) => string;
+export declare function template(context: any): (t: string) => string;
 export declare function toStandardizedId(commandID: string, config: IConfig): string;
 export declare function toConfiguredId(commandID: string, config: IConfig): string;
 export declare function standardizeIDFromArgv(argv: string[], config: IConfig): string[];

package/lib/help/util.js

@@ -23,6 +23,7 @@ async function loadHelpClass(config) {
     return _1.Help;
 }
 exports.loadHelpClass = loadHelpClass;
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 function template(context) {
     function render(t) {
         return ejs.render(t, context);

package/lib/interfaces/hooks.d.ts

@@ -58,6 +58,16 @@ export interface Hooks {
         };
         return: unknown;
     };
+    'jit_plugin_not_installed': {
+        options: {
+            id: string;
+            argv: string[];
+            command: Command.Loadable;
+            pluginName: string;
+            pluginVersion: string;
+        };
+        return: unknown;
+    };
     'plugins:preinstall': {
         options: {
             plugin: {
@@ -84,6 +94,7 @@ export declare namespace Hook {
     type Update = Hook<'update'>;
     type CommandNotFound = Hook<'command_not_found'>;
     type CommandIncomplete = Hook<'command_incomplete'>;
+    type JitPluginNotInstalled = Hook<'jit_plugin_not_installed'>;
     interface Context {
         config: Config;
         exit(code?: number): void;

package/lib/interfaces/parser.d.ts

@@ -73,7 +73,7 @@ export type Relationship = {
 export type Deprecation = {
     to?: string;
     message?: string;
-    version?: string;
+    version?: string | number;
 };
 export type FlagProps = {
     name: string;

package/lib/interfaces/pjson.d.ts

@@ -27,6 +27,7 @@ export declare namespace PJSON {
             default?: string;
             plugins?: string[];
             devPlugins?: string[];
+            jitPlugins?: Record<string, string>;
             helpClass?: string;
             helpOptions?: HelpOptions;
             aliases?: {
@@ -83,6 +84,7 @@ export declare namespace PJSON {
             scope?: string;
             dirname?: string;
             flexibleTaxonomy?: boolean;
+            jitPlugins?: Record<string, string>;
         };
     }
     interface User extends PJSON {

package/lib/interfaces/plugin.d.ts

@@ -13,6 +13,7 @@ export interface PluginOptions {
 }
 export interface Options extends PluginOptions {
     devPlugins?: boolean;
+    jitPlugins?: boolean;
     userPlugins?: boolean;
     channel?: string;
     version?: string;

package/lib/main.js

@@ -72,7 +72,7 @@ async function run(argv, options) {
     // command id.
     if (config.pjson.oclif.default === '.' && id === '.' && argv[0] === '.')
         argvSlice = ['.', ...argvSlice];
-    await config.runCommand(id, argvSlice, cmd);
+    return config.runCommand(id, argvSlice, cmd);
 }
 exports.run = run;
 function getTsConfigPath(dir, type) {

package/lib/parser/errors.d.ts

@@ -1,6 +1,6 @@
 import { CLIError } from '../errors';
 import { OptionFlag, Flag } from '../interfaces';
-import { Arg, ArgInput, CLIParseErrorOptions } from '../interfaces/parser';
+import { Arg, ArgInput, BooleanFlag, CLIParseErrorOptions } from '../interfaces/parser';
 export { CLIError } from '../errors';
 export type Validation = {
     name: string;
@@ -47,6 +47,9 @@ export declare class NonExistentFlagsError extends CLIParseError {
 export declare class FlagInvalidOptionError extends CLIParseError {
     constructor(flag: OptionFlag<any>, input: string);
 }
+export declare class FailedFlagParseError extends CLIParseError {
+    constructor(flag: BooleanFlag<any> | OptionFlag<any>, errMsg: string);
+}
 export declare class ArgInvalidOptionError extends CLIParseError {
     constructor(arg: Arg<any>, input: string);
 }

package/lib/parser/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredFlagError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
+exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FailedFlagParseError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredFlagError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
 const errors_1 = require("../errors");
 const help_1 = require("./help");
 const list_1 = require("../cli-ux/list");
@@ -74,6 +74,13 @@ class FlagInvalidOptionError extends CLIParseError {
     }
 }
 exports.FlagInvalidOptionError = FlagInvalidOptionError;
+class FailedFlagParseError extends CLIParseError {
+    constructor(flag, errMsg) {
+        const message = `Parsing --${flag.name} \n\t${errMsg}`;
+        super({ parse: {}, message });
+    }
+}
+exports.FailedFlagParseError = FailedFlagParseError;
 class ArgInvalidOptionError extends CLIParseError {
     constructor(arg, input) {
         const message = `Expected ${input} to be one of: ${arg.options.join(', ')}`;

package/lib/parser/parse.d.ts

@@ -11,6 +11,7 @@ export declare class Parser<T extends ParserInput, TFlags extends OutputFlags<T[
     constructor(input: T);
     parse(): Promise<ParserOutput<TFlags, BFlags, TArgs>>;
     private _flags;
+    private _parseFlag;
     private _validateOptions;
     private _args;
     private _debugOutput;

package/lib/parser/parse.js

@@ -41,7 +41,6 @@ const readStdin = async () => {
             debug('resolved from stdin', result);
             resolve(result);
         });
-        // @ts-expect-error because the AbortSignal interface is missing addEventListener
         signal.addEventListener('abort', () => {
             debug('stdin aborted');
             clearTimeout(timeout);
@@ -183,13 +182,13 @@ class Parser {
                 else {
                     flags[token.flag] = true;
                 }
-                flags[token.flag] = await flag.parse(flags[token.flag], this.context, flag);
+                flags[token.flag] = await this._parseFlag(flags[token.flag], flag);
             }
             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) => flag.parse ? flag.parse(v.trim(), this.context, flag) : v.trim()));
+                    const values = await Promise.all(input.split(flag.delimiter).map(async (v) => this._parseFlag(v.trim(), flag)));
                     flags[token.flag] = flags[token.flag] || [];
                     flags[token.flag].push(...values);
                 }
@@ -230,6 +229,17 @@ class Parser {
         }
         return flags;
     }
+    async _parseFlag(input, flag) {
+        try {
+            if (flag.type === 'boolean') {
+                return await flag.parse(input, this.context, flag);
+            }
+            return flag.parse ? await flag.parse(input, this.context, flag) : input;
+        }
+        catch (error) {
+            throw new errors_1.FailedFlagParseError(flag, error.message);
+        }
+    }
     _validateOptions(flag, input) {
         if (flag.options && !flag.options.includes(input))
             throw new errors_1.FlagInvalidOptionError(flag, input);

package/lib/util.d.ts

@@ -1,3 +1,5 @@
+import { Command } from './command';
+import { ArgInput } from './interfaces/parser';
 export declare function pickBy<T extends {
     [s: string]: T[keyof T];
 } | ArrayLike<T[keyof T]>>(obj: T, fn: (i: T[keyof T]) => boolean): Partial<T>;
@@ -15,4 +17,14 @@ export declare const fileExists: (input: string) => Promise<string>;
 export declare function isTruthy(input: string): boolean;
 export declare function isNotFalsy(input: string): boolean;
 export declare function requireJson<T>(...pathParts: string[]): T;
+/**
+ * Ensure that the provided args are an object. This is for backwards compatibility with v1 commands which
+ * defined args as an array.
+ *
+ * @param args Either an array of args or an object of args
+ * @returns ArgInput
+ */
+export declare function ensureArgObject(args?: any[] | ArgInput | {
+    [name: string]: Command.Arg.Cached;
+}): ArgInput;
 export {};

package/lib/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireJson = exports.isNotFalsy = exports.isTruthy = exports.fileExists = exports.dirExists = exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = exports.pickBy = void 0;
+exports.ensureArgObject = exports.requireJson = exports.isNotFalsy = exports.isTruthy = exports.fileExists = exports.dirExists = exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = exports.pickBy = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 function pickBy(obj, fn) {
@@ -94,14 +94,27 @@ const fileExists = async (input) => {
 };
 exports.fileExists = fileExists;
 function isTruthy(input) {
-    return ['true', 'TRUE', '1', 'yes', 'YES', 'y', 'Y'].includes(input);
+    return ['true', '1', 'yes', 'y'].includes(input.toLowerCase());
 }
 exports.isTruthy = isTruthy;
 function isNotFalsy(input) {
-    return !['false', 'FALSE', '0', 'no', 'NO', 'n', 'N'].includes(input);
+    return !['false', '0', 'no', 'n'].includes(input.toLowerCase());
 }
 exports.isNotFalsy = isNotFalsy;
 function requireJson(...pathParts) {
     return JSON.parse(fs.readFileSync((0, path_1.join)(...pathParts), 'utf8'));
 }
 exports.requireJson = requireJson;
+/**
+ * Ensure that the provided args are an object. This is for backwards compatibility with v1 commands which
+ * defined args as an array.
+ *
+ * @param args Either an array of args or an object of args
+ * @returns ArgInput
+ */
+function ensureArgObject(args) {
+    return (Array.isArray(args) ? (args ?? []).reduce((x, y) => {
+        return { ...x, [y.name]: y };
+    }, {}) : args ?? {});
+}
+exports.ensureArgObject = ensureArgObject;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.0.2-beta.1",
+  "version": "2.0.2-beta.11",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
+    "@types/cli-progress": "^3.11.0",
     "ansi-escapes": "^4.3.2",
     "ansi-styles": "^4.3.0",
     "cardinal": "^2.1.1",
@@ -37,19 +38,18 @@
     "@commitlint/config-conventional": "^12.1.4",
     "@oclif/plugin-help": "^5.1.22",
     "@oclif/plugin-plugins": "^2.1.12",
-    "@oclif/test": "^2.2.19",
+    "@oclif/test": "^2.2.20",
     "@types/ansi-styles": "^3.2.1",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/clean-stack": "^2.1.1",
-    "@types/cli-progress": "^3.9.2",
     "@types/ejs": "^3.1.0",
     "@types/fs-extra": "^9.0.13",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
     "@types/mocha": "^8.2.3",
     "@types/nock": "^11.1.0",
-    "@types/node": "^15.14.9",
+    "@types/node": "^16",
     "@types/node-notifier": "^8.0.2",
     "@types/proxyquire": "^1.3.28",
     "@types/semver": "^7.3.13",
@@ -64,11 +64,11 @@
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4.0.0",
     "eslint-config-oclif-typescript": "^1.0.2",
-    "fancy-test": "^1.4.10",
+    "fancy-test": "^2.0.12",
     "globby": "^11.1.0",
     "husky": "6",
     "mocha": "^8.4.0",
-    "nock": "^13.2.4",
+    "nock": "^13.3.0",
     "proxyquire": "^2.1.3",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",
@@ -109,7 +109,7 @@
     "lint": "eslint . --ext .ts --config .eslintrc",
     "posttest": "yarn lint",
     "prepack": "yarn run build",
-    "test": "mocha \"test/**/*.test.ts\"",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "test:e2e": "mocha \"test/**/*.e2e.ts\" --timeout 1200000",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit --skipLibCheck"
   },