Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

70 lines (39 sloc) 2.75 KB

Contributing to Testem

Open source is all about DIY! If you want something fixed, it's sometimes faster to just roll your sleeves up, not to mention lots more rewarding. This doc will give you some pointers on where to look when you poke around Testem's source code.

Brief Code Walk Through

testem.js is the main entry point of the program. It then delegates to either lib/dev/index.js or lib/ci/index.js depending on whether it's development mode testem or continuous integration mode testem ci. All of the rest of the Node application's source is under the lib folder. You can probably figure out the rest from there.

The source code for the browser side is under the folders public/testem and views

  • public/testem - is where the client side assets are (Javascript and CSS)
  • views - are HTML templates used to generate default test runner pages

Debug Mode

Use the -d flag to turn on debug mode. This will allow you to use'some log message')

To log to the debug log, which is testem.log. If the log is not present in a module file, just require npmlog like so at the top of the file

var log = require('npmlog')

Then, in a separate terminal you can tail the log and monitor debug messages

tail -f testem.log

Tests and Examples

To maximize the chances of your pull request getting merge, you should go with a test-first approach. That means:

  1. write a failing test that demonstrates the bug or lack of feature
  2. fix bug or implement feature, getting the test to pass

To run the tests:

npm test

Or in the spirit of eating our own dog food:


If it isn't practical to write a test first, it might be my fault, feel free to chat.

Protip: to make the tests run faster during TDD, use Mocha's exclusive test feature, i.e. describe.only and it.only.

Integration Tests

There are also some integrations tests that test running all the examples in the examples folder by cd'ing into each and executing testem ci

On Unix do


and on Windows do


Coding Style

This is where I am going deviate from the norm. I like writing semicolon-less Javascript. It is unconventional, but there's is a method to the madness. To master this style of Javascript, read's article for the short version or inimino's for the long version. You are not required to follow my coding style though. The only principles you should follow are

  1. Have fun.
  2. Be thoughtful of others.
Jump to Line
Something went wrong with that request. Please try again.