checko

Sometimes simplicity is key. I find that to be the case for assertion libraries as well. There are tonnes of them out there and most of them come with all kinds of crazy features and implementations. These make it relatively difficult to understand what exactly is being tested, how to use the library to create your own assertions and to compose new predicates and assertions out of the existing ones.

The predicates and assertions in checko

• have predictable names,
• have simple implementations,
• and can be composed.

Documentation

Documentation for 1.0.0 can be found here.

Contributing

Here is some information in case you would like to contribute to this project.

Organization

The source code for this package lives in the root of the repository. The package is built to the release/ directory which is ignored by git. The package.json along with some other files are also built to the release/ directory. This architecture allows us to have code at the root of the repository even if we are transpiling it. Having code at the root means we can include it like so

import aBitOfFunctionality from 'my-package/aBitOfFunctionality'

// versus

import aBitOfFunctionality from 'my-package/lib/aBitOfFunctionality'

Cloning

git clone <repo_url> <repo_folder>
cd <repo_folder>
npm install
npm run setup

Publishing

To publish a new version of this package you need to update its version, build it and publish it. This procedure is usually done with the following commands.

npm version (major|minor|patch)
cd release/
npm publish