Nothing's plumb meaningless

    yargs-help-output

    2.0.1 • Public • Published

    yargs-help-output

    npm version

    Update docs to include the full output of yargs help

    CLI API

    yargs-help-output <input-file-path>
    
    Update docs to include the full output of yargs help
    
    Positionals:
      input-file-path  The file to be updated                               [string]
    
    Options:
      --help               Show help                                       [boolean]
      --version            Show version number                             [boolean]
      --bin-path           The yargs entry file if you're running it directly
                                                                            [string]
      --npm-script-name    The NPM script that runs your yargs CLI          [string]
      --replacement-sigil  The metadata divider used to find the replacement
                                     [string] [default: "<!-- CODEGEN_CLI_HELP -->"]
      --help-text-modify   String/regex replacements to modify the help text (ex
                           --help-text-modify.search "^foo$"
                           --help-text-modify.replacement "")  [array] [default: []]
    

    JS API

    let outputString = await updateHelpTextByString({
      // required
      inputString,
    
      // optional
      replacementSigil = '<!-- CUSTOM_SIGIL -->',
    
      // optional
      helpTextModifyReplacements: [
        [/^Options:$\r?\n/m, ''],
      ],
      // and/or
      helpTextModifyCallback(helpText) {
        return helpText.replace(/^Options:$\r?\n/m, '');
      },
    
      binPath: './my-cli.js',
      // or
      npmScriptName: 'start',
    
      // optional
      cwd,
    });
    
    await updateHelpTextByFile({
      // required
      inputFilePath,
    
      // optional
      replacementSigil = '<!-- CUSTOM_SIGIL -->',
    
      // optional
      helpTextModifyReplacements: [
        [/^Options:$\r?\n/m, ''],
      ],
      // and/or
      helpTextModifyCallback(helpText) {
        return helpText.replace(/^Options:$\r?\n/m, '');
      },
    
      binPath: './my-cli.js',
      // or
      npmScriptName: 'start',
    
      // optional
      cwd,
    });

    Keywords

    none

    Install

    npm i yargs-help-output

    DownloadsWeekly Downloads

    48

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    12.1 kB

    Total Files

    7

    Last publish

    Collaborators

    • crowdstrike-publisher