/ live.thehmm.nl / back / node_modules / commist /

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[   ]LICENSE40 years ago1.1K 
[TXT]README.md40 years ago1.5Kd7c1522 post receive test [كارل مبارك]
[   ]example.js40 years ago658  
[   ]index.js40 years ago3.6K 
[   ]package.json2 years ago1.5K 
[   ]test.js40 years ago4.1K 
README.md

commist

Build Status

Build command line application with multiple commands the easy way. To be used with minimist.

var program = require('commist')()
  , minimist = require('minimist')
  , result

result = program
  .register('abcd', function(args) {
    console.log('just do', args)
  })
  .register({ command: 'restore', equals: true }, function(args) {
    console.log('restore', args)
  })
  .register('args', function(args) {
    args = minimist(args)
    console.log('just do', args)
  })
  .register('abcde code', function(args) {
    console.log('doing something', args)
  })
  .register('another command', function(args) {
    console.log('anothering', args)
  })
  .parse(process.argv.splice(2))

if (result) {
  console.log('no command called, args', result)
}

When calling commist programs, you can abbreviate down to three char words. In the above example, these are valid commands:

node example.js abc
node example.js abc cod
node example.js anot comm

Moreover, little spelling mistakes are corrected too:

node example.js abcs cod

If you want that the command must be strict equals, you can register the command with the json configuration:

  program.register({ command: 'restore', strict: true }, function(args) {
    console.log('restore', args)
  })

Acknowledgements

This project was kindly sponsored by nearForm.

License

MIT

Apache/2.4.38 (Debian) Server at www.karls.computer Port 80