@oclif/plugin-help 3.0.1 → 3.2.2

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [3.2.2](https://github.com/oclif/plugin-help/compare/v3.2.1...v3.2.2) (2021-02-03)
+
+
+### Bug Fixes
+
+* avoid recomputing topics in loop ([#189](https://github.com/oclif/plugin-help/issues/189)) ([eccb862](https://github.com/oclif/plugin-help/commit/eccb862e725f28d305de5cccde109c15abbb5f98)), closes [#101](https://github.com/oclif/plugin-help/issues/101)
+
+## [3.2.1](https://github.com/oclif/plugin-help/compare/v3.2.0...v3.2.1) (2020-12-14)
+
+
+### Bug Fixes
+
+* move oclif/errors to dependencies ([#179](https://github.com/oclif/plugin-help/issues/179)) ([a5e8320](https://github.com/oclif/plugin-help/commit/a5e8320ce480c55ba7800a8a9f444e681dee7a76))
+
+# [3.2.0](https://github.com/oclif/plugin-help/compare/v3.1.0...v3.2.0) (2020-08-03)
+
+
+### Features
+
+* support src/command/index cmd ([#112](https://github.com/oclif/plugin-help/issues/112)) ([8957336](https://github.com/oclif/plugin-help/commit/8957336f3c35675bb243ac90c49c298fbef23e59))
+
 ## [2.1.4](https://github.com/oclif/plugin-help/compare/v2.1.3...v2.1.4) (2018-11-12)
 
 

package/lib/command.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = require("chalk");
+const chalk = require("chalk");
 const indent = require("indent-string");
 const stripAnsi = require("strip-ansi");
 const list_1 = require("./list");
 const util_1 = require("./util");
-const { underline, bold, } = chalk_1.default;
-let { dim, } = chalk_1.default;
+const { underline, bold, } = chalk;
+let { dim, } = chalk;
 if (process.env.ConEmuANSI === 'ON') {
-    dim = chalk_1.default.gray;
+    dim = chalk.gray;
 }
 const wrap = require('wrap-ansi');
 class CommandHelp {

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import * as Config from '@oclif/config';
-export { getHelpClass } from './util';
+import { getHelpClass } from './util';
 export interface HelpOptions {
     all?: boolean;
     maxWidth: number;
@@ -43,3 +43,4 @@ export default class Help extends HelpBase {
      */
     protected command(command: Config.Command): string;
 }
+export { Help, getHelpClass, };

package/lib/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const errors_1 = require("@oclif/errors");
-const chalk_1 = require("chalk");
+const chalk = require("chalk");
 const indent = require("indent-string");
 const stripAnsi = require("strip-ansi");
 const command_1 = require("./command");
@@ -9,18 +9,19 @@ const list_1 = require("./list");
 const root_1 = require("./root");
 const screen_1 = require("./screen");
 const util_1 = require("./util");
-var util_2 = require("./util");
+const util_2 = require("./util");
 exports.getHelpClass = util_2.getHelpClass;
 const wrap = require('wrap-ansi');
-const { bold, } = chalk_1.default;
+const { bold, } = chalk;
+const ROOT_INDEX_CMD_ID = '';
 function getHelpSubject(args) {
     for (const arg of args) {
         if (arg === '--')
             return;
-        if (arg.startsWith('-'))
-            continue;
-        if (arg === 'help')
+        if (arg === 'help' || arg === '--help' || arg === '-h')
             continue;
+        if (arg.startsWith('-'))
+            return;
         return arg;
     }
 }
@@ -43,9 +44,12 @@ class Help extends HelpBase {
      * and this can be removed.
      */
     get _topics() {
-        return this.config.topics.filter((topic) => {
+        // since this.config.topics is a getter that does non-trivial work, cache it outside the filter loop for
+        // performance benefits in the presence of large numbers of topics
+        const topics = this.config.topics;
+        return topics.filter((topic) => {
             // it is assumed a topic has a child if it has children
-            const hasChild = this.config.topics.some(subTopic => subTopic.name.includes(`${topic.name}:`));
+            const hasChild = topics.some(subTopic => subTopic.name.includes(`${topic.name}:`));
             return hasChild;
         });
     }
@@ -66,6 +70,9 @@ class Help extends HelpBase {
     showHelp(argv) {
         const subject = getHelpSubject(argv);
         if (!subject) {
+            const rootCmd = this.config.findCommand(ROOT_INDEX_CMD_ID);
+            if (rootCmd)
+                this.showCommandHelp(rootCmd);
             this.showRootHelp();
             return;
         }
@@ -114,6 +121,7 @@ class Help extends HelpBase {
             console.log('');
         }
         if (rootCommands.length > 0) {
+            rootCommands = rootCommands.filter(c => c.id);
             console.log(this.formatCommands(rootCommands));
             console.log('');
         }
@@ -202,3 +210,4 @@ class Help extends HelpBase {
     }
 }
 exports.default = Help;
+exports.Help = Help;

package/lib/root.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = require("chalk");
+const chalk = require("chalk");
 const indent = require("indent-string");
 const stripAnsi = require("strip-ansi");
 const util_1 = require("./util");
 const wrap = require('wrap-ansi');
-const { bold, } = chalk_1.default;
+const { bold, } = chalk;
 class RootHelp {
     constructor(config, opts) {
         this.config = config;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.0.1","commands":{"help":{"id":"help","description":"display help for <%= config.bin %>","pluginName":"@oclif/plugin-help","pluginType":"core","aliases":[],"flags":{"all":{"name":"all","type":"boolean","description":"see all commands in CLI","allowNo":false}},"args":[{"name":"command","description":"command to show help for","required":false}]}}}
+{"version":"3.2.2","commands":{"help":{"id":"help","description":"display help for <%= config.bin %>","pluginName":"@oclif/plugin-help","pluginType":"core","aliases":[],"flags":{"all":{"name":"all","type":"boolean","description":"see all commands in CLI","allowNo":false}},"args":[{"name":"command","description":"command to show help for","required":false}]}}}

package/package.json

@@ -1,42 +1,42 @@
 {
   "name": "@oclif/plugin-help",
   "description": "standard help for oclif",
-  "version": "3.0.1",
+  "version": "3.2.2",
   "author": "Jeff Dickey @jdxcode",
   "bugs": "https://github.com/oclif/plugin-help/issues",
   "dependencies": {
     "@oclif/command": "^1.5.20",
     "@oclif/config": "^1.15.1",
-    "chalk": "^2.4.1",
+    "@oclif/errors": "^1.2.2",
+    "chalk": "^4.1.0",
     "indent-string": "^4.0.0",
     "lodash.template": "^4.4.0",
-    "string-width": "^3.0.0",
-    "strip-ansi": "^5.0.0",
-    "widest-line": "^2.0.1",
+    "string-width": "^4.2.0",
+    "strip-ansi": "^6.0.0",
+    "widest-line": "^3.1.0",
     "wrap-ansi": "^4.0.0"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.21.0",
-    "@oclif/errors": "^1.2.2",
     "@oclif/plugin-legacy": "^1.1.3",
     "@oclif/plugin-plugins": "^1.7.6",
     "@oclif/test": "^1.2.2",
     "@types/chai": "^4.1.7",
     "@types/lodash.template": "^4.4.4",
-    "@types/mocha": "^5.2.5",
-    "@types/node": "^8.10.59",
-    "@types/strip-ansi": "^3.0.0",
+    "@types/mocha": "^8.0.0",
+    "@types/node": "^14.0.14",
+    "@types/strip-ansi": "^5.2.1",
     "@types/wrap-ansi": "^3.0.0",
     "chai": "^4.2.0",
-    "eslint": "^6.6.0",
+    "eslint": "^7.3.1",
     "eslint-config-oclif": "^3.1.0",
-    "eslint-config-oclif-typescript": "^0.1.0",
-    "globby": "^9.0.0",
-    "mocha": "^5.2.0",
-    "nock": "^12.0.3",
+    "eslint-config-oclif-typescript": "^0.2.0",
+    "globby": "^11.0.1",
+    "mocha": "^8.2.1",
+    "nock": "^13.0.0",
     "sinon": "^9.0.1",
-    "ts-node": "^8.8.2",
-    "typescript": "^3.8.3"
+    "ts-node": "^9.1.1",
+    "typescript": "3.8.3"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -63,7 +63,7 @@
   "scripts": {
     "build": "rm -rf lib && tsc",
     "lint": "eslint . --ext .ts --config .eslintrc",
-    "pretest": "tsc -p test --noEmit",
+    "pretest": "yarn build --noEmit && tsc -p test --noEmit",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "posttest": "yarn lint",
     "prepack": "yarn run build && oclif-dev manifest",