@grandlinex/easy-cli/dist/commands/base/HelpAction.js

Cli lib to perform common tasks

import { ShellCommand, } from '../../class/ShellComand.js';
import getVersion from '../../utils/Version.js';
export default class HelpAction extends ShellCommand {
    constructor(props) {
        super({
            ...props,
            name: 'help',
            description: 'Print command list and help text',
            properties: [
                {
                    key: 'help',
                    type: 'null',
                    required: true,
                },
            ],
        });
    }
    space(n) {
        return '  '.repeat(n);
    }
    inspectCmd(c) {
        this.info(`${this.space(c.level + 1)}${c.name}: ${c.description}`);
        c.properties.forEach(({ key, type, required, description, options }) => {
            let t;
            switch (type) {
                case 'string':
                    if (!options) {
                        t = `<${type}>`;
                    }
                    else {
                        t = `<option>`;
                    }
                    break;
                case 'null':
                    t = '';
                    break;
                default:
                    t = `<${type}>`;
            }
            this.info(`${this.space(c.level + 2)}--${key} ${t} ${required ? '(required)' : '(optional)'} ${description ? `: ${description}` : ''}`);
            if (options) {
                this.info(`${this.space(c.level + 3)} Options:`);
                options.forEach((o) => {
                    this.info(`${this.space(c.level + 4)}${o.key}${o.description ? ` : ${o.description}` : ''}`);
                });
            }
        });
        c.subCommands.forEach((cmd) => this.inspectCmd(cmd));
        if (c.level === 0)
            this.info('---------------------------------');
    }
    async run() {
        this.info(`Help for ${this.handler.getCmdName()} (v${getVersion()}):`);
        this.info('---------------------------------');
        this.info(`Usage: ${this.handler.getCmdName()} <command> [...<sub-command>]  [options]`);
        this.info('---------------------------------');
        this.handler.getCmds(true).forEach((c) => this.inspectCmd(c));
        return true;
    }
}