Jumpstart template for a nice CoffeeScript npm module


Jumpstart template for an npm module written in CoffeeScript, but published as Javascript (including source maps). It also includes handy default settings for Textmate 2.

This template assumes

  • you're using github
  • you want the github repository name to be the same as the npm module name
  • you want to release your code under the MIT License.

If you don't like these assumptions, or any other choices made, you can easily customize the template by forking it and checking out locally.

npm install jumpstart
npm install jumpstart-black-coffee

Jumpstart looks for a .jumpstart.json file inside your current working directory - or if not found, in your home directory - for global values for the various placeholders.

jumpstart dirname black-coffee will first ask for values for placeholders inside the black-coffee template, then create a new directory dirname containing the filled-out template.

Notes on proper placeholders values:

  • github-repos-path -- either /user/repos or /orgs/[orgname]/repos (without the brackets)
  • github-owner-name -- either the same as github-username, or your github organization name.
  • module-is-private -- either the string true or the string false. Jumpstart does not know about booleans. If you give it any other value (e.g. leave it blank), you'll end up with invalid json in the generated files.

After creating a new project you can run the following commands:

  • make build -- compiles all .coffee files in src/ and outputs into lib/.
  • make watch -- watches src/ for changes, and compiles any changed .coffee file to lib/.
  • make jumpstart --
    • creates a github repo with the specified module name in the specified repos path (for your organization or for yourself)
    • initializes empty git repository
    • sets github repo as origin
    • adds files, and commits with specified commit-message
    • pushes the repository to github

jumpstart-black-coffee is released under the MIT License.
Copyright (c) 2013 Meryn Stol