@oclif/plugin-commands 4.0.16 → 4.1.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @oclif/plugin-commands
 $ oclif-example COMMAND
 running command...
 $ oclif-example (--version)
-@oclif/plugin-commands/4.0.16 linux-x64 node-v20.17.0
+@oclif/plugin-commands/4.1.0 linux-x64 node-v20.17.0
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
@@ -61,7 +61,7 @@ DESCRIPTION
   List all oclif-example commands.
 ```
 
-_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v4.0.16/src/commands/commands.ts)_
+_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v4.1.0/src/commands/commands.ts)_
 <!-- commandsstop -->
 
 # Contributing

package/lib/commands/commands.js

@@ -1,8 +1,8 @@
 import { Command, Flags, toConfiguredId } from '@oclif/core';
+import { printTable } from '@oclif/table';
 import _ from 'lodash';
 // @ts-expect-error because object-treeify does not have types: https://github.com/blackflux/object-treeify/issues/1077
 import treeify from 'object-treeify';
-import TtyTable from 'tty-table';
 const COLUMNS = ['id', 'plugin', 'summary', 'type'];
 function createTree(commands) {
     const tree = {};
@@ -16,20 +16,10 @@ function createTree(commands) {
     }
     return tree;
 }
-function determineHeaders(columns, extended) {
-    const columnConfigs = {
-        id: { align: 'left', value: 'ID', width: '25%' },
-        plugin: { align: 'left', value: 'Plugin' },
-        summary: { align: 'left', value: 'Summary', width: '75%' },
-        type: { align: 'left', value: 'Type' },
-    };
-    if (columns) {
-        return columns.map((column) => columnConfigs[column]);
-    }
-    if (extended) {
-        return [columnConfigs.id, columnConfigs.summary, columnConfigs.plugin, columnConfigs.type];
-    }
-    return [columnConfigs.id, columnConfigs.summary];
+function mergePrototype(result, command) {
+    const proto = Object.getPrototypeOf(command);
+    const filteredProto = _.pickBy(proto, (v) => v !== undefined);
+    return Object.keys(proto).length > 0 ? mergePrototype({ ...filteredProto, ...result }, proto) : result;
 }
 export default class Commands extends Command {
     static description = 'List all <%= config.bin %> commands.';
@@ -78,34 +68,22 @@ export default class Commands extends Command {
             const tree = createTree(commands);
             this.log(treeify(tree));
         }
-        else {
-            const headers = determineHeaders(flags.columns, flags.extended);
-            const extractData = (command) => headers.map((header) => {
-                switch (header.value) {
-                    case 'ID': {
-                        return toConfiguredId(command.id, config);
-                    }
-                    case 'Plugin': {
-                        return command.pluginName;
-                    }
-                    case 'Type': {
-                        return command.pluginType;
-                    }
-                    case 'Summary': {
-                        return command.summary ?? command.description;
-                    }
-                    default: {
-                        throw new Error('Unknown column');
-                    }
-                }
+        else if (!this.jsonEnabled()) {
+            printTable({
+                borderStyle: 'vertical-with-outline',
+                columns: (flags.columns ?? ['id', 'summary', ...(flags.extended ? ['plugin', 'type'] : [])]),
+                data: commands.map((c) => ({
+                    id: toConfiguredId(c.id, config),
+                    plugin: c.pluginName,
+                    summary: c.summary ?? c.description,
+                    type: c.pluginType,
+                })),
+                headerOptions: {
+                    formatter: 'capitalCase',
+                },
+                overflow: flags['no-truncate'] ? 'wrap' : 'truncate',
+                sort: { [flags.sort]: 'asc' },
             });
-            // eslint-disable-next-line new-cap
-            const table = TtyTable(headers, commands.map((c) => extractData(c)), {
-                compact: true,
-                defaultValue: '',
-                truncate: flags['no-truncate'] ? undefined : '...',
-            });
-            this.log(table.render());
         }
         const json = _.uniqBy(await Promise.all(commands.map(async (cmd) => {
             let commandClass;
@@ -114,16 +92,9 @@ export default class Commands extends Command {
             }
             catch (error) {
                 this.debug(error);
+                return cmd;
             }
-            const obj = { ...cmd, ...commandClass };
-            // Load all properties on all extending classes.
-            while (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));
-            }
+            const obj = { ...mergePrototype(commandClass, commandClass), ...cmd };
             // 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.

package/oclif.manifest.json

@@ -105,5 +105,5 @@
       ]
     }
   },
-  "version": "4.0.16"
+  "version": "4.1.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@oclif/plugin-commands",
   "description": "plugin to show the list of all the commands",
-  "version": "4.0.16",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-commands/issues",
   "dependencies": {
     "@oclif/core": "^4",
+    "@oclif/table": "^0.1.12",
     "lodash": "^4.17.21",
-    "object-treeify": "^4.0.1",
-    "tty-table": "^4.2.3"
+    "object-treeify": "^4.0.1"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19",
@@ -30,7 +30,7 @@
     "lint-staged": "^15",
     "mocha": "^10.7.3",
     "nyc": "^15.1.0",
-    "oclif": "^4.14.34",
+    "oclif": "^4.14.35",
     "prettier": "^3.3.3",
     "shx": "^0.3.3",
     "sinon": "^18.0.1",