@oclif/plugin-help 3.2.17 → 3.2.18

package/lib/commands/help.d.ts

@@ -1,5 +1,4 @@
-import Command from '@oclif/cmd/lib/command';
-import * as flags from '@oclif/cmd/lib/flags';
+import Command, { flags } from '@oclif/command';
 export default class HelpCommand extends Command {
     static description: string;
     static flags: flags.Input<any>;

package/lib/commands/help.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/cmd/lib/command");
-const flags = require("@oclif/cmd/lib/flags");
-const __1 = require("..");
+const command_1 = require("@oclif/command");
+const help_1 = require("@oclif/help");
 class HelpCommand extends command_1.default {
     async run() {
         const { flags, argv } = this.parse(HelpCommand);
-        const Help = __1.getHelpClass(this.config);
+        const Help = help_1.getHelpClass(this.config);
         const help = new Help(this.config, { all: flags.all });
         help.showHelp(argv);
     }
@@ -14,7 +13,7 @@ class HelpCommand extends command_1.default {
 exports.default = HelpCommand;
 HelpCommand.description = 'display help for <%= config.bin %>';
 HelpCommand.flags = {
-    all: flags.boolean({ description: 'see all commands in CLI' }),
+    all: command_1.flags.boolean({ description: 'see all commands in CLI' }),
 };
 HelpCommand.args = [
     { name: 'command', required: false, description: 'command to show help for' },

package/lib/index.d.ts

@@ -1,46 +1 @@
-import * as Config from '@oclif/config';
-import { getHelpClass } from './util';
-export interface HelpOptions {
-    all?: boolean;
-    maxWidth: number;
-    stripAnsi?: boolean;
-}
-export declare abstract class HelpBase {
-    constructor(config: Config.IConfig, opts?: Partial<HelpOptions>);
-    protected config: Config.IConfig;
-    protected opts: HelpOptions;
-    /**
-     * Show help, used in multi-command CLIs
-     * @param args passed into your command, useful for determining which type of help to display
-     */
-    abstract showHelp(argv: string[]): void;
-    /**
-     * Show help for an individual command
-     * @param command
-     * @param topics
-     */
-    abstract showCommandHelp(command: Config.Command, topics: Config.Topic[]): void;
-}
-export default class Help extends HelpBase {
-    render: (input: string) => string;
-    private get _topics();
-    protected get sortedCommands(): Config.Command.Plugin[];
-    protected get sortedTopics(): Config.Topic[];
-    constructor(config: Config.IConfig, opts?: Partial<HelpOptions>);
-    showHelp(argv: string[]): void;
-    showCommandHelp(command: Config.Command): void;
-    protected showRootHelp(): void;
-    protected showTopicHelp(topic: Config.Topic): void;
-    protected formatRoot(): string;
-    protected formatCommand(command: Config.Command): string;
-    protected formatCommands(commands: Config.Command[]): string;
-    protected formatTopic(topic: Config.Topic): string;
-    protected formatTopics(topics: Config.Topic[]): string;
-    /**
-     * @deprecated used for readme generation
-     * @param {object} command The command to generate readme help for
-     * @return {string} the readme help string for the given command
-     */
-    protected command(command: Config.Command): string;
-}
-export { Help, getHelpClass, };
+export { Help, getHelpClass, HelpOptions, HelpBase } from '@oclif/help';

package/lib/index.js

@@ -1,213 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("@oclif/errors");
-const chalk = require("chalk");
-const indent = require("indent-string");
-const stripAnsi = require("strip-ansi");
-const command_1 = require("./command");
-const list_1 = require("./list");
-const root_1 = require("./root");
-const screen_1 = require("./screen");
-const util_1 = require("./util");
-const util_2 = require("./util");
-exports.getHelpClass = util_2.getHelpClass;
-const wrap = require('wrap-ansi');
-const { bold, } = chalk;
-const ROOT_INDEX_CMD_ID = '';
-function getHelpSubject(args) {
-    for (const arg of args) {
-        if (arg === '--')
-            return;
-        if (arg === 'help' || arg === '--help' || arg === '-h')
-            continue;
-        if (arg.startsWith('-'))
-            return;
-        return arg;
-    }
-}
-class HelpBase {
-    constructor(config, opts = {}) {
-        this.config = config;
-        this.opts = Object.assign({ maxWidth: screen_1.stdtermwidth }, opts);
-    }
-}
-exports.HelpBase = HelpBase;
-class Help extends HelpBase {
-    constructor(config, opts = {}) {
-        super(config, opts);
-        this.render = util_1.template(this);
-    }
-    /*
-     * _topics is to work around Config.topics mistakenly including commands that do
-     * not have children, as well as topics. A topic has children, either commands or other topics. When
-     * this is fixed upstream config.topics should return *only* topics with children,
-     * and this can be removed.
-     */
-    get _topics() {
-        // 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 = topics.some(subTopic => subTopic.name.includes(`${topic.name}:`));
-            return hasChild;
-        });
-    }
-    get sortedCommands() {
-        let commands = this.config.commands;
-        commands = commands.filter(c => this.opts.all || !c.hidden);
-        commands = util_1.sortBy(commands, c => c.id);
-        commands = util_1.uniqBy(commands, c => c.id);
-        return commands;
-    }
-    get sortedTopics() {
-        let topics = this._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);
-        return topics;
-    }
-    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;
-        }
-        const command = this.config.findCommand(subject);
-        if (command) {
-            this.showCommandHelp(command);
-            return;
-        }
-        const topic = this.config.findTopic(subject);
-        if (topic) {
-            this.showTopicHelp(topic);
-            return;
-        }
-        errors_1.error(`command ${subject} not found`);
-    }
-    showCommandHelp(command) {
-        const name = command.id;
-        const depth = name.split(':').length;
-        const subTopics = this.sortedTopics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
-        const subCommands = this.sortedCommands.filter(c => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
-        const title = command.description && this.render(command.description).split('\n')[0];
-        if (title)
-            console.log(title + '\n');
-        console.log(this.formatCommand(command));
-        console.log('');
-        if (subTopics.length > 0) {
-            console.log(this.formatTopics(subTopics));
-            console.log('');
-        }
-        if (subCommands.length > 0) {
-            console.log(this.formatCommands(subCommands));
-            console.log('');
-        }
-    }
-    showRootHelp() {
-        let rootTopics = this.sortedTopics;
-        let rootCommands = this.sortedCommands;
-        console.log(this.formatRoot());
-        console.log('');
-        if (!this.opts.all) {
-            rootTopics = rootTopics.filter(t => !t.name.includes(':'));
-            rootCommands = rootCommands.filter(c => !c.id.includes(':'));
-        }
-        if (rootTopics.length > 0) {
-            console.log(this.formatTopics(rootTopics));
-            console.log('');
-        }
-        if (rootCommands.length > 0) {
-            rootCommands = rootCommands.filter(c => c.id);
-            console.log(this.formatCommands(rootCommands));
-            console.log('');
-        }
-    }
-    showTopicHelp(topic) {
-        const name = topic.name;
-        const depth = name.split(':').length;
-        const subTopics = this.sortedTopics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
-        const commands = this.sortedCommands.filter(c => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
-        console.log(this.formatTopic(topic));
-        if (subTopics.length > 0) {
-            console.log(this.formatTopics(subTopics));
-            console.log('');
-        }
-        if (commands.length > 0) {
-            console.log(this.formatCommands(commands));
-            console.log('');
-        }
-    }
-    formatRoot() {
-        const help = new root_1.default(this.config, this.opts);
-        return help.root();
-    }
-    formatCommand(command) {
-        const help = new command_1.default(command, this.config, this.opts);
-        return help.generate();
-    }
-    formatCommands(commands) {
-        if (commands.length === 0)
-            return '';
-        const body = list_1.renderList(commands.map(c => [
-            c.id,
-            c.description && this.render(c.description.split('\n')[0]),
-        ]), {
-            spacer: '\n',
-            stripAnsi: this.opts.stripAnsi,
-            maxWidth: this.opts.maxWidth - 2,
-        });
-        return [
-            bold('COMMANDS'),
-            indent(body, 2),
-        ].join('\n');
-    }
-    formatTopic(topic) {
-        let description = this.render(topic.description || '');
-        const title = description.split('\n')[0];
-        description = description.split('\n').slice(1).join('\n');
-        let output = util_1.compact([
-            title,
-            [
-                bold('USAGE'),
-                indent(wrap(`$ ${this.config.bin} ${topic.name}:COMMAND`, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-            ].join('\n'),
-            description && ([
-                bold('DESCRIPTION'),
-                indent(wrap(description, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-            ].join('\n')),
-        ]).join('\n\n');
-        if (this.opts.stripAnsi)
-            output = stripAnsi(output);
-        return output + '\n';
-    }
-    formatTopics(topics) {
-        if (topics.length === 0)
-            return '';
-        const body = list_1.renderList(topics.map(c => [
-            c.name,
-            c.description && this.render(c.description.split('\n')[0]),
-        ]), {
-            spacer: '\n',
-            stripAnsi: this.opts.stripAnsi,
-            maxWidth: this.opts.maxWidth - 2,
-        });
-        return [
-            bold('TOPICS'),
-            indent(body, 2),
-        ].join('\n');
-    }
-    /**
-     * @deprecated used for readme generation
-     * @param {object} command The command to generate readme help for
-     * @return {string} the readme help string for the given command
-     */
-    command(command) {
-        return this.formatCommand(command);
-    }
-}
-exports.default = Help;
-exports.Help = Help;
+var help_1 = require("@oclif/help");
+exports.Help = help_1.Help;
+exports.getHelpClass = help_1.getHelpClass;
+exports.HelpBase = help_1.HelpBase;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.2.17","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.18","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,14 @@
 {
   "name": "@oclif/plugin-help",
   "description": "standard help for oclif",
-  "version": "3.2.17",
-  "author": "Jeff Dickey @jdxcode",
+  "version": "3.2.18",
+  "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-help/issues",
   "dependencies": {
-    "@oclif/cmd": "npm:@oclif/command@1.8.12",
+    "@oclif/command": "^1.8.14",
     "@oclif/config": "1.18.2",
     "@oclif/errors": "1.3.5",
+    "@oclif/help": "^1.0.0",
     "chalk": "^4.1.2",
     "indent-string": "^4.0.0",
     "lodash": "^4.17.21",

package/lib/_test-help-class.d.ts

@@ -1,6 +0,0 @@
-import { HelpBase } from '.';
-export default class extends HelpBase {
-    showHelp(): void;
-    showCommandHelp(): void;
-    getCommandHelpForReadme(): string;
-}

package/lib/_test-help-class.js

@@ -1,19 +0,0 @@
-"use strict";
-// `getHelpClass` tests require an oclif project for testing so
-// it is re-using the setup here to be able to do a lookup for
-// this sample help class file in tests, although it is not needed
-// for @oclif/plugin-help itself.
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-class default_1 extends _1.HelpBase {
-    showHelp() {
-        console.log('help');
-    }
-    showCommandHelp() {
-        console.log('command help');
-    }
-    getCommandHelpForReadme() {
-        return 'help for readme';
-    }
-}
-exports.default = default_1;

package/lib/command.d.ts

@@ -1,18 +0,0 @@
-import * as Config from '@oclif/config';
-import { HelpOptions } from '.';
-export default class CommandHelp {
-    command: Config.Command;
-    config: Config.IConfig;
-    opts: HelpOptions;
-    render: (input: string) => string;
-    constructor(command: Config.Command, config: Config.IConfig, opts: HelpOptions);
-    generate(): string;
-    protected usage(flags: Config.Command.Flag[]): string;
-    protected defaultUsage(_: Config.Command.Flag[]): string;
-    protected description(): string | undefined;
-    protected aliases(aliases: string[] | undefined): string | undefined;
-    protected examples(examples: string[] | undefined | string): string | undefined;
-    protected args(args: Config.Command['args']): string | undefined;
-    protected arg(arg: Config.Command['args'][0]): string;
-    protected flags(flags: Config.Command.Flag[]): string | undefined;
-}

package/lib/command.js

@@ -1,155 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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;
-let { dim, } = chalk;
-if (process.env.ConEmuANSI === 'ON') {
-    dim = chalk.gray;
-}
-const wrap = require('wrap-ansi');
-class CommandHelp {
-    constructor(command, config, opts) {
-        this.command = command;
-        this.config = config;
-        this.opts = opts;
-        this.render = util_1.template(this);
-    }
-    generate() {
-        const cmd = this.command;
-        const flags = util_1.sortBy(Object.entries(cmd.flags || {})
-            .filter(([, v]) => !v.hidden)
-            .map(([k, v]) => {
-            v.name = k;
-            return v;
-        }), f => [!f.char, f.char, f.name]);
-        const args = (cmd.args || []).filter(a => !a.hidden);
-        let output = util_1.compact([
-            this.usage(flags),
-            this.args(args),
-            this.flags(flags),
-            this.description(),
-            this.aliases(cmd.aliases),
-            this.examples(cmd.examples || cmd.example),
-        ]).join('\n\n');
-        if (this.opts.stripAnsi)
-            output = stripAnsi(output);
-        return output;
-    }
-    usage(flags) {
-        const usage = this.command.usage;
-        const body = (usage ? util_1.castArray(usage) : [this.defaultUsage(flags)])
-            .map(u => `$ ${this.config.bin} ${u}`.trim())
-            .join('\n');
-        return [
-            bold('USAGE'),
-            indent(wrap(this.render(body), this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-        ].join('\n');
-    }
-    defaultUsage(_) {
-        return util_1.compact([
-            this.command.id,
-            this.command.args.filter(a => !a.hidden).map(a => this.arg(a)).join(' '),
-        ]).join(' ');
-    }
-    description() {
-        const cmd = this.command;
-        const description = cmd.description && this.render(cmd.description).split('\n').slice(1).join('\n');
-        if (!description)
-            return;
-        return [
-            bold('DESCRIPTION'),
-            indent(wrap(description.trim(), this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-        ].join('\n');
-    }
-    aliases(aliases) {
-        if (!aliases || aliases.length === 0)
-            return;
-        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 === 0)
-            return;
-        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 === 0)
-            return;
-        const body = list_1.renderList(args.map(a => {
-            var _a;
-            const name = a.name.toUpperCase();
-            let description = a.description || '';
-            // `a.default` is actually not always a string (typing bug), hence `toString()`
-            if (a.default || ((_a = a.default) === null || _a === void 0 ? void 0 : _a.toString()) === '0')
-                description = `[default: ${a.default}] ${description}`;
-            if (a.options)
-                description = `(${a.options.join('|')}) ${description}`;
-            return [name, description ? dim(description) : undefined];
-        }), { stripAnsi: this.opts.stripAnsi, maxWidth: this.opts.maxWidth - 2 });
-        return [
-            bold('ARGUMENTS'),
-            indent(body, 2),
-        ].join('\n');
-    }
-    arg(arg) {
-        const name = arg.name.toUpperCase();
-        if (arg.required)
-            return `${name}`;
-        return `[${name}]`;
-    }
-    flags(flags) {
-        if (flags.length === 0)
-            return;
-        const body = list_1.renderList(flags.map(flag => {
-            var _a;
-            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(', ');
-            }
-            if (flag.type === 'option') {
-                let value = flag.helpValue || flag.name;
-                if (!flag.helpValue && flag.options) {
-                    value = flag.options.join('|');
-                }
-                if (!value.includes('|'))
-                    value = underline(value);
-                left += `=${value}`;
-            }
-            let right = flag.description || '';
-            // `flag.default` is not always a string (typing bug), hence `toString()`
-            if (flag.type === 'option' && (flag.default || ((_a = flag.default) === null || _a === void 0 ? void 0 : _a.toString()) === '0')) {
-                right = `[default: ${flag.default}] ${right}`;
-            }
-            if (flag.required)
-                right = `(required) ${right}`;
-            return [left, dim(right.trim())];
-        }), { stripAnsi: this.opts.stripAnsi, maxWidth: this.opts.maxWidth - 2 });
-        return [
-            bold('OPTIONS'),
-            indent(body, 2),
-        ].join('\n');
-    }
-}
-exports.default = CommandHelp;

package/lib/list.d.ts

@@ -1,6 +0,0 @@
-export declare function renderList(input: (string | undefined)[][], opts: {
-    maxWidth: number;
-    multiline?: boolean;
-    stripAnsi?: boolean;
-    spacer?: string;
-}): string;

package/lib/list.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const indent = require("indent-string");
-const stripAnsi = require("strip-ansi");
-const width = require('string-width');
-const wrap = require('wrap-ansi');
-const widestLine = require('widest-line');
-function renderList(input, opts) {
-    if (input.length === 0) {
-        return '';
-    }
-    const renderMultiline = () => {
-        let output = '';
-        for (let [left, right] of input) {
-            if (!left && !right)
-                continue;
-            if (left) {
-                if (opts.stripAnsi)
-                    left = stripAnsi(left);
-                output += wrap(left.trim(), opts.maxWidth, { hard: true, trim: true });
-            }
-            if (right) {
-                if (opts.stripAnsi)
-                    right = stripAnsi(right);
-                output += '\n';
-                output += indent(wrap(right.trim(), opts.maxWidth - 2, { hard: true, trim: true }), 4);
-            }
-            output += '\n\n';
-        }
-        return output.trim();
-    };
-    if (opts.multiline)
-        return renderMultiline();
-    const maxLength = widestLine(input.map(i => i[0]).join('\n'));
-    let output = '';
-    let spacer = opts.spacer || '\n';
-    let cur = '';
-    for (const [left, r] of input) {
-        let right = r;
-        if (cur) {
-            output += spacer;
-            output += cur;
-        }
-        cur = left || '';
-        if (opts.stripAnsi)
-            cur = stripAnsi(cur);
-        if (!right) {
-            cur = cur.trim();
-            continue;
-        }
-        if (opts.stripAnsi)
-            right = stripAnsi(right);
-        right = wrap(right.trim(), opts.maxWidth - (maxLength + 2), { hard: true, trim: true });
-        // right = wrap(right.trim(), screen.stdtermwidth - (maxLength + 4), {hard: true, trim: false})
-        const [first, ...lines] = right.split('\n').map(s => s.trim());
-        cur += ' '.repeat(maxLength - width(cur) + 2);
-        cur += first;
-        if (lines.length === 0) {
-            continue;
-        }
-        // if we start putting too many lines down, render in multiline format
-        if (lines.length > 4)
-            return renderMultiline();
-        // if spacer is not defined, separate all rows with extra newline
-        if (!opts.spacer)
-            spacer = '\n\n';
-        cur += '\n';
-        cur += indent(lines.join('\n'), maxLength + 2);
-    }
-    if (cur) {
-        output += spacer;
-        output += cur;
-    }
-    return output.trim();
-}
-exports.renderList = renderList;

package/lib/root.d.ts

@@ -1,12 +0,0 @@
-import * as Config from '@oclif/config';
-import { HelpOptions } from '.';
-export default class RootHelp {
-    config: Config.IConfig;
-    opts: HelpOptions;
-    render: (input: string) => string;
-    constructor(config: Config.IConfig, opts: HelpOptions);
-    root(): string;
-    protected usage(): string;
-    protected description(): string | undefined;
-    protected version(): string;
-}

package/lib/root.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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;
-class RootHelp {
-    constructor(config, opts) {
-        this.config = config;
-        this.opts = opts;
-        this.render = util_1.template(this);
-    }
-    root() {
-        let description = this.config.pjson.oclif.description || this.config.pjson.description || '';
-        description = this.render(description);
-        description = description.split('\n')[0];
-        let output = util_1.compact([
-            description,
-            this.version(),
-            this.usage(),
-            this.description(),
-        ]).join('\n\n');
-        if (this.opts.stripAnsi)
-            output = stripAnsi(output);
-        return output;
-    }
-    usage() {
-        return [
-            bold('USAGE'),
-            indent(wrap(`$ ${this.config.bin} [COMMAND]`, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-        ].join('\n');
-    }
-    description() {
-        let description = this.config.pjson.oclif.description || this.config.pjson.description || '';
-        description = this.render(description);
-        description = description.split('\n').slice(1).join('\n');
-        if (!description)
-            return;
-        return [
-            bold('DESCRIPTION'),
-            indent(wrap(description, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-        ].join('\n');
-    }
-    version() {
-        return [
-            bold('VERSION'),
-            indent(wrap(this.config.userAgent, this.opts.maxWidth - 2, { trim: false, hard: true }), 2),
-        ].join('\n');
-    }
-}
-exports.default = RootHelp;

package/lib/screen.d.ts

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

package/lib/screen.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function termwidth(stream) {
-    if (!stream.isTTY) {
-        return 80;
-    }
-    const width = stream.getWindowSize()[0];
-    if (width < 1) {
-        return 80;
-    }
-    if (width < 40) {
-        return 40;
-    }
-    return width;
-}
-const columns = parseInt(process.env.COLUMNS, 10) || global.columns;
-exports.stdtermwidth = columns || termwidth(process.stdout);
-exports.errtermwidth = columns || termwidth(process.stderr);

package/lib/util.d.ts

@@ -1,15 +0,0 @@
-import { IConfig } from '@oclif/config';
-import { HelpBase, HelpOptions } from '.';
-export declare function uniqBy<T>(arr: T[], fn: (cur: T) => any): T[];
-export declare function compact<T>(a: (T | undefined)[]): T[];
-export declare function castArray<T>(input?: T | T[]): T[];
-export declare function sortBy<T>(arr: T[], fn: (i: T) => sort.Types | sort.Types[]): T[];
-export declare namespace sort {
-    type Types = string | number | undefined | boolean;
-}
-export declare function template(context: any): (t: string) => string;
-interface HelpBaseDerived {
-    new (config: IConfig, opts?: Partial<HelpOptions>): HelpBase;
-}
-export declare function getHelpClass(config: IConfig, defaultClass?: string): HelpBaseDerived;
-export {};

package/lib/util.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ts_node_1 = require("@oclif/config/lib/ts-node");
-const _ = require("lodash");
-function uniqBy(arr, fn) {
-    return arr.filter((a, i) => {
-        const aVal = fn(a);
-        return !arr.find((b, j) => j > i && fn(b) === aVal);
-    });
-}
-exports.uniqBy = uniqBy;
-function compact(a) {
-    return a.filter((a) => Boolean(a));
-}
-exports.compact = compact;
-function castArray(input) {
-    if (input === undefined)
-        return [];
-    return Array.isArray(input) ? input : [input];
-}
-exports.castArray = castArray;
-function sortBy(arr, fn) {
-    function compare(a, b) {
-        a = a === undefined ? 0 : a;
-        b = b === undefined ? 0 : b;
-        if (Array.isArray(a) && Array.isArray(b)) {
-            if (a.length === 0 && b.length === 0)
-                return 0;
-            const diff = compare(a[0], b[0]);
-            if (diff !== 0)
-                return diff;
-            return compare(a.slice(1), b.slice(1));
-        }
-        if (a < b)
-            return -1;
-        if (a > b)
-            return 1;
-        return 0;
-    }
-    return arr.sort((a, b) => compare(fn(a), fn(b)));
-}
-exports.sortBy = sortBy;
-function template(context) {
-    function render(t) {
-        return _.template(t)(context);
-    }
-    return render;
-}
-exports.template = template;
-function extractExport(config, classPath) {
-    const helpClassPath = ts_node_1.tsPath(config.root, classPath);
-    return require(helpClassPath);
-}
-function extractClass(exported) {
-    return exported && exported.default ? exported.default : exported;
-}
-function getHelpClass(config, defaultClass = '@oclif/plugin-help') {
-    const pjson = config.pjson;
-    const configuredClass = pjson && pjson.oclif && pjson.oclif.helpClass;
-    if (configuredClass) {
-        try {
-            const exported = extractExport(config, configuredClass);
-            return extractClass(exported);
-        }
-        catch (error) {
-            throw new Error(`Unable to load configured help class "${configuredClass}", failed with message:\n${error.message}`);
-        }
-    }
-    try {
-        const defaultModulePath = require.resolve(defaultClass, { paths: [config.root] });
-        const exported = require(defaultModulePath);
-        return extractClass(exported);
-    }
-    catch (error) {
-        throw new Error(`Could not load a help class, consider installing the @oclif/plugin-help package, failed with message:\n${error.message}`);
-    }
-}
-exports.getHelpClass = getHelpClass;