Skip to content

Latest commit

 

History

History
127 lines (88 loc) · 3 KB

README.md

File metadata and controls

127 lines (88 loc) · 3 KB
Raw

nutty-command

npm npm npm

A command middleware for nutty

Installation

npm install --save nutty-command

Usage

//Import dependencies
var nutty = require('nutty');
var command = require('nutty-command');

//Initialize the cli
nutty.set('name', 'my-app');

//Get the new test command
var command_test = new command('test', 'Test the CLI');

//Add the options
command_test.option({ name: 'msg', detail: 'Print a message', default: 'No message' });
command_test.option({ name: 'upperCase', detail: 'Print the message in upper case', default: false });

//Add the callback function
command_test.callback(function(args, body)
{
  //Check the upperCase option
  if(args.options.upperCase !== false)
  {
    //Get the message in upper case
    args.options.msg = args.options.msg.toUpperCase();
  }

  //Print the test message
  console.log('Message: ' + args.options.msg);
});

//Add the test command
nutty.use(command_test.build());

//No command provided
nutty.use(function(args, body, next){ return console.error('No command provided'); });

//Run the CLI
nutty.run();

In this example, when the user execute the test command of the CLI app, the provided callback fill be invoked:

my-app test
Message: No message

The user can add the msg option:

my-app test --msg "This is my message"
Message: This is my message

//Add with the upper case option

my-app test --msg "My test message" --upperCase
Message: MY TEST MESSAGE

API

cmd = new command(name, description)

Generate a new command object. The constructor accepts two arguments:

  • name: a string with the command name. If the first argument of the CLI matches this string, then the callback function provided will be invoked.
  • description: a string with the command description.

Example:

var cmd = new command('test', 'Test the CLI');

cmd.option(obj)

Add a new option parser for this command. The object must have the following keys:

  • name: a string with the option name (mandatory).
  • detail: a string with the option detail.
  • default: the option default value.

Example:

//Add an option
cmd.opt({ name: 'option', detail: 'My option', default: '' });

cmd.callback(fn)

The function that will be invoked if the user runs this command. This function will be called with the same arguments described here, but without the next function.

Example:

//Callback
cmd.callback(function(args, body)
{
  //Do your magic here
});

cmd.build()

Generate the middleware to be used with the nutty.use method.

License

MIT LICENSE © Josemi Juanes.