parse-help

Parse CLI help output

Install

$ npm install parse-help

Usage

import parseHelp from 'parse-help';

const help = `
	Usage
	  $ unicorn <name>

	Options
	  --rainbow    Lorem ipsum dolor sit amet
	  -m, --magic  Aenean commodo ligula eget dolor
	  --pony       Nullam dictum felis eu pede
	  -c, --color  Donec quam felis

	Examples
	  $ unicorn Peachy
	  $ unicorn Sparkle --rainbow --magic
`;

parseHelp(help);
/*
{
	flags: {
		rainbow: {
			description: 'Lorem ipsum dolor sit amet'
		},
		magic: {
			alias: 'm',
			description: 'Aenean commodo ligula eget dolor'
		},
		pony: {
			description: 'Nullam dictum felis eu pede'
		},
		color: {
			alias: 'c',
			description: 'Donec quam felis'
		}
	},
	aliases: {
		m: 'magic',
		c: 'color'
	}
}
*/

Related

• aliases - Parse flag aliases in CLI help output

Current Tags

• 2.0.0                                ...           latest (5 years ago)

4 Versions

• 2.0.0                                ...           5 years ago
• 1.0.0                                ...           8 years ago
• 0.1.1                                ...           10 years ago
• 0.1.0                                ...           10 years ago