woofwoof

    3.6.7 • Public • Published

    woofwoof Build Status

    CLI app helper forked from the popular meow using nconf instead of mimimist

    Features

    • Parses arguments, reads settings from config file and evironment using nconf
    • Converts flags to camelCase
    • Outputs version when --version
    • Save settings in users home directory when --save-settings
    • Outputs description and supplied help text when --help
    • Makes unhandled rejected promises fail loudly instead of the default silent fail
    • Sets the process title to the binary name defined in package.json

    Install

    $ npm install --save woofwoof
    

    Usage

    $ ./foo-app.js unicorns --rainbow
    
    #!/usr/bin/env node
    'use strict';
    const woofwoof = require('woofwoof');
    const foo = require('.');
     
    const cli = woofwoof(`
        Usage
          $ foo <input>
     
        Options
          --rainbow, -r  Include a rainbow
     
        Examples
          $ foo unicorns --rainbow
          🌈 unicorns 🌈
    `, {
        alias: {
            r: 'rainbow'
        }
    });
    /*
    {
        input: ['unicorns'],
        flags: {rainbow: true},
        ...
    }
    */
     
    foo(cli.input[0], cli.flags);

    API

    woofwoof(options, [minimistOptions])

    Returns an Object with:

    • input (Array) - Non-flag arguments
    • flags (Object) - Flags converted to camelCase
    • pkg (Object) - The package.json object
    • help (string) - The help text used with --help
    • showHelp([code=2]) (Function) - Show the help text and exit with code

    options

    Type: Object Array string

    Can either be a string/array that is the help or an options object.

    description

    Type: string boolean
    Default: The package.json "description" property

    Description to show above the help text.

    Set it to false to disable it altogether.

    help

    Type: string boolean

    The help text you want shown.

    The input is reindented and starting/ending newlines are trimmed which means you can use a template literal without having to care about using the correct amount of indent.

    The description will be shown above your help text automatically.

    Set it to false to disable it altogether.

    version

    Type: string boolean
    Default: The package.json "version" property

    Set a custom version output.

    Set it to false to disable it altogether.

    pkg

    Type: Object
    Default: Closest package.json upwards

    package.json as an Object.

    You most likely don't need this option.

    argv

    Type: Array
    Default: process.argv.slice(2)

    Custom arguments object.

    inferType

    Type: boolean
    Default: false

    Infer the argument type.

    By default, the argument 5 in $ foo 5 becomes a string. Enabling this would infer it as a number.

    minimistOptions

    Type: Object
    Default: {}

    Minimist options.

    Keys passed to the minimist default option are decamelized, so you can for example pass in fooBar: 'baz' and have it be the default for the --foo-bar flag.

    Promises

    woofwoof will make unhandled rejected promises fail loudly instead of the default silent fail. Meaning you don't have to manually .catch() promises used in your CLI.

    Tips

    See chalk if you want to colorize the terminal output.

    See get-stdin if you want to accept input from stdin.

    See conf if you need to persist some data.

    See update-notifier if you want update notifications.

    More useful CLI utilities.

    License

    MIT © Sindre Sorhus

    portions MIT © Nicholas Waltham

    Install

    npm i woofwoof

    DownloadsWeekly Downloads

    0

    Version

    3.6.7

    License

    MIT

    Last publish

    Collaborators

    • avatar