JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2136
  • Score
    100M100P100Q107823F
  • License MIT

Creates a nice output for a CLI --help

Package Exports

  • render-help

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (render-help) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

render-help

Creates a nice output for a CLI --help

npm version

Installation

<pnpm|yarn|npm> add render-help

Usage

import renderHelp from 'render-help'

const output = renderHelp({
  usages: ['pnpm install [options]'],
  aliases: ['i'],
  description: 'Install all dependencies',
  descriptionLists: [
    {
      title: 'Options',
      list: [
        {
          name: '-force',
          shortAlias: '-f',
          description: 'Do some dangerous things'
        }
      ]
    }
  ],
  url: 'https://pnpm.js.org/en/cli/install'
})
console.log(output)
// Usage: pnpm install [options]
//
// Alias: i
//
// Install all dependencies
//
// Options:
//   -f, -force               Do some dangerous things
//
// Visit https://pnpm.js.org/en/cli/install for documentation about this command.

License

MIT © Zoltan Kochan