@oclif/core 3.0.0-beta.2 → 3.0.0-beta.20

package/lib/help/command.js

@@ -1,22 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandHelp = void 0;
-const chalk = require("chalk");
-const stripAnsi = require("strip-ansi");
-const util_1 = require("../util");
+const tslib_1 = require("tslib");
 const formatter_1 = require("./formatter");
+const util_1 = require("../util/util");
 const docopts_1 = require("./docopts");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const ensure_arg_object_1 = require("../util/ensure-arg-object");
+const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
 // Don't use os.EOL because we need to ensure that a string
 // written on any platform, that may use \r\n or \n, will be
 // split on any platform, not just the os specific EOL at runtime.
 const POSSIBLE_LINE_FEED = /\r\n|\n/;
-const { underline, } = chalk;
-let { dim, } = chalk;
+let { dim } = chalk_1.default;
 if (process.env.ConEmuANSI === 'ON') {
     // eslint-disable-next-line unicorn/consistent-destructuring
-    dim = chalk.gray;
+    dim = chalk_1.default.gray;
 }
 class CommandHelp extends formatter_1.HelpFormatter {
+    command;
+    config;
+    opts;
     constructor(command, config, opts) {
         super(config, opts);
         this.command = command;
@@ -30,13 +34,15 @@ class CommandHelp extends formatter_1.HelpFormatter {
             .map(([k, v]) => {
             v.name = k;
             return v;
-        }), f => [!f.char, f.char, f.name]);
-        const args = Object.values((0, util_1.ensureArgObject)(cmd.args)).filter(a => !a.hidden);
+        }), (f) => [!f.char, f.char, f.name]);
+        const args = Object.values((0, ensure_arg_object_1.ensureArgObject)(cmd.args)).filter((a) => !a.hidden);
         const output = (0, util_1.compact)(this.sections().map(({ header, generate }) => {
             const body = generate({ cmd, flags, args }, header);
             // Generate can return a list of sections
             if (Array.isArray(body)) {
-                return body.map(helpSection => helpSection && helpSection.body && this.section(helpSection.header, helpSection.body)).join('\n\n');
+                return body
+                    .map((helpSection) => helpSection && helpSection.body && this.section(helpSection.header, helpSection.body))
+                    .join('\n\n');
             }
             return body && this.section(header, body);
         })).join('\n\n');
@@ -106,15 +112,16 @@ class CommandHelp extends formatter_1.HelpFormatter {
         ];
     }
     usage() {
-        const usage = this.command.usage;
+        const { usage } = this.command;
         const body = (usage ? (0, util_1.castArray)(usage) : [this.defaultUsage()])
-            .map(u => {
+            .map((u) => {
             const allowedSpacing = this.opts.maxWidth - this.indentSpacing;
             const line = `$ ${this.config.bin} ${u}`.trim();
             if (line.length > allowedSpacing) {
                 const splitIndex = line.slice(0, Math.max(0, allowedSpacing)).lastIndexOf(' ');
-                return line.slice(0, Math.max(0, splitIndex)) + '\n' +
-                    this.indent(this.wrap(line.slice(Math.max(0, splitIndex)), this.indentSpacing * 2));
+                return (line.slice(0, Math.max(0, splitIndex)) +
+                    '\n' +
+                    this.indent(this.wrap(line.slice(Math.max(0, splitIndex)), this.indentSpacing * 2)));
             }
             return this.wrap(line);
         })
@@ -128,7 +135,10 @@ class CommandHelp extends formatter_1.HelpFormatter {
         }
         return (0, util_1.compact)([
             this.command.id,
-            Object.values(this.command.args ?? {})?.filter(a => !a.hidden).map(a => this.arg(a)).join(' '),
+            Object.values(this.command.args ?? {})
+                ?.filter((a) => !a.hidden)
+                .map((a) => this.arg(a))
+                .join(' '),
         ]).join(' ');
     }
     description() {
@@ -139,10 +149,9 @@ class CommandHelp extends formatter_1.HelpFormatter {
         }
         else if (cmd.description) {
             const summary = cmd.summary ? `${cmd.summary}\n` : null;
-            description = summary ? [
-                ...summary.split(POSSIBLE_LINE_FEED),
-                ...(cmd.description || '').split(POSSIBLE_LINE_FEED),
-            ] : (cmd.description || '').split(POSSIBLE_LINE_FEED);
+            description = summary
+                ? [...summary.split(POSSIBLE_LINE_FEED), ...(cmd.description || '').split(POSSIBLE_LINE_FEED)]
+                : (cmd.description || '').split(POSSIBLE_LINE_FEED);
         }
         if (description) {
             return this.wrap(description.join('\n'));
@@ -151,61 +160,51 @@ class CommandHelp extends formatter_1.HelpFormatter {
     aliases(aliases) {
         if (!aliases || aliases.length === 0)
             return;
-        const body = aliases.map(a => ['$', this.config.bin, a].join(' ')).join('\n');
+        const body = aliases.map((a) => ['$', this.config.bin, a].join(' ')).join('\n');
         return body;
     }
     examples(examples) {
         if (!examples || examples.length === 0)
             return;
-        const formatIfCommand = (example) => {
-            example = this.render(example);
-            if (example.startsWith(this.config.bin))
-                return dim(`$ ${example}`);
-            if (example.startsWith(`$ ${this.config.bin}`))
-                return dim(example);
-            return example;
-        };
-        const isCommand = (example) => stripAnsi(formatIfCommand(example)).startsWith(`$ ${this.config.bin}`);
-        const body = (0, util_1.castArray)(examples).map(a => {
+        const body = (0, util_1.castArray)(examples)
+            .map((a) => {
             let description;
             let commands;
             if (typeof a === 'string') {
-                const lines = a
-                    .split(POSSIBLE_LINE_FEED)
-                    .filter(line => Boolean(line));
+                const lines = a.split(POSSIBLE_LINE_FEED).filter(Boolean);
                 // If the example is <description>\n<command> then format correctly
-                // eslint-disable-next-line unicorn/no-array-callback-reference
-                if (lines.length >= 2 && !isCommand(lines[0]) && lines.slice(1).every(isCommand)) {
+                if (lines.length >= 2 && !this.isCommand(lines[0]) && lines.slice(1).every((i) => this.isCommand(i))) {
                     description = lines[0];
                     commands = lines.slice(1);
                 }
                 else {
-                    return lines.map(line => formatIfCommand(line)).join('\n');
+                    return lines.map((line) => this.formatIfCommand(line)).join('\n');
                 }
             }
             else {
                 description = a.description;
                 commands = [a.command];
             }
-            const multilineSeparator = this.config.platform === 'win32' ?
-                (this.config.shell.includes('powershell') ? '`' : '^') :
-                '\\';
+            const multilineSeparator = this.config.platform === 'win32' ? (this.config.shell.includes('powershell') ? '`' : '^') : '\\';
             // The command will be indented in the section, which is also indented
             const finalIndentedSpacing = this.indentSpacing * 2;
-            const multilineCommands = commands.map(c => {
-                // First indent keeping room for escaped newlines
-                return this.indent(this.wrap(formatIfCommand(c), finalIndentedSpacing + 4))
-                    // Then add the escaped newline
-                    .split(POSSIBLE_LINE_FEED).join(` ${multilineSeparator}\n  `);
-            }).join('\n');
+            const multilineCommands = commands
+                .map((c) => 
+            // First indent keeping room for escaped newlines
+            this.indent(this.wrap(this.formatIfCommand(c), finalIndentedSpacing + 4))
+                // Then add the escaped newline
+                .split(POSSIBLE_LINE_FEED)
+                .join(` ${multilineSeparator}\n  `))
+                .join('\n');
             return `${this.wrap(description, finalIndentedSpacing)}\n\n${multilineCommands}`;
-        }).join('\n\n');
+        })
+            .join('\n\n');
         return body;
     }
     args(args) {
-        if (args.filter(a => a.description).length === 0)
+        if (args.filter((a) => a.description).length === 0)
             return;
-        return args.map(a => {
+        return args.map((a) => {
             const name = a.name.toUpperCase();
             let description = a.description || '';
             if (a.default)
@@ -245,7 +244,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
             if (flag.multiple)
                 value += '...';
             if (!value.includes('|'))
-                value = underline(value);
+                value = chalk_1.default.underline(value);
             label += `=${value}`;
         }
         return label;
@@ -253,7 +252,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
     flags(flags) {
         if (flags.length === 0)
             return;
-        return flags.map(flag => {
+        return flags.map((flag) => {
             const left = this.flagHelpLabel(flag);
             let right = flag.summary || flag.description || '';
             if (flag.type === 'option' && flag.default) {
@@ -268,18 +267,34 @@ class CommandHelp extends formatter_1.HelpFormatter {
         });
     }
     flagsDescriptions(flags) {
-        const flagsWithExtendedDescriptions = flags.filter(flag => flag.summary && flag.description);
+        const flagsWithExtendedDescriptions = flags.filter((flag) => flag.summary && flag.description);
         if (flagsWithExtendedDescriptions.length === 0)
             return;
-        const body = flagsWithExtendedDescriptions.map(flag => {
+        const body = flagsWithExtendedDescriptions
+            .map((flag) => {
             // Guaranteed to be set because of the filter above, but make ts happy
             const summary = flag.summary || '';
             let flagHelp = this.flagHelpLabel(flag, true);
-            flagHelp += flagHelp.length + summary.length + 2 < this.opts.maxWidth ? '  ' + summary : '\n\n' + this.indent(this.wrap(summary, this.indentSpacing * 2));
+            flagHelp +=
+                flagHelp.length + summary.length + 2 < this.opts.maxWidth
+                    ? '  ' + summary
+                    : '\n\n' + this.indent(this.wrap(summary, this.indentSpacing * 2));
             return `${flagHelp}\n\n${this.indent(this.wrap(flag.description || '', this.indentSpacing * 2))}`;
-        }).join('\n\n');
+        })
+            .join('\n\n');
         return body;
     }
+    formatIfCommand(example) {
+        example = this.render(example);
+        if (example.startsWith(this.config.bin))
+            return dim(`$ ${example}`);
+        if (example.startsWith(`$ ${this.config.bin}`))
+            return dim(example);
+        return example;
+    }
+    isCommand(example) {
+        return (0, strip_ansi_1.default)(this.formatIfCommand(example)).startsWith(`$ ${this.config.bin}`);
+    }
 }
 exports.CommandHelp = CommandHelp;
 exports.default = CommandHelp;

package/lib/help/docopts.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocOpts = void 0;
-const util_1 = require("../util");
+const ensure_arg_object_1 = require("../util/ensure-arg-object");
 /**
  * DocOpts - See http://docopt.org/.
  *
@@ -59,6 +59,9 @@ const util_1 = require("../util");
  *
  */
 class DocOpts {
+    cmd;
+    flagMap;
+    flagList;
     constructor(cmd) {
         this.cmd = cmd;
         // Create a new map with references to the flags that we can manipulate.
@@ -76,9 +79,7 @@ class DocOpts {
     toString() {
         const opts = this.cmd.id === '.' || this.cmd.id === '' ? [] : ['<%= command.id %>'];
         if (this.cmd.args) {
-            const a = Object.values((0, util_1.ensureArgObject)(this.cmd.args)).map(arg => {
-                return arg.required ? arg.name.toUpperCase() : `[${arg.name.toUpperCase()}]`;
-            }) || [];
+            const a = Object.values((0, ensure_arg_object_1.ensureArgObject)(this.cmd.args)).map((arg) => arg.required ? arg.name.toUpperCase() : `[${arg.name.toUpperCase()}]`) || [];
             opts.push(...a);
         }
         try {
@@ -86,7 +87,7 @@ class DocOpts {
         }
         catch {
             // If there is an error, just return no usage so we don't fail command help.
-            opts.push(...this.flagList.map(flag => {
+            opts.push(...this.flagList.map((flag) => {
                 const name = flag.char ? `-${flag.char}` : `--${flag.name}`;
                 if (flag.type === 'boolean')
                     return name;
@@ -99,9 +100,9 @@ class DocOpts {
         const elementMap = {};
         // Generate all doc opt elements for combining
         // Show required flags first
-        this.generateElements(elementMap, this.flagList.filter(flag => flag.required));
+        this.generateElements(elementMap, this.flagList.filter((flag) => flag.required));
         // Then show optional flags
-        this.generateElements(elementMap, this.flagList.filter(flag => !flag.required));
+        this.generateElements(elementMap, this.flagList.filter((flag) => !flag.required));
         for (const flag of this.flagList) {
             if (Array.isArray(flag.dependsOn)) {
                 this.combineElementsToFlag(elementMap, flag.name, flag.dependsOn, ' ');
@@ -134,12 +135,7 @@ class DocOpts {
             delete elementMap[toCombine];
             delete this.flagMap[toCombine];
         }
-        if (isRequired) {
-            elementMap[flagName] = `(${elementMap[flagName] || ''})`;
-        }
-        else {
-            elementMap[flagName] = `[${elementMap[flagName] || ''}]`;
-        }
+        elementMap[flagName] = isRequired ? `(${elementMap[flagName] || ''})` : `[${elementMap[flagName] || ''}]`;
         // We handled this flag, don't handle it again
         delete this.flagMap[flagName];
     }

package/lib/help/formatter.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '../command';
 import * as Interfaces from '../interfaces';
+import { Command } from '../command';
 export type HelpSectionKeyValueTable = {
     name: string;
     description: string;

package/lib/help/formatter.js

@@ -1,22 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HelpFormatter = void 0;
-const Chalk = require("chalk");
-const indent = require("indent-string");
-const stripAnsi = require("strip-ansi");
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const indent_string_1 = tslib_1.__importDefault(require("indent-string"));
 const screen_1 = require("../screen");
+const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
 const util_1 = require("./util");
-const width = require('string-width');
-const widestLine = require('widest-line');
-const wrap = require('wrap-ansi');
-const { bold, } = Chalk;
+const widest_line_1 = tslib_1.__importDefault(require("widest-line"));
+const string_width_1 = tslib_1.__importDefault(require("string-width"));
+const wrap_ansi_1 = tslib_1.__importDefault(require("wrap-ansi"));
 class HelpFormatter {
+    indentSpacing = 2;
+    /**
+     * Takes a string and replaces `<%= prop =>` with the value of prop, where prop is anything on
+     * `config=Interfaces.Config` or `opts=Interface.HelpOptions`.
+     *
+     * ```javascript
+     * `<%= config.bin =>` // will resolve to the bin defined in `pjson.oclif`.
+     * ```
+     */
+    render;
     constructor(config, opts = {}) {
-        this.indentSpacing = 2;
         this.config = config;
         this.opts = { maxWidth: screen_1.stdtermwidth, ...opts };
         this.render = (0, util_1.template)(this);
     }
+    config;
+    opts;
     /**
      * Wrap text according to `opts.maxWidth` which is typically set to the terminal width. All text
      * will be rendered before bring wrapped, otherwise it could mess up the lengths.
@@ -46,7 +57,7 @@ class HelpFormatter {
      * @returns the formatted wrapped text
      */
     wrap(body, spacing = this.indentSpacing) {
-        return wrap(this.render(body), this.opts.maxWidth - spacing, { hard: true });
+        return (0, wrap_ansi_1.default)(this.render(body), this.opts.maxWidth - spacing, { hard: true });
     }
     /**
      * Indent by `this.indentSpacing`. The text should be wrap based on terminal width before indented.
@@ -78,7 +89,7 @@ class HelpFormatter {
      * @return the formatted indented text
      */
     indent(body, spacing = this.indentSpacing) {
-        return indent(body, spacing);
+        return (0, indent_string_1.default)(body, spacing);
     }
     renderList(input, opts) {
         if (input.length === 0) {
@@ -91,12 +102,12 @@ class HelpFormatter {
                     continue;
                 if (left) {
                     if (opts.stripAnsi)
-                        left = stripAnsi(left);
+                        left = (0, strip_ansi_1.default)(left);
                     output += this.wrap(left.trim(), opts.indentation);
                 }
                 if (right) {
                     if (opts.stripAnsi)
-                        right = stripAnsi(right);
+                        right = (0, strip_ansi_1.default)(right);
                     output += '\n';
                     output += this.indent(this.wrap(right.trim(), opts.indentation + 2), 4);
                 }
@@ -106,7 +117,7 @@ class HelpFormatter {
         };
         if (opts.multiline)
             return renderMultiline();
-        const maxLength = widestLine(input.map(i => i[0]).join('\n'));
+        const maxLength = (0, widest_line_1.default)(input.map((i) => i[0]).join('\n'));
         let output = '';
         let spacer = opts.spacer || '\n';
         let cur = '';
@@ -118,16 +129,16 @@ class HelpFormatter {
             }
             cur = left || '';
             if (opts.stripAnsi)
-                cur = stripAnsi(cur);
+                cur = (0, strip_ansi_1.default)(cur);
             if (!right) {
                 cur = cur.trim();
                 continue;
             }
             if (opts.stripAnsi)
-                right = stripAnsi(right);
+                right = (0, strip_ansi_1.default)(right);
             right = this.wrap(right.trim(), opts.indentation + maxLength + 2);
-            const [first, ...lines] = right.split('\n').map(s => s.trim());
-            cur += ' '.repeat(maxLength - width(cur) + 2);
+            const [first, ...lines] = right.split('\n').map((s) => s.trim());
+            cur += ' '.repeat(maxLength - (0, string_width_1.default)(cur) + 2);
             cur += first;
             if (lines.length === 0) {
                 continue;
@@ -154,13 +165,13 @@ class HelpFormatter {
             newBody = this.render(body);
         }
         else if (Array.isArray(body)) {
-            newBody = body.map(entry => {
+            newBody = body.map((entry) => {
                 if ('name' in entry) {
                     const tableEntry = entry;
-                    return ([this.render(tableEntry.name), this.render(tableEntry.description)]);
+                    return [this.render(tableEntry.name), this.render(tableEntry.description)];
                 }
                 const [left, right] = entry;
-                return ([this.render(left), right && this.render(right)]);
+                return [this.render(left), right && this.render(right)];
             });
         }
         else if ('header' in body) {
@@ -168,14 +179,14 @@ class HelpFormatter {
         }
         else {
             newBody = body
-                .map((entry) => ([entry.name, entry.description]))
-                .map(([left, right]) => ([this.render(left), right && this.render(right)]));
+                .map((entry) => [entry.name, entry.description])
+                .map(([left, right]) => [this.render(left), right && this.render(right)]);
         }
         const output = [
-            bold(header),
+            chalk_1.default.bold(header),
             this.indent(Array.isArray(newBody) ? this.renderList(newBody, { stripAnsi: this.opts.stripAnsi, indentation: 2 }) : newBody),
         ].join('\n');
-        return this.opts.stripAnsi ? stripAnsi(output) : output;
+        return this.opts.stripAnsi ? (0, strip_ansi_1.default)(output) : output;
     }
 }
 exports.HelpFormatter = HelpFormatter;

package/lib/help/index.d.ts

@@ -1,9 +1,9 @@
 import * as Interfaces from '../interfaces';
-import CommandHelp from './command';
-import { HelpFormatter } from './formatter';
 import { Command } from '../command';
+import { CommandHelp } from './command';
+import { HelpFormatter } from './formatter';
 export { CommandHelp } from './command';
-export { standardizeIDFromArgv, loadHelpClass, getHelpFlagAdditions, normalizeArgv } from './util';
+export { standardizeIDFromArgv, getHelpFlagAdditions, normalizeArgv } from './util';
 export declare abstract class HelpBase extends HelpFormatter {
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);
     /**
@@ -39,3 +39,7 @@ export declare class Help extends HelpBase {
     protected command(command: Command.Class): string;
     protected log(...args: string[]): void;
 }
+interface HelpBaseDerived {
+    new (config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>): HelpBase;
+}
+export declare function loadHelpClass(config: Interfaces.Config): Promise<HelpBaseDerived>;