setup-coffee-library

A utility to create CoffeeScript library projects that integrate with Github, Travis CI & mocha out of the box

npm install setup-coffee-library
3 downloads in the last week
12 downloads in the last month

setup-coffee-library

A utility to create CoffeeScript library projects that integrate with Github, Travis CI & mocha out of the box

Features

  • Integrates mocha with travis-ci out of the box
  • Includes cake publish to ensure you don't publish out-of-date JS code
  • Runs git init and npm install so you can quickly get started

Installation

sudo npm install -g setup-coffee-library

Usage

setup-coffee-library <appname> <author> <description>

<appname> should be the name of your Github repository
<author> should be your Github username
<description> should be the library's description

This will create a directory with the app name and populate it with the necessary files to develop a CoffeeScript library.

Cakefile

Baked into the Cakefile:

cake build                # transpile src/*.coffee to lib/*.js
cake clean                # delete everything in lib/
cake publish              # clean, build & publish
cake test                 # run tests with mocha

Notes

  • All tests in the test directory should be named *test.coffee (case insensitive).

Enjoy!

npm loves you