Nattily Polished Marbles

    base-argv

    0.5.0 • Public • Published

    base-argv NPM version NPM downloads Build Status

    Plugin that post-processes the object returned from yargs-parser so that values can be passed over to base-cli

    Install

    Install with npm:

    $ npm install base-argv --save

    Usage

    Use as a plugin with base.

    var Base = require('base');
    var argv = require('base-argv');
     
    var app = new Base();
    app.use(argv());
     
    // parse argv
    var args = app.argv(['foo', 'bar', '--set=a:b']);
    console.log(args);

    Results in:

    { set: { a: 'b' }, tasks: [ 'foo', 'bar' ] }

    This object can then be passed to something else for further processing.

    Related projects

    You might also be interested in these projects:

    • base-cli: Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… more | homepage
    • base-config: base-methods plugin that adds a config method for mapping declarative configuration values to other 'base'… more | homepage
    • base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
    • base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after… more | homepage
    • base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Building docs

    Generate readme and API documentation with verb:

    $ npm install verb && npm run docs

    Or, if verb is installed globally:

    $ verb

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb, v0.9.0, on May 24, 2016.

    Install

    npm i base-argv

    DownloadsWeekly Downloads

    28,539

    Version

    0.5.0

    License

    MIT

    Last publish

    Collaborators

    • doowb
    • jonschlinkert