@oclif/plugin-commands 2.1.0 → 2.2.1

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.1 linux-x64 node-v18.12.0
 $ 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.1/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.1","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.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-commands/issues",
   "dependencies": {
@@ -12,10 +12,10 @@
     "@oclif/plugin-help": "^5.1.7",
     "@oclif/test": "^2.0.2",
     "@types/chai": "^4.1.6",
-    "@types/lodash": "^4.14.117",
+    "@types/lodash": "^4.14.186",
     "@types/mocha": "^8.0.0",
     "@types/nock": "^11.1.0",
-    "@types/node": "^14.0.14",
+    "@types/node": "^14.18.33",
     "chai": "^4.2.0",
     "eslint": "^7.3.1",
     "eslint-config-oclif": "^3.1.0",
@@ -61,4 +61,4 @@
     "version": "oclif readme && git add README.md",
     "build": "shx rm -rf lib && tsc"
   }
-}
+}

package/yarn.lock

@@ -663,10 +663,10 @@
   resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.3.tgz#bdfd69d61e464dcc81b25159c270d75a73c1a636"
   integrity sha512-Il2DtDVRGDcqjDtE+rF8iqg1CArehSK84HZJCT7AMITlyXRBpuPhqGLDQMowraqqu1coEaimg4ZOqggt6L6L+A==
 
-"@types/lodash@*", "@types/lodash@^4.14.117":
-  version "4.14.170"
-  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.170.tgz#0d67711d4bf7f4ca5147e9091b847479b87925d6"
-  integrity sha512-bpcvu/MKHHeYX+qeEN8GE7DIravODWdACVA1ctevD8CN24RhPZIKMn9ntfAsrvLfSX3cR5RrBKAbYm9bGs0A+Q==
+"@types/lodash@*", "@types/lodash@^4.14.186":
+  version "4.14.186"
+  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.186.tgz#862e5514dd7bd66ada6c70ee5fce844b06c8ee97"
+  integrity sha512-eHcVlLXP0c2FlMPm56ITode2AgLMSa6aJ05JTTbYbI+7EMkCEE5qk2E41d5g2lCVTqRe0GnnRFurmlCsDODrPw==
 
 "@types/minimatch@*", "@types/minimatch@^3.0.3":
   version "3.0.5"
@@ -685,16 +685,16 @@
   dependencies:
     nock "*"
 
-"@types/node@*", "@types/node@^14.0.14":
-  version "14.14.41"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.14.41.tgz#d0b939d94c1d7bd53d04824af45f1139b8c45615"
-  integrity sha512-dueRKfaJL4RTtSa7bWeTK1M+VH+Gns73oCgzvYfHZywRCoPSd8EkXBL0mZ9unPTveBn+D9phZBaxuzpwjWkW0g==
-
-"@types/node@^15.6.1":
+"@types/node@*", "@types/node@^15.6.1":
   version "15.14.9"
   resolved "https://registry.npmjs.org/@types/node/-/node-15.14.9.tgz#bc43c990c3c9be7281868bbc7b8fdd6e2b57adfa"
   integrity sha512-qjd88DrCxupx/kJD5yQgZdcYKZKSIGBVDIBE1/LTGcNm3d2Np/jxojkdePDdfnBHJc5W7vSMpbJ1aB7p/Py69A==
 
+"@types/node@^14.18.33":
+  version "14.18.33"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.18.33.tgz#8c29a0036771569662e4635790ffa9e057db379b"
+  integrity sha512-qelS/Ra6sacc4loe/3MSjXNL1dNQ/GjxNHVzuChwMfmk7HuycRLVQN2qNY3XahK+fZc5E2szqQSKUyAF0E+2bg==
+
 "@types/normalize-package-data@^2.4.0":
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.1.tgz#d3357479a0fdfdd5907fe67e17e0a85c906e1301"
@@ -3549,9 +3549,9 @@ min-document@^2.19.0:
     brace-expansion "^1.1.7"
 
 minimist@^1.1.0, minimist@^1.1.3, minimist@^1.2.3, minimist@^1.2.5:
-  version "1.2.5"
-  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
-  integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
+  version "1.2.7"
+  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.7.tgz#daa1c4d91f507390437c6a8bc01078e7000c4d18"
+  integrity sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==
 
 minipass-collect@^1.0.2:
   version "1.0.2"

package/CHANGELOG.md

@@ -1,78 +0,0 @@
-# Changelog
-
-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.1.0](https://github.com/oclif/plugin-commands/compare/v2.0.2...v2.1.0) (2022-01-28)
-
-
-### Features
-
-* remove cli-ux ([#257](https://github.com/oclif/plugin-commands/issues/257)) ([91d8696](https://github.com/oclif/plugin-commands/commit/91d8696bff375e622092744ab005daabf12c34d2))
-
-### [2.0.2](https://github.com/oclif/plugin-commands/compare/v2.0.0...v2.0.2) (2022-01-03)
-
-
-### Bug Fixes
-
-* add summary and use configured command ([#217](https://github.com/oclif/plugin-commands/issues/217)) ([d1ce99e](https://github.com/oclif/plugin-commands/commit/d1ce99eb233155e019a585177972188953b0ffaf))
-* build error ([6cc7807](https://github.com/oclif/plugin-commands/commit/6cc780725e5dbb64fbc105206cc580bf45325749))
-* bump deps ([#234](https://github.com/oclif/plugin-commands/issues/234)) ([04c903d](https://github.com/oclif/plugin-commands/commit/04c903d45a51987f6262628c7a401481dc237145))
-* bump deps and fix tests ([#236](https://github.com/oclif/plugin-commands/issues/236)) ([064da3f](https://github.com/oclif/plugin-commands/commit/064da3f22778c9625c640012b883eee8c1528ab1))
-* bump-deps ([#235](https://github.com/oclif/plugin-commands/issues/235)) ([55b3e59](https://github.com/oclif/plugin-commands/commit/55b3e59e0743078d2bf81bfa75a56ebd0b746c4b))
-* use enableJsonFlag to enable json output ([#253](https://github.com/oclif/plugin-commands/issues/253)) ([5c839bc](https://github.com/oclif/plugin-commands/commit/5c839bc3d5b079c3080858ca4bc704283ff9d345))
-
-## [1.2.2](https://github.com/oclif/plugin-commands/compare/v1.2.1...v1.2.2) (2018-10-13)
-
-
-### Bug Fixes
-
-* remove greenkeeper badge ([2bf582a](https://github.com/oclif/plugin-commands/commit/2bf582a))
-
-## [1.2.1](https://github.com/oclif/plugin-commands/compare/v1.2.0...v1.2.1) (2018-09-14)
-
-
-### Bug Fixes
-
-* updated deps ([adf0726](https://github.com/oclif/plugin-commands/commit/adf0726))
-
-# [1.2.0](https://github.com/oclif/plugin-commands/compare/v1.1.3...v1.2.0) (2018-08-17)
-
-
-### Features
-
-* typescript 3 ([8267ff5](https://github.com/oclif/plugin-commands/commit/8267ff5))
-
-<a name="1.1.1"></a>
-## [1.1.1](https://github.com/oclif/plugin-commands/compare/v1.1.0...v1.1.1) (2018-06-01)
-
-
-### Bug Fixes
-
-* updated deps ([22d6a13](https://github.com/oclif/plugin-commands/commit/22d6a13))
-
-<a name="1.1.0"></a>
-# [1.1.0](https://github.com/oclif/plugin-commands/compare/v1.0.0...v1.1.0) (2018-05-31)
-
-
-### Features
-
-* add --hidden flag ([e6b9424](https://github.com/oclif/plugin-commands/commit/e6b9424))
-
-<a name="1.0.0"></a>
-# 1.0.0 (2018-05-31)
-
-
-### Bug Fixes
-
-* updated deps ([ef81977](https://github.com/oclif/plugin-commands/commit/ef81977))
-
-
-### Features
-
-* init ([03864cc](https://github.com/oclif/plugin-commands/commit/03864cc))
-* sort commands by id ([9cb157a](https://github.com/oclif/plugin-commands/commit/9cb157a))
-
-
-### BREAKING CHANGES
-
-* v1