/kitchen-sink

Random things that don't fit into any other repo yet.

Primary LanguageShellMIT LicenseMIT

kitchen-sink

Random things that don't fit into any other repo yet.

broccoffee

What?

Bash script for setting up a new CoffeeScript npm module to be built with broccoli.

Sets up .gitignore, .npmignore, Brocfile etc. and creates a broc.sh script that you can run to start broccoli-timepiece.

For more details it is recommended to just read the script.

How to use?

  1. Create a new module with npm init, specify that the main file sits in lib, e.g. lib/index.js
  2. Run broccoffee (for optional parameters see below)
  3. Put your .coffee files in src, e.g. src/index.coffee
  4. Run broc.sh to start broccoli-timepiece, it will compile your CoffeeScript files whenever you save them.

If you want you can also add one or two parameters to broccoffee to specify the source folder or both the source folder and the lib folder, e.g. "broccoffee source" or "broccoffee source bin". Changing the source folder can be useful if you only want to add the source folder as a project folder in atom, so you won't have to see all the boilerplate files in your module's root directory.