@oclif/plugin-commands 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+## [2.2.0](https://github.com/oclif/plugin-commands/compare/v2.1.0...v2.2.0) (2022-06-17)
+
+
+### Features
+
+* add a tree view for commands ([#292](https://github.com/oclif/plugin-commands/issues/292)) ([0ea4028](https://github.com/oclif/plugin-commands/commit/0ea402853f89507db41fce2adcdab99e33c14cf7))
+
 ## [2.1.0](https://github.com/oclif/plugin-commands/compare/v2.0.2...v2.1.0) (2022-01-28)
 
 

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @oclif/plugin-commands
 $ oclif-example COMMAND
 running command...
 $ oclif-example (--version)
-@oclif/plugin-commands/2.1.0 linux-x64 node-v12.22.9
+@oclif/plugin-commands/2.2.0 linux-x64 node-v14.19.3
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
@@ -37,8 +37,8 @@ list all the commands
 
 ```
 USAGE
-  $ oclif-example commands [--json] [-h] [--hidden] [--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] [--sort <value>]
+    [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
 
 FLAGS
   -h, --help         Show CLI help.
@@ -52,6 +52,7 @@ FLAGS
   --output=<option>  output in a more machine friendly format
                      <options: csv|json|yaml>
   --sort=<value>     property to sort by (prepend '-' for descending)
+  --tree             show tree of commands
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -60,5 +61,5 @@ DESCRIPTION
   list all the commands
 ```
 
-_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v2.1.0/src/commands/commands.ts)_
+_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v2.2.0/src/commands/commands.ts)_
 <!-- commandsstop -->

package/lib/commands/commands.d.ts

@@ -3,7 +3,7 @@ export default class Commands extends Command {
     static description: string;
     static enableJsonFlag: boolean;
     static flags: any;
-    run(): Promise<unknown[] | undefined>;
+    run(): Promise<unknown[] | import("@oclif/core/lib/cli-ux/styled/tree").Tree | undefined>;
     private getCommands;
     private removeCycles;
 }

package/lib/commands/commands.js

@@ -3,6 +3,7 @@ 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 {
     async run() {
         const { flags } = await this.parse(Commands);
@@ -19,7 +20,7 @@ class Commands extends core_1.Command {
             command.id = (0, core_1.toConfiguredId)(command.id, this.config);
             return command;
         });
-        if (this.jsonEnabled()) {
+        if (this.jsonEnabled() && !flags.tree) {
             const formatted = await Promise.all(commands.map(async (cmd) => {
                 let commandClass = await cmd.load();
                 const obj = Object.assign(Object.assign({}, cmd), commandClass);
@@ -35,6 +36,13 @@ class Commands extends core_1.Command {
             }));
             return formatted;
         }
+        if (flags.tree) {
+            const tree = (0, tree_1.default)(commands, this.config.topicSeparator);
+            if (!this.jsonEnabled()) {
+                tree.display();
+            }
+            return tree;
+        }
         core_1.CliUx.ux.table(commands.map(command => {
             // Massage some fields so it looks good in the table
             command.description = (command.description || '').split(os_1.EOL)[0];
@@ -105,4 +113,4 @@ class Commands extends core_1.Command {
 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' }) }, core_1.CliUx.ux.table.flags());
+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.CliUx.ux.table.flags());

package/lib/utils/tree.d.ts

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

package/lib/utils/tree.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@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
+    if (existingNode && commandParts[1]) {
+        addNodes(existingNode, commandParts.slice(1));
+    }
+    else {
+        // The node doesn't exist, create it
+        tree.insert(commandParts[0]);
+        // If there are more parts, add them to the node
+        if (commandParts.length > 1) {
+            addNodes(tree.search(commandParts[0]), commandParts.slice(1));
+        }
+    }
+};
+const createCommandTree = (commands, topicSeparator = ':') => {
+    const tree = core_1.CliUx.ux.tree();
+    commands.forEach(command => {
+        const commandParts = command.id.split(topicSeparator);
+        addNodes(tree, commandParts);
+    });
+    return tree;
+};
+exports.default = createCommandTree;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.0","commands":{"commands":{"id":"commands","description":"list all the commands","strict":true,"pluginName":"@oclif/plugin-commands","pluginAlias":"@oclif/plugin-commands","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"columns":{"name":"columns","type":"option","description":"only show provided columns (comma-separated)","multiple":false,"exclusive":["extended"]},"sort":{"name":"sort","type":"option","description":"property to sort by (prepend '-' for descending)","multiple":false},"filter":{"name":"filter","type":"option","description":"filter property by partial string matching, ex: name=foo","multiple":false},"csv":{"name":"csv","type":"boolean","description":"output is csv format [alias: --output=csv]","allowNo":false,"exclusive":["no-truncate"]},"output":{"name":"output","type":"option","description":"output in a more machine friendly format","multiple":false,"options":["csv","json","yaml"],"exclusive":["no-truncate","csv"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"show extra columns","allowNo":false,"exclusive":["columns"]},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false,"exclusive":["csv"]},"no-header":{"name":"no-header","type":"boolean","description":"hide table header from output","allowNo":false,"exclusive":["csv"]}},"args":[],"enableJsonFlag":true}}}
+{"version":"2.2.0","commands":{"commands":{"id":"commands","description":"list all the commands","strict":true,"pluginName":"@oclif/plugin-commands","pluginAlias":"@oclif/plugin-commands","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"tree":{"name":"tree","type":"boolean","description":"show tree of commands","allowNo":false},"columns":{"name":"columns","type":"option","description":"only show provided columns (comma-separated)","multiple":false,"exclusive":["extended"]},"sort":{"name":"sort","type":"option","description":"property to sort by (prepend '-' for descending)","multiple":false},"filter":{"name":"filter","type":"option","description":"filter property by partial string matching, ex: name=foo","multiple":false},"csv":{"name":"csv","type":"boolean","description":"output is csv format [alias: --output=csv]","allowNo":false,"exclusive":["no-truncate"]},"output":{"name":"output","type":"option","description":"output in a more machine friendly format","multiple":false,"options":["csv","json","yaml"],"exclusive":["no-truncate","csv"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"show extra columns","allowNo":false,"exclusive":["columns"]},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false,"exclusive":["csv"]},"no-header":{"name":"no-header","type":"boolean","description":"hide table header from output","allowNo":false,"exclusive":["csv"]}},"args":[],"enableJsonFlag":true}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/plugin-commands",
   "description": "plugin to show the list of all the commands",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-commands/issues",
   "dependencies": {