@oclif/plugin-help

  • Version 3.2.2
  • Published
  • 50.1 kB
  • 10 dependencies
  • MIT license

Install

npm i @oclif/plugin-help
yarn add @oclif/plugin-help
pnpm add @oclif/plugin-help

Overview

standard help for oclif

Index

Functions

function getHelpClass

getHelpClass: (config: any, defaultClass?: string) => HelpBaseDerived;

    Classes

    class Help

    class Help extends HelpBase {}

      constructor

      constructor(config: any, opts?: Partial<HelpOptions>);

        property render

        render: (input: string) => string;

          property sortedCommands

          readonly sortedCommands: any[];

            property sortedTopics

            readonly sortedTopics: any[];

              method command

              protected command: (command: any) => string;
              • Parameter command

                The command to generate readme help for {string} the readme help string for the given command

                Deprecated

                used for readme generation

              method formatCommand

              protected formatCommand: (command: any) => string;

                method formatCommands

                protected formatCommands: (commands: Config.Command[]) => string;

                  method formatRoot

                  protected formatRoot: () => string;

                    method formatTopic

                    protected formatTopic: (topic: any) => string;

                      method formatTopics

                      protected formatTopics: (topics: Config.Topic[]) => string;

                        method showCommandHelp

                        showCommandHelp: (command: any) => void;

                          method showHelp

                          showHelp: (argv: string[]) => void;

                            method showRootHelp

                            protected showRootHelp: () => void;

                              method showTopicHelp

                              protected showTopicHelp: (topic: any) => void;

                                class HelpBase

                                abstract class HelpBase {}

                                  constructor

                                  constructor(config: any, opts?: Partial<HelpOptions>);

                                    property config

                                    protected config: any;

                                      property opts

                                      protected opts: HelpOptions;

                                        method showCommandHelp

                                        abstract showCommandHelp: (command: any, topics: Config.Topic[]) => void;
                                        • Show help for an individual command

                                          Parameter command

                                          Parameter topics

                                        method showHelp

                                        abstract showHelp: (argv: string[]) => void;
                                        • Show help, used in multi-command CLIs

                                          Parameter args

                                          passed into your command, useful for determining which type of help to display

                                        Interfaces

                                        interface HelpOptions

                                        interface HelpOptions {}

                                          property all

                                          all?: boolean;

                                            property maxWidth

                                            maxWidth: number;

                                              property stripAnsi

                                              stripAnsi?: boolean;

                                                Package Files (2)

                                                Dependencies (10)

                                                Dev Dependencies (20)

                                                Peer Dependencies (0)

                                                No peer dependencies.

                                                Badge

                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@oclif/plugin-help.

                                                • Markdown
                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@oclif/plugin-help)
                                                • HTML
                                                  <a href="https://www.jsdocs.io/package/@oclif/plugin-help"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>