@oclif/core 1.6.3 → 1.8.0

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.8.0](https://github.com/oclif/core/compare/v1.7.0...v1.8.0) (2022-05-06)
+
+
+### Features
+
+* improve Command interface ([#416](https://github.com/oclif/core/issues/416)) ([ed625e1](https://github.com/oclif/core/commit/ed625e1554a09e578e645ddd7aa2ddb1b368c03f))
+
+## [1.7.0](https://github.com/oclif/core/compare/v1.6.4...v1.7.0) (2022-04-11)
+
+
+### Features
+
+* move console.log to single class method ([#400](https://github.com/oclif/core/issues/400)) ([2ccb274](https://github.com/oclif/core/commit/2ccb2740912dba3b81c4d36712fbb20fd6a03c23))
+
+### [1.6.4](https://github.com/oclif/core/compare/v1.6.3...v1.6.4) (2022-03-31)
+
+
+### Bug Fixes
+
+* dynamic help ([#395](https://github.com/oclif/core/issues/395)) ([8ecc8f4](https://github.com/oclif/core/commit/8ecc8f41ec62ef5b05bdb70a79dce09b5913d14b))
+
 ### [1.6.3](https://github.com/oclif/core/compare/v1.6.2...v1.6.3) (2022-03-23)
 
 

package/lib/config/config.d.ts

@@ -43,16 +43,16 @@ export declare class Config implements IConfig {
     loadDevPlugins(): Promise<void>;
     loadUserPlugins(): Promise<void>;
     runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number): Promise<Hook.Result<Hooks[T]['return']>>;
-    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Plugin): Promise<T>;
+    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable): Promise<T>;
     scopedEnvVar(k: string): string | undefined;
     scopedEnvVarTrue(k: string): boolean;
     scopedEnvVarKey(k: string): string;
     findCommand(id: string, opts: {
         must: true;
-    }): Command.Plugin;
+    }): Command.Loadable;
     findCommand(id: string, opts?: {
         must: boolean;
-    }): Command.Plugin | undefined;
+    }): Command.Loadable | undefined;
     findTopic(id: string, opts: {
         must: true;
     }): Topic;
@@ -72,18 +72,18 @@ export declare class Config implements IConfig {
      * @param argv string[] process.argv containing the flags and arguments provided by the user
      * @returns string[]
      */
-    findMatches(partialCmdId: string, argv: string[]): Command.Plugin[];
+    findMatches(partialCmdId: string, argv: string[]): Command.Loadable[];
     /**
      * Returns an array of all commands. If flexible taxonomy is enabled then all permutations will be appended to the array.
-     * @returns Command.Plugin[]
+     * @returns Command.Loadable[]
      */
-    getAllCommands(): Command.Plugin[];
+    getAllCommands(): Command.Loadable[];
     /**
      * Returns an array of all command ids. If flexible taxonomy is enabled then all permutations will be appended to the array.
      * @returns string[]
      */
     getAllCommandIDs(): string[];
-    get commands(): Command.Plugin[];
+    get commands(): Command.Loadable[];
     get commandIDs(): string[];
     get topics(): Topic[];
     s3Key(type: keyof PJSON.S3.Templates, ext?: '.tar.gz' | '.tar.xz' | IConfig.s3Key.Options, options?: IConfig.s3Key.Options): string;
@@ -126,7 +126,7 @@ export declare class Config implements IConfig {
      * plugin as discovered (will not change the order)
      *
      * @param commands commands to determine the priority of
-     * @returns command instance {Command.Plugin} or undefined
+     * @returns command instance {Command.Loadable} or undefined
      */
     private determinePriority;
 }

package/lib/config/config.js

@@ -324,7 +324,7 @@ class Config {
     }
     /**
      * Returns an array of all commands. If flexible taxonomy is enabled then all permutations will be appended to the array.
-     * @returns Command.Plugin[]
+     * @returns Command.Loadable[]
      */
     getAllCommands() {
         const commands = [...this._commands.values()];
@@ -573,7 +573,7 @@ class Config {
      * plugin as discovered (will not change the order)
      *
      * @param commands commands to determine the priority of
-     * @returns command instance {Command.Plugin} or undefined
+     * @returns command instance {Command.Loadable} or undefined
      */
     determinePriority(commands) {
         var _a, _b;

package/lib/config/plugin.d.ts

@@ -14,7 +14,7 @@ export declare class Plugin implements IPlugin {
     alias: string;
     tag?: string;
     manifest: Manifest;
-    commands: Command.Plugin[];
+    commands: Command.Loadable[];
     hooks: {
         [k: string]: string[];
     };

package/lib/help/index.d.ts

@@ -20,11 +20,10 @@ export declare abstract class HelpBase extends HelpFormatter {
 export declare class Help extends HelpBase {
     protected CommandHelpClass: typeof CommandHelp;
     private get _topics();
-    protected get sortedCommands(): Interfaces.Command.Plugin[];
+    protected get sortedCommands(): Interfaces.Command.Loadable[];
     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>;
@@ -42,4 +41,5 @@ export declare class Help extends HelpBase {
      * @return {string} the readme help string for the given command
      */
     protected command(command: Interfaces.Command): string;
+    protected log(...args: string[]): void;
 }

package/lib/help/index.js

@@ -8,7 +8,6 @@ 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; } });
@@ -87,7 +86,7 @@ class Help extends HelpBase {
         const command = this.config.findCommand(subject);
         if (command) {
             if (command.hasDynamicHelp) {
-                const dynamicCommand = await (0, config_1.toCached)(await this.getDynamicCommand(command));
+                const dynamicCommand = await (0, config_1.toCached)(await command.load());
                 await this.showCommandHelp(dynamicCommand);
             }
             else {
@@ -110,16 +109,6 @@ class Help extends HelpBase {
         }
         (0, errors_1.error)(`Command ${subject} not found.`);
     }
-    async getDynamicCommand(command) {
-        var _a;
-        const plugin = new plugin_1.Plugin({ ignoreManifest: true, root: this.config.root, name: (_a = command.pluginAlias) !== null && _a !== void 0 ? _a : command.pluginName });
-        await plugin.load();
-        const cmd = await plugin.findCommand(command.id);
-        if (!cmd) {
-            throw new Error(`Command ${command.id} not found.`);
-        }
-        return cmd;
-    }
     async showCommandHelp(command) {
         var _a, _b, _c, _d;
         const name = command.id;
@@ -129,20 +118,20 @@ class Help extends HelpBase {
         const plugin = this.config.plugins.find(p => p.name === command.pluginName);
         const state = ((_b = (_a = this.config.pjson) === null || _a === void 0 ? void 0 : _a.oclif) === null || _b === void 0 ? void 0 : _b.state) || ((_d = (_c = plugin === null || plugin === void 0 ? void 0 : plugin.pjson) === null || _c === void 0 ? void 0 : _c.oclif) === null || _d === void 0 ? void 0 : _d.state) || command.state;
         if (state)
-            console.log(`This command is in ${state}.\n`);
+            this.log(`This command is in ${state}.\n`);
         const summary = this.summary(command);
         if (summary) {
-            console.log(summary + '\n');
+            this.log(summary + '\n');
         }
-        console.log(this.formatCommand(command));
-        console.log('');
+        this.log(this.formatCommand(command));
+        this.log('');
         if (subTopics.length > 0) {
-            console.log(this.formatTopics(subTopics));
-            console.log('');
+            this.log(this.formatTopics(subTopics));
+            this.log('');
         }
         if (subCommands.length > 0) {
-            console.log(this.formatCommands(subCommands));
-            console.log('');
+            this.log(this.formatCommands(subCommands));
+            this.log('');
         }
     }
     async showRootHelp() {
@@ -151,21 +140,21 @@ class Help extends HelpBase {
         let rootCommands = this.sortedCommands;
         const state = (_b = (_a = this.config.pjson) === null || _a === void 0 ? void 0 : _a.oclif) === null || _b === void 0 ? void 0 : _b.state;
         if (state)
-            console.log(`${this.config.bin} is in ${state}.\n`);
-        console.log(this.formatRoot());
-        console.log('');
+            this.log(`${this.config.bin} is in ${state}.\n`);
+        this.log(this.formatRoot());
+        this.log('');
         if (!this.opts.all) {
             rootTopics = rootTopics.filter(t => !t.name.includes(':'));
             rootCommands = rootCommands.filter(c => !c.id.includes(':'));
         }
         if (rootTopics.length > 0) {
-            console.log(this.formatTopics(rootTopics));
-            console.log('');
+            this.log(this.formatTopics(rootTopics));
+            this.log('');
         }
         if (rootCommands.length > 0) {
             rootCommands = rootCommands.filter(c => c.id);
-            console.log(this.formatCommands(rootCommands));
-            console.log('');
+            this.log(this.formatCommands(rootCommands));
+            this.log('');
         }
     }
     async showTopicHelp(topic) {
@@ -176,15 +165,15 @@ class Help extends HelpBase {
         const commands = this.sortedCommands.filter(c => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
         const state = (_b = (_a = this.config.pjson) === null || _a === void 0 ? void 0 : _a.oclif) === null || _b === void 0 ? void 0 : _b.state;
         if (state)
-            console.log(`This topic is in ${state}.\n`);
-        console.log(this.formatTopic(topic));
+            this.log(`This topic is in ${state}.\n`);
+        this.log(this.formatTopic(topic));
         if (subTopics.length > 0) {
-            console.log(this.formatTopics(subTopics));
-            console.log('');
+            this.log(this.formatTopics(subTopics));
+            this.log('');
         }
         if (commands.length > 0) {
-            console.log(this.formatCommands(commands));
-            console.log('');
+            this.log(this.formatCommands(commands));
+            this.log('');
         }
     }
     formatRoot() {
@@ -272,5 +261,8 @@ class Help extends HelpBase {
     command(command) {
         return this.formatCommand(command);
     }
+    log(...args) {
+        console.log(...args);
+    }
 }
 exports.Help = Help;

package/lib/interfaces/command.d.ts

@@ -1,5 +1,6 @@
 import { Config, LoadOptions } from './config';
 import { ArgInput, BooleanFlagProps, FlagInput, OptionFlagProps } from './parser';
+import { Plugin as IPlugin } from './plugin';
 export declare type Example = string | {
     description: string;
     command: string;
@@ -78,7 +79,7 @@ export declare namespace Command {
         _base: string;
     }
     interface Class extends Base {
-        plugin?: Plugin;
+        plugin?: IPlugin;
         flags?: FlagInput<any>;
         args?: ArgInput;
         strict: boolean;
@@ -89,6 +90,12 @@ export declare namespace Command {
     interface Instance {
         _run(argv: string[]): Promise<any>;
     }
+    interface Loadable extends Command {
+        load(): Promise<Class>;
+    }
+    /**
+     * @deprecated use Command.Loadable instead.
+     */
     interface Plugin extends Command {
         load(): Promise<Class>;
     }

package/lib/interfaces/config.d.ts

@@ -88,27 +88,27 @@ export interface Config {
     valid: boolean;
     flexibleTaxonomy?: boolean;
     topicSeparator: ':' | ' ';
-    readonly commands: Command.Plugin[];
+    readonly commands: Command.Loadable[];
     readonly topics: Topic[];
     readonly commandIDs: string[];
     runCommand<T = unknown>(id: string, argv?: string[]): Promise<T>;
-    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Plugin): Promise<T>;
+    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable): Promise<T>;
     runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number): Promise<Hook.Result<Hooks[T]['return']>>;
     getAllCommandIDs(): string[];
-    getAllCommands(): Command.Plugin[];
+    getAllCommands(): Command.Loadable[];
     findCommand(id: string, opts: {
         must: true;
-    }): Command.Plugin;
+    }): Command.Loadable;
     findCommand(id: string, opts?: {
         must: boolean;
-    }): Command.Plugin | undefined;
+    }): Command.Loadable | undefined;
     findTopic(id: string, opts: {
         must: true;
     }): Topic;
     findTopic(id: string, opts?: {
         must: boolean;
     }): Topic | undefined;
-    findMatches(id: string, argv: string[]): Command.Plugin[];
+    findMatches(id: string, argv: string[]): Command.Loadable[];
     scopedEnvVar(key: string): string | undefined;
     scopedEnvVarKey(key: string): string;
     scopedEnvVarTrue(key: string): boolean;

package/lib/interfaces/hooks.d.ts

@@ -54,7 +54,7 @@ export interface Hooks {
         options: {
             id: string;
             argv: string[];
-            matches: Command.Plugin[];
+            matches: Command.Loadable[];
         };
         return: unknown;
     };

package/lib/interfaces/plugin.d.ts

@@ -60,7 +60,7 @@ export interface Plugin {
      * if it appears to be an npm package but does not look like it's really a CLI plugin, this is set to false
      */
     valid: boolean;
-    commands: Command.Plugin[];
+    commands: Command.Loadable[];
     hooks: {
         [k: string]: string[];
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.6.3",
+  "version": "1.8.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -13,7 +13,7 @@
     "chalk": "^4.1.2",
     "clean-stack": "^3.0.1",
     "cli-progress": "^3.10.0",
-    "debug": "^4.3.3",
+    "debug": "^4.3.4",
     "ejs": "^3.1.6",
     "fs-extra": "^9.1.0",
     "get-package-type": "^0.1.0",
@@ -49,7 +49,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
-    "@types/lodash": "^4.14.178",
+    "@types/lodash": "^4.14.182",
     "@types/mocha": "^8.2.3",
     "@types/nock": "^11.1.0",
     "@types/node": "^15.14.9",