Building

To compile wu.js and its tests to ES5 using the Babel compiler, run:

$ npm run build

This command regenerates:

• dist/wu.js — The ES5 compatible version of wu.js.
• dist/wu.debug.js — The ES5 compatible version of wu.js with an inline source map included.
• dist/wu.min.js — The minified ES5 compartible version of wu.js.

Tests

Running the Test Suite

$ npm test

Creating New Tests

To add a new test, find or create the appropriate file in test/test-X.js. Mocha is the test runner. Chai's assert module is used for assertions.

Documentation

This documentation is created with the static site generator Jekyll. To set up jekyll, run:

$ gem install jekyll bundler
$ cd path/to/wu.js
$ bundle install

Once Jekyll is set up, to serve the docs locally and automatically recompile them on change, run:

$ npm run docs

The documentation will be served at http://0.0.0.0:4000.

The sources for this documentation live in index.html and markdown files in the _posts directory. Each wu method has its own markdown file in the _posts directory, and the table of contents for thewu methods is generated automatically. The CSS styles live in index.css.