meow-help

0.3.0 • Public • Published

meow-help Build Status Coverage Status

Help text generator for meow.

Features

  • Generates clean and styled help text
  • Simplifies the usage of meow

Install

$ npm install meow-help

Usage

const meowHelp = require("meow-help");
const meow = require("meow");
const foo = require(".");
 
const flags = {
  rainbow: {
    type: "boolean",
    alias: "r",
    description: "Include a rainbow."
  }
}
 
const cli = meow(meowHelp(flags), {
    flags: flags
});
 
foo(cli.input[0], cli.flags);

API

meowHelp(flags, description);

Returns a String that can be passed as helpText to meow.

Name Type Required Description
flags Object Flags object for meow, extended with descriptions.
description String Extra description text shown when --help is called.

License

MIT © Maarten Brakkee

Package Sidebar

Install

npm i meow-help

Weekly Downloads

1

Version

0.3.0

License

MIT

Unpacked Size

14 kB

Total Files

20

Last publish

Collaborators

  • maartenbrakkee