@oclif/plugin-help 3.0.0-rc1.2 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [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/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

@@ -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 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;
     }
 }
@@ -66,6 +67,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 +118,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 +207,4 @@ class Help extends HelpBase {
     }
 }
 exports.default = Help;
+exports.Help = Help;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.0.0-rc1.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}]}}}
+{"version":"3.2.0","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,7 +1,7 @@
 {
   "name": "@oclif/plugin-help",
   "description": "standard help for oclif",
-  "version": "3.0.0-rc1.2",
+  "version": "3.2.0",
   "author": "Jeff Dickey @jdxcode",
   "bugs": "https://github.com/oclif/plugin-help/issues",
   "dependencies": {
@@ -10,9 +10,9 @@
     "chalk": "^2.4.1",
     "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": {
@@ -23,19 +23,20 @@
     "@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",
+    "eslint-config-oclif-typescript": "^0.2.0",
+    "globby": "^11.0.1",
     "mocha": "^5.2.0",
+    "nock": "^13.0.0",
     "sinon": "^9.0.1",
     "ts-node": "^8.8.2",
-    "typescript": "^3.8.3"
+    "typescript": "3.8.3"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -62,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",