Wondering what’s next for npm?Check out our public roadmap! »

    checkers

    0.13.1 • Public • Published

    checkers

    npm version Build Status

    Property-based testing for JavaScript via ClojureScript's test.check.

    test.check is a Clojure property-based testing tool inspired by QuickCheck. The core idea of test.check is that instead of enumerating expected input and output for unit tests, you write properties about your function that should hold true for all inputs. This lets you write concise, powerful tests.

    Checkers brings the power of test.check to plain ol' JavaScript.

    Install

    npm install checkers --save
    

    Usage

    var checkers = require('checkers');
    var gen = checkers.gen;
     
    // Property is incorrect
    checkers.forAll(
        [gen.int],
        function(i) {
            return i * i > i;
        }
    ).check(1000);
     
    // Property is now correct
    checkers.forAll(
        [gen.int],
        function(i) {
            return i * i >= i;
        }
    ).check(1000);
     
    // Check property with a particular seed
    checkers.forAll(
        [gen.int],
        function(i) {
            return i * i >= i;
        }
    ).check(1000, {seed: 1422111938215});

    Usage with Mocha

    Checkers comes with a helper function to make writing tests for mocha simpler.

    var checking = require('checkers/mocha');
    var gen = checking.gen;
    describe("Addition", function() {
        checking("+1", [gen.int], function(i) {
            return i + 1 > i;
        }, 100, {seed: 1422111938215});
    });

    The count is optional, and defaults to 1000. The extra options are also optional.

    Full Documentation

    More coming soon!

    For now you'll have to rely on the examples in the test folder.

    TODO

    • Generator tests
    • Generator docs
    • Sugar for other testing frameworks?
    • Tutorial
    • Better examples

    Development

    See npm run or package.json for a list of available scripts.

    You will need leiningen in order to build locally.

    License

    Distributed under the Eclipse Public License.

    checkers is Copyright © 2015 Glen Mailer and contributors.

    test.check is Copyright Rich Hickey, Reid Draper and contributors.

    Install

    npm i checkers

    DownloadsWeekly Downloads

    12

    Version

    0.13.1

    License

    EPL

    Last publish

    Collaborators

    • avatar