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 use Mocha for writing tests, or you don't mind having it available;
- you want to release your code under the MIT License.
npm install jumpstartnpm 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.
See Jumpstart documentation for
jumpstart dirname black-coffee
You will be asked to provide values for the placeholders inside the
black-coffee template. Jumpstart then creates a new directory
dirname containing the filled-out template.
Notes on proper placeholders values:
github-ownername-- will be used for the github repository url. Set it either to the same as
github-username, or to the name of a github organization you are a member of.
module-is-private-- either the string
trueor 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 it's recommended you run the following command once:
Go to your newly created project directory.
npm run jumpstart
npm install, which will install the dev-dependencies (
- creates an empty
.coffeefile named after the module in both
npm run jumpstart afterwards is optional.
During development, you can make use of the following commands.
npm run build-- compiles all .coffee files in src/ and outputs into lib/.
npm run watch-- let
coffeewatch src/ for changes, and compile any changed .coffee file to lib/.
npm test-- runs
npm run build, and mocha tests afterwards
These commands require the dev-dependencies to be installed. You can do so with
When you do
When you attempt to make a commit with git,
npm test will also be run first.
See also the Jumpstart documentation.
jumpstart-black-coffee is released under the MIT License. Copyright (c) 2016 Braveg1rl