Package Exports
- render-help
- render-help/lib/index.js
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
Installation
<pnpm|yarn|npm> add render-helpUsage
const renderHelp = require('./lib')
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'
},
{
name: '--lockfile-only',
description: "Don't create node_modules. Just generate pnpm-lock.yaml"
}
]
}
],
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
// --lockfile-only Don't create node_modules. Just generate pnpm-lock.yaml
//
// Visit https://pnpm.js.org/en/cli/install for documentation about this command.