@oclif/plugin-commands 2.2.28 → 3.0.2

package/README.md

@@ -1,33 +1,35 @@
-@oclif/plugin-commands
-======================
+# @oclif/plugin-commands
 
 plugin to show the list of all the commands
 
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-commands/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-commands/tree/main)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-commands?branch=main&svg=true)](https://ci.appveyor.com/project/oclif/plugin-commands/branch/main)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
 [![License](https://img.shields.io/npm/l/@oclif/plugin-commands.svg)](https://github.com/oclif/plugin-commands/blob/main/package.json)
 
 <!-- toc -->
+* [@oclif/plugin-commands](#oclifplugin-commands)
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
+
 # Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @oclif/plugin-commands
 $ oclif-example COMMAND
 running command...
 $ oclif-example (--version)
-@oclif/plugin-commands/2.2.28 linux-x64 node-v18.18.0
+@oclif/plugin-commands/3.0.2 linux-x64 node-v18.18.0
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
 ...
 ```
 <!-- usagestop -->
+
 # Commands
+
 <!-- commands -->
 * [`oclif-example commands`](#oclif-example-commands)
 
@@ -37,8 +39,8 @@ list all the commands
 
 ```
 USAGE
-  $ oclif-example commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>]
-    [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
+  $ oclif-example commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
+    [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]
 
 FLAGS
   -h, --help         Show CLI help.
@@ -61,5 +63,5 @@ DESCRIPTION
   list all the commands
 ```
 
-_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v2.2.28/src/commands/commands.ts)_
+_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v3.0.2/src/commands/commands.ts)_
 <!-- commandsstop -->

package/lib/commands/commands.d.ts

@@ -3,19 +3,19 @@ export default class Commands extends Command {
     static description: string;
     static enableJsonFlag: boolean;
     static flags: {
-        columns: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        sort: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        filter: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        csv: import("@oclif/core/lib/interfaces").Flag<boolean>;
-        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        extended: import("@oclif/core/lib/interfaces").Flag<boolean>;
-        'no-truncate': import("@oclif/core/lib/interfaces").Flag<boolean>;
-        'no-header': import("@oclif/core/lib/interfaces").Flag<boolean>;
-        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
-        hidden: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        tree: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        columns: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined>;
+        csv: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        extended: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        filter: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined>;
+        'no-header': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        'no-truncate': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined>;
+        sort: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined>;
+        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        hidden: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        tree: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    run(): Promise<unknown[] | import("@oclif/core/lib/cli-ux/styled/tree").Tree | undefined>;
+    run(): Promise<unknown[] | import("@oclif/core/lib/cli-ux/styled/tree.js").Tree | undefined>;
     private getCommands;
     private removeCycles;
 }

package/lib/commands/commands.js

@@ -1,76 +1,85 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@oclif/core");
-const _ = require("lodash");
-const os_1 = require("os");
-const tree_1 = require("../utils/tree");
-class Commands extends core_1.Command {
+import { Command, Flags, toConfiguredId, ux } from '@oclif/core';
+import pickBy from 'lodash.pickby';
+import sortBy from 'lodash.sortby';
+import template from 'lodash.template';
+import uniqBy from 'lodash.uniqby';
+import { EOL } from 'node:os';
+import createCommandTree from '../utils/tree.js';
+export default class Commands extends Command {
+    static description = 'list all the commands';
+    static enableJsonFlag = true;
+    static flags = {
+        help: Flags.help({ char: 'h' }),
+        hidden: Flags.boolean({ description: 'show hidden commands' }),
+        tree: Flags.boolean({ description: 'show tree of commands' }),
+        ...ux.table.flags(),
+    };
     async run() {
         const { flags } = await this.parse(Commands);
         let commands = this.getCommands();
         if (!flags.hidden) {
-            commands = commands.filter(c => !c.hidden);
+            commands = commands.filter((c) => !c.hidden);
         }
-        const config = this.config;
-        commands = _.sortBy(commands, 'id').map(command => {
+        const { config } = this;
+        commands = sortBy(commands, 'id').map((command) => {
             // Template supported fields.
-            command.description = (typeof command.description === 'string' && _.template(command.description)({ command, config })) || undefined;
-            command.summary = (typeof command.summary === 'string' && _.template(command.summary)({ command, config })) || undefined;
-            command.usage = (typeof command.usage === 'string' && _.template(command.usage)({ command, config })) || undefined;
-            command.id = (0, core_1.toConfiguredId)(command.id, this.config);
+            command.description =
+                (typeof command.description === 'string' && template(command.description)({ command, config })) || undefined;
+            command.summary =
+                (typeof command.summary === 'string' && template(command.summary)({ command, config })) || undefined;
+            command.usage = (typeof command.usage === 'string' && template(command.usage)({ command, config })) || undefined;
+            command.id = toConfiguredId(command.id, config);
             return command;
         });
         if (this.jsonEnabled() && !flags.tree) {
             const formatted = await Promise.all(commands.map(async (cmd) => {
-                // @ts-expect-error
-                let commandClass = {};
+                let commandClass;
                 try {
                     commandClass = await cmd.load();
                 }
                 catch (error) {
                     this.debug(error);
                 }
-                const obj = Object.assign(Object.assign({}, cmd), commandClass);
+                const obj = { ...cmd, ...commandClass };
                 // Load all properties on all extending classes.
                 while (commandClass !== undefined) {
-                    commandClass = Object.getPrototypeOf(commandClass) || undefined;
+                    commandClass = Object.getPrototypeOf(commandClass) ?? undefined;
                     // ES2022 will return all unset static properties on the prototype as undefined. This is different from ES2021
                     // which only returns the static properties that are set by defaults. In order to prevent
                     // Object.assign from overwriting the properties on the object, we need to filter out the undefined values.
-                    Object.assign(obj, _.pickBy(commandClass, v => v !== undefined));
+                    Object.assign(obj, pickBy(commandClass, (v) => v !== undefined));
                 }
                 // The plugin property on the loaded class contains a LOT of information including all the commands again. Remove it.
                 delete obj.plugin;
                 // If Command classes have circular references, don't break the commands command.
                 return this.removeCycles(obj);
             }));
-            return _.uniqBy(formatted, 'id');
+            return uniqBy(formatted, 'id');
         }
         if (flags.tree) {
-            const tree = (0, tree_1.default)(commands, this.config.topicSeparator);
+            const tree = createCommandTree(commands, config.topicSeparator);
             if (!this.jsonEnabled()) {
                 tree.display();
             }
             return tree;
         }
-        core_1.ux.table(commands.map(command => {
+        ux.table(commands.map((command) => {
             // Massage some fields so it looks good in the table
-            command.description = (command.description || '').split(os_1.EOL)[0];
-            command.summary = (command.summary || (command.description || '').split(os_1.EOL)[0]);
+            command.description = (command.description ?? '').split(EOL)[0];
+            command.summary = command.summary ?? (command.description ?? '').split(EOL)[0];
             command.hidden = Boolean(command.hidden);
-            command.usage = (command.usage || '');
+            command.usage ??= '';
             return command;
         }), {
-            id: {
-                header: 'Command',
-            },
-            summary: {},
             description: {
                 extended: true,
             },
-            usage: {
+            hidden: {
                 extended: true,
             },
+            id: {
+                header: 'Command',
+            },
             pluginName: {
                 extended: true,
                 header: 'Plugin',
@@ -79,10 +88,15 @@ class Commands extends core_1.Command {
                 extended: true,
                 header: 'Type',
             },
-            hidden: {
+            summary: {},
+            usage: {
                 extended: true,
             },
-        }, Object.assign({}, flags));
+        }, {
+            // to-do: investigate this oclif/core error when printLine is enabled
+            // printLine: this.log,
+            ...flags, // parsed flags
+        });
     }
     getCommands() {
         return this.config.commands;
@@ -95,10 +109,9 @@ class Commands extends core_1.Command {
             if (Object.prototype.toString.call(obj) === '[object Object]') {
                 // We know it is a "Dictionary" because of the conditional
                 const dictionary = obj;
-                if (seenObjects.has(dictionary)) {
-                    // Seen, return undefined to remove.
-                    return undefined;
-                }
+                // Seen, return undefined to remove.
+                if (seenObjects.has(dictionary))
+                    return;
                 seenObjects.set(dictionary, undefined);
                 for (const key in dictionary) {
                     // Delete the duplicate object if cycle found.
@@ -120,7 +133,3 @@ class Commands extends core_1.Command {
         return _removeCycles(object);
     }
 }
-exports.default = Commands;
-Commands.description = 'list all the commands';
-Commands.enableJsonFlag = true;
-Commands.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), hidden: core_1.Flags.boolean({ description: 'show hidden commands' }), tree: core_1.Flags.boolean({ description: 'show tree of commands' }) }, core_1.ux.table.flags());

package/lib/index.js

@@ -1,3 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {};
+export default {};

package/lib/utils/tree.d.ts

@@ -1,4 +1,3 @@
 import { Command } from '@oclif/core';
-import { Tree } from '@oclif/core/lib/cli-ux/styled/tree';
-declare const createCommandTree: (commands: Command.Loadable[], topicSeparator?: string) => Tree;
+declare const createCommandTree: (commands: Command.Loadable[], topicSeparator?: string) => import("@oclif/core/lib/cli-ux/styled/tree.js").Tree;
 export default createCommandTree;

package/lib/utils/tree.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@oclif/core");
+import { ux } from '@oclif/core';
 const addNodes = (tree, commandParts) => {
     const existingNode = tree.search(commandParts[0]);
     // If the node exists and there's another part, add it to the node
@@ -17,11 +15,11 @@ const addNodes = (tree, commandParts) => {
     }
 };
 const createCommandTree = (commands, topicSeparator = ':') => {
-    const tree = core_1.ux.tree();
-    commands.forEach(command => {
+    const tree = ux.tree();
+    for (const command of commands) {
         const commandParts = command.id.split(topicSeparator);
         addNodes(tree, commandParts);
-    });
+    }
     return tree;
 };
-exports.default = createCommandTree;
+export default createCommandTree;