chi-build

chi-build

Custom build tool for the chi modules.

This tool is custom-made for modules such as chi-create. It is not intended to be a general-purpose build utility.

Linting

Lint JS files with JSHint by running chi-build lint. This lints the JS files with the options specified in the jshint.json file in this repositiory.

Tests

Tests must be written in the test.js file in the working directory. The file will be automatically bundled by browserify.

Automated Tests

Run automated tests with the chi-build test command. Before automated tests are run, all JS files are linted. This runs the tests with sauce-tap-runner. It will run the tests in browsers listed in the browsers.json file in this repository. The tests will be run by browsers in Sauce Labs. The SAUCE_USER and SAUCE_KEY environment variables must be set to your Sauce username and key, respectively.

Local Tests

Serve tests locally with the chi-build serve command. This will bundle and serve the tests in the same way as the automated tests. The output of the tests will be displayed directly on the browser page. Use the --port option to determine the port that it will listen on (default 8000). Just refresh the page to re-bundle and re-run the tests.

API

You can also use the JS API instead of using the chi-build tool.

test(callback)

Runs all the tests in the browsers. Note that this will not lint the files. Callback will return an error if tests failed in any of the browsers.

lint(callback)

Lints the JS files. Callback will return an error if lint errors were found on any of the files.

serve(options, callback)

Starts the test server locally. Same as chi-build serve. options may contain a port option to specify the port it will listen on. Callback will return an error if it could not start the server.