twilson63/cakefile-template

This is a cakefile template for coffeescript, docco and mocha

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

# 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.

cake build

Watching

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

cake watch

Testing

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

cake test

Documenting

cake docs

Options

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

cake -m compile

clean will also take care of mapping files.

More information about mapping can be found on HTML5rocks or Coffeescript.org.

Have Fun!

cakefile-template's Issues

Clean task doesn't work on lib directory

The build task creates files in the lib directory but the clean does not remove them.

Mocha does not seem to support CoffeeScript out of the box now

Mocha (1.3.0 at least) does not support .coffee files directly.
CoffeScript has to be enabled explicitly using the --compilers coffee:coffee-script command switch.

Perhaps adding it by default would solve the problem ?

Confusion over directory structure

The coffee command is a bit confusing. It normally will take a directory and output to another directory. In the case of this file that read from src and write to lib. The problem with this structure is that it only deals with coffee files. any other file in the src directory is ignored. For example a library, css or html file.

The other structure is to have the Cakefile in the same directory as the source maybe in a small project. In this situation each file locally would be placed in the files variable and clean would walk the tree for .js files when removing them.

These two scenarios are mutually exclusive with the current use of the coffee command. I'm unclear about how to fix this and would like to open a discussion.

The only idea I have is to force the src / lib structure and then walk the src directory either copying the file or compiling it depending on the file extension. This seems like a lot of work for such a simple concept. Ideas?

Idea: Release the code under the WTFPL

Description

The WTFPL is a highly permissive license that states that You just DO WHAT THE FUCK YOU WANT TO. I would say this license would be perfect for the code as it's mostly just templates and easily editable & tailorable code that can be used for any project.

Proposed Changes

1. Add the text of the license to the repository as the file "copying"
2. Append a line to the end of readme.md: (!http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-2.png! Licensed under the [WTFPL](http://www.wtfpl.net/).)

This template doesn't work properly with CoffeScript 1.7+

To support CoffeeScript 1.7+ apparently the args passed to Mocha need to be changed. The args should now be: --compilers coffee:coffee-script/register

I'm not sure how you want to handle this. Keep this repo supporting 1.6, migrate to 1.7+ or try support both.

Reference: http://stackoverflow.com/questions/9940838/cannot-run-mocha-with-coffeescript