https://github.com/twilson63/cakefile-template

This is a cakefile template for coffeescript, docco and mocha
https://github.com/twilson63/cakefile-template

Last synced: 9 days ago
JSON representation

This is a cakefile template for coffeescript, docco and mocha

• Host: GitHub
• URL: https://github.com/twilson63/cakefile-template
• Owner: twilson63
• Created: 2011-09-08T20:00:51.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2016-01-14T14:29:55.000Z (almost 9 years ago)
• Last Synced: 2024-08-02T12:22:54.552Z (3 months ago)
• Language: CoffeeScript
• Homepage: http://twilson63.github.io/cakefile-template
• Size: 35.2 KB
• Stars: 89
• Watchers: 7
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Cakefile Template

If you write a lot of coffeescript and get tired of 

setting up your build, watch and spec tasks, grab this 

Cakefile and put it in your project.

# Install

```bash

# In your project directory...

curl https://raw.github.com/twilson63/cakefile-template/master/Cakefile >> Cakefile

## If that does not work... try

curl https://raw.githubusercontent.com/twilson63/cakefile-template/master/Cakefile >> Cakefile

```

# Usage

## Compiling

Put all of your coffee-script in the src folder, it will compile all coffee-script

in your lib folder, using the build command.

```bash

cake build

```

## Watching 

If you want to compile as you write your code, invoke the watch command.

```bash

cake watch

```

## Testing

If you want to run your tests, assuming you are using mocha.

```bash

cake test

```

## Documenting

```bash

cake docs

```

## Options ##

If you want to generate HTML5 maps when compiling (watching), add 'm' before `compile` or `watch`:

```bash

cake -m compile

```

`clean` will also take care of mapping files. 

More information about mapping can be found on [HTML5rocks](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) or [Coffeescript.org](http://coffeescript.org/#source-maps).

Have Fun!