Decaf-CLI

Caffeine free tests and assertions.

Decaf is inspired by Mocha and Chai. It is simpler under the hoood, however, and therefore runs more quickly and has far fewer dependencies.

Installation

You can install Decaf via npm:

npm install decaf-cli

There is no need to install it globally, the recommended approach is to run it by way of npm sciprts. If you do decide to install it globally, however, you may need to prepend sudo, depending on your setup.

If you would like to contribute or would simply like to have a look at the code, you can clone the repository with Git...

git clone https://github.com/djalbat/decaf-cli.git

...then install the dependencies with npm from within the project's root directory:

npm install

Usage

Decaf has the following commands and options:

  decaf [<options>] [<command>] [<argument>] 

Commands:

  help                                           Show this help

  version                                        Show the version
  
  test                                           Run the tests
  
Arguments:

  entry                                          The entry point, either a file or a directory
  
Options:

  --version|-v                                   Show the version

  --help|-h                                      Show this help

  --fail-fast|-f                                 Exit on the first failure

There is really only one use case, namely running the tests. In order to do so, run the following command:

decaf test

Note that there is no need to specify the test command, the test here is the name of the test directory.

The only option to use when running tests is fail-fast, which will cause Decaf to exit the first time a test fails.

Note that Decaf will return a zero exit code upon success and a non-zero exit code upon failure.

Contact

• [email protected]