meow-help
Generate help text for meow.
Last updated 2 months ago by maartenbrakkee .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install meow-help 
SYNC missed versions from official npm registry.

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

Current Tags

  • 0.3.0                                ...           latest (2 months ago)

3 Versions

  • 0.3.0                                ...           2 months ago
  • 0.2.0                                ...           2 months ago
  • 0.1.0                                ...           2 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dev Dependencies (7)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |