@oclif/plugin-help 2.1.6 → 2.2.3

package/lib/command.js

@@ -5,7 +5,8 @@ const indent = require("indent-string");
 const stripAnsi = require("strip-ansi");
 const list_1 = require("./list");
 const util_1 = require("./util");
-let { underline, dim, bold, } = chalk_1.default;
+const { underline, bold, } = chalk_1.default;
+let { dim, } = chalk_1.default;
 if (process.env.ConEmuANSI === 'ON') {
     dim = chalk_1.default.gray;
 }
@@ -40,7 +41,7 @@ class CommandHelp {
     }
     usage(flags) {
         const usage = this.command.usage;
-        let body = (usage ? util_1.castArray(usage) : [this.defaultUsage(flags)])
+        const body = (usage ? util_1.castArray(usage) : [this.defaultUsage(flags)])
             .map(u => `$ ${this.config.bin} ${u}`.trim())
             .join('\n');
         return [
@@ -56,7 +57,7 @@ class CommandHelp {
     }
     description() {
         const cmd = this.command;
-        let description = cmd.description && this.render(cmd.description).split('\n').slice(1).join('\n');
+        const description = cmd.description && this.render(cmd.description).split('\n').slice(1).join('\n');
         if (!description)
             return;
         return [
@@ -65,27 +66,27 @@ class CommandHelp {
         ].join('\n');
     }
     aliases(aliases) {
-        if (!aliases || !aliases.length)
+        if (!aliases || aliases.length === 0)
             return;
-        let body = aliases.map(a => ['$', this.config.bin, a].join(' ')).join('\n');
+        const body = aliases.map(a => ['$', this.config.bin, a].join(' ')).join('\n');
         return [
             bold('ALIASES'),
             indent(wrap(body, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
         ].join('\n');
     }
     examples(examples) {
-        if (!examples || !examples.length)
+        if (!examples || examples.length === 0)
             return;
-        let body = util_1.castArray(examples).map(a => this.render(a)).join('\n');
+        const body = util_1.castArray(examples).map(a => this.render(a)).join('\n');
         return [
             bold('EXAMPLE' + (examples.length > 1 ? 'S' : '')),
             indent(wrap(body, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
         ].join('\n');
     }
     args(args) {
-        if (!args.filter(a => a.description).length)
+        if (args.filter(a => a.description).length === 0)
             return;
-        let body = list_1.renderList(args.map(a => {
+        const body = list_1.renderList(args.map(a => {
             const name = a.name.toUpperCase();
             let description = a.description || '';
             if (a.default)
@@ -100,27 +101,30 @@ class CommandHelp {
         ].join('\n');
     }
     arg(arg) {
-        let name = arg.name.toUpperCase();
+        const name = arg.name.toUpperCase();
         if (arg.required)
             return `${name}`;
         return `[${name}]`;
     }
     flags(flags) {
-        if (!flags.length)
+        if (flags.length === 0)
             return;
-        let body = list_1.renderList(flags.map(flag => {
-            const label = [];
-            if (flag.char)
-                label.push(`-${flag.char[0]}`);
-            if (flag.name) {
-                if (flag.type === 'boolean' && flag.allowNo) {
-                    label.push(`--[no-]${flag.name.trim()}`);
-                }
-                else {
-                    label.push(`--${flag.name.trim()}`);
+        const body = list_1.renderList(flags.map(flag => {
+            let left = flag.helpLabel;
+            if (!left) {
+                const label = [];
+                if (flag.char)
+                    label.push(`-${flag.char[0]}`);
+                if (flag.name) {
+                    if (flag.type === 'boolean' && flag.allowNo) {
+                        label.push(`--[no-]${flag.name.trim()}`);
+                    }
+                    else {
+                        label.push(`--${flag.name.trim()}`);
+                    }
                 }
+                left = label.join(', ');
             }
-            let left = label.join(', ');
             if (flag.type === 'option') {
                 let value = flag.helpValue || flag.name;
                 if (!flag.helpValue && flag.options) {

package/lib/commands/help.js

@@ -5,16 +5,16 @@ const __1 = require("..");
 class HelpCommand extends command_1.Command {
     async run() {
         const { flags, argv } = this.parse(HelpCommand);
-        let help = new __1.default(this.config, { all: flags.all });
+        const help = new __1.default(this.config, { all: flags.all });
         help.showHelp(argv);
     }
 }
+exports.default = HelpCommand;
 HelpCommand.description = 'display help for <%= config.bin %>';
 HelpCommand.flags = {
     all: command_1.flags.boolean({ description: 'see all commands in CLI' }),
 };
 HelpCommand.args = [
-    { name: 'command', required: false, description: 'command to show help for' }
+    { name: 'command', required: false, description: 'command to show help for' },
 ];
 HelpCommand.strict = false;
-exports.default = HelpCommand;

package/lib/index.js

@@ -11,6 +11,20 @@ const screen_1 = require("./screen");
 const util_1 = require("./util");
 const wrap = require('wrap-ansi');
 const { bold, } = chalk_1.default;
+function getHelpSubject(args) {
+    // special case
+    // if (['help:help', 'help:--help', '--help:help'].includes(argv.slice(0, 2).join(':'))) {
+    // if (argv[0] === 'help') return 'help'
+    for (const arg of args) {
+        if (arg === '--')
+            return;
+        if (arg.startsWith('-'))
+            continue;
+        if (arg === 'help')
+            continue;
+        return arg;
+    }
+}
 class Help {
     constructor(config, opts = {}) {
         this.config = config;
@@ -18,47 +32,39 @@ class Help {
         this.render = util_1.template(this);
     }
     showHelp(argv) {
-        const getHelpSubject = () => {
-            // special case
-            // if (['help:help', 'help:--help', '--help:help'].includes(argv.slice(0, 2).join(':'))) {
-            // if (argv[0] === 'help') return 'help'
-            for (let arg of argv) {
-                if (arg === '--')
-                    return;
-                if (arg.startsWith('-'))
-                    continue;
-                if (arg === 'help')
-                    continue;
-                return arg;
-            }
-        };
         let topics = this.config.topics;
         topics = topics.filter(t => this.opts.all || !t.hidden);
         topics = util_1.sortBy(topics, t => t.name);
         topics = util_1.uniqBy(topics, t => t.name);
-        let subject = getHelpSubject();
+        const subject = getHelpSubject(argv);
         let command;
+        if (subject) {
+            command = this.config.findCommand(subject);
+        }
         let topic;
+        if (subject && !command) {
+            topic = this.config.findTopic(subject);
+        }
         if (!subject) {
             console.log(this.root());
-            console.log();
+            console.log('');
             if (!this.opts.all) {
                 topics = topics.filter(t => !t.name.includes(':'));
             }
             console.log(this.topics(topics));
-            console.log();
+            console.log('');
         }
-        else if (command = this.config.findCommand(subject)) {
+        else if (command) {
             this.showCommandHelp(command, topics);
         }
-        else if (topic = this.config.findTopic(subject)) {
+        else if (topic) {
             const name = topic.name;
             const depth = name.split(':').length;
             topics = topics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
             console.log(this.topic(topic));
-            if (topics.length) {
+            if (topics.length > 0) {
                 console.log(this.topics(topics));
-                console.log();
+                console.log('');
             }
         }
         else {
@@ -69,14 +75,14 @@ class Help {
         const name = command.id;
         const depth = name.split(':').length;
         topics = topics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
-        let title = command.description && this.render(command.description).split('\n')[0];
+        const title = command.description && this.render(command.description).split('\n')[0];
         if (title)
             console.log(title + '\n');
         console.log(this.command(command));
-        console.log();
-        if (topics.length) {
+        console.log('');
+        if (topics.length > 0) {
             console.log(this.topics(topics));
-            console.log();
+            console.log('');
         }
     }
     root() {
@@ -85,7 +91,7 @@ class Help {
     }
     topic(topic) {
         let description = this.render(topic.description || '');
-        let title = description.split('\n')[0];
+        const title = description.split('\n')[0];
         description = description.split('\n').slice(1).join('\n');
         let output = util_1.compact([
             title,
@@ -95,8 +101,8 @@ class Help {
             ].join('\n'),
             description && ([
                 bold('DESCRIPTION'),
-                indent(wrap(description, this.opts.maxWidth - 2, { trim: false, hard: true }), 2)
-            ].join('\n'))
+                indent(wrap(description, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
+            ].join('\n')),
         ]).join('\n\n');
         if (this.opts.stripAnsi)
             output = stripAnsi(output);
@@ -107,11 +113,11 @@ class Help {
         return help.generate();
     }
     topics(topics) {
-        if (!topics.length)
+        if (topics.length === 0)
             return;
-        let body = list_1.renderList(topics.map(c => [
+        const body = list_1.renderList(topics.map(c => [
             c.name,
-            c.description && this.render(c.description.split('\n')[0])
+            c.description && this.render(c.description.split('\n')[0]),
         ]), {
             spacer: '\n',
             stripAnsi: this.opts.stripAnsi,

package/lib/list.js

@@ -10,7 +10,7 @@ function renderList(input, opts) {
         return '';
     }
     const renderMultiline = () => {
-        output = '';
+        let output = '';
         for (let [left, right] of input) {
             if (!left && !right)
                 continue;
@@ -35,7 +35,8 @@ function renderList(input, opts) {
     let output = '';
     let spacer = opts.spacer || '\n';
     let cur = '';
-    for (let [left, right] of input) {
+    for (const [left, r] of input) {
+        let right = r;
         if (cur) {
             output += spacer;
             output += cur;

package/lib/screen.d.ts

@@ -1,2 +1,2 @@
-export declare let stdtermwidth: number;
-export declare let errtermwidth: number;
+export declare const stdtermwidth: number;
+export declare const errtermwidth: number;

package/lib/util.d.ts

@@ -5,4 +5,4 @@ export declare function sortBy<T>(arr: T[], fn: (i: T) => sort.Types | sort.Type
 export declare namespace sort {
     type Types = string | number | undefined | boolean;
 }
-export declare const template: (context: any) => (t: string) => string;
+export declare function template(context: any): (t: string) => string;

package/lib/util.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const Template = require("lodash.template");
+const lodashTemplate = require("lodash.template");
 function uniqBy(arr, fn) {
     return arr.filter((a, i) => {
-        let aVal = fn(a);
+        const aVal = fn(a);
         return !arr.find((b, j) => j > i && fn(b) === aVal);
     });
 }
 exports.uniqBy = uniqBy;
 function compact(a) {
-    return a.filter((a) => !!a);
+    return a.filter((a) => Boolean(a));
 }
 exports.compact = compact;
 function castArray(input) {
@@ -25,7 +25,7 @@ function sortBy(arr, fn) {
         if (Array.isArray(a) && Array.isArray(b)) {
             if (a.length === 0 && b.length === 0)
                 return 0;
-            let diff = compare(a[0], b[0]);
+            const diff = compare(a[0], b[0]);
             if (diff !== 0)
                 return diff;
             return compare(a.slice(1), b.slice(1));
@@ -39,4 +39,10 @@ function sortBy(arr, fn) {
     return arr.sort((a, b) => compare(fn(a), fn(b)));
 }
 exports.sortBy = sortBy;
-exports.template = (context) => (t) => Template(t)(context);
+function template(context) {
+    function render(t) {
+        return lodashTemplate(t)(context);
+    }
+    return render;
+}
+exports.template = template;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.6","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":"2.2.3","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,13 +1,13 @@
 {
   "name": "@oclif/plugin-help",
   "description": "standard help for oclif",
-  "version": "2.1.6",
+  "version": "2.2.3",
   "author": "Jeff Dickey @jdxcode",
   "bugs": "https://github.com/oclif/plugin-help/issues",
   "dependencies": {
-    "@oclif/command": "^1.5.8",
+    "@oclif/command": "^1.5.13",
     "chalk": "^2.4.1",
-    "indent-string": "^3.2.0",
+    "indent-string": "^4.0.0",
     "lodash.template": "^4.4.0",
     "string-width": "^3.0.0",
     "strip-ansi": "^5.0.0",
@@ -15,26 +15,26 @@
     "wrap-ansi": "^4.0.0"
   },
   "devDependencies": {
-    "@oclif/config": "^1.12.0",
+    "@oclif/config": "^1.13.0",
     "@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",
-    "@oclif/tslint": "^3.1.1",
     "@types/chai": "^4.1.7",
-    "@types/indent-string": "^3.2.0",
     "@types/lodash.template": "^4.4.4",
     "@types/mocha": "^5.2.5",
-    "@types/node": "^10.12.19",
+    "@types/node": "^8.10.59",
     "@types/strip-ansi": "^3.0.0",
     "@types/wrap-ansi": "^3.0.0",
     "chai": "^4.2.0",
+    "eslint": "^6.6.0",
+    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif-typescript": "^0.1.0",
     "globby": "^9.0.0",
     "mocha": "^5.2.0",
     "ts-node": "^8.0.2",
-    "tslint": "^5.12.1",
-    "typescript": "^3.2.4"
+    "typescript": "^3.7.2"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -60,11 +60,12 @@
   "repository": "oclif/plugin-help",
   "scripts": {
     "build": "rm -rf lib && tsc",
-    "lint": "tsc -p test --noEmit && tslint -p test",
-    "postpack": "rm oclif.manifest.json",
-    "posttest": "yarn run lint",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "pretest": "tsc -p test --noEmit",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "yarn lint",
     "prepack": "yarn run build && oclif-dev manifest",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\""
+    "postpack": "rm oclif.manifest.json"
   },
   "types": "./lib/index.d.ts"
 }