add tests and fix some errors

This commit is contained in:
Philipp Kunz
2015-11-09 04:02:46 +01:00
parent 5444f1d3c0
commit 55cdd7f803
5 changed files with 172 additions and 18 deletions

View File

@@ -2,14 +2,14 @@
nodejs wrapper for CLI related tasks
[![Dev Status](https://img.shields.io/badge/DevStatus-Active-green.svg)](https://github.com/pushrocks/smartcli/commits/dev)
### Buildstatus/Dependencies
## Buildstatus/Dependencies
[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
[![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
### Install the package
## Install the package
npm install smartcli
### Usage
## Usage
this plugin tries to establish some logic in which CLI tools work.
@@ -24,11 +24,23 @@ mytool function argument1 argument2 --option1 option1Value --option2 option2Valu
* option is an option you can add (like -m for message)
* optionValue is the referenced option value (like a commit message)
### The inner organization of smartcli
**smartcli** exposes three major groups of functions:
* check functions
* are grouped in **smartcli.checks** object
* get functions
* are grouped in **smartcli.get** object
* async interaction functions
* are grouped in **smartcli.interaction** object
```js
var smartcli = require("smartcli");
/* -------------- Check Functions -------------------*/
//returns true for terminal command "node myjs.js jazz"
smartcli.checkCommand('jazz');
smartcli.check.command('jazz');
/**
* returns an object for terminal command "node myjs.js --myoption something" like so
@@ -38,7 +50,7 @@ smartcli.checkCommand('jazz');
* value: 'something'
* }
*/
smartcli.getOption('myoption');
smartcli.get.option('myoption');
```
Cheers