Grunt Toolkit

Ghost has a number of tasks which are automated via Grunt. The following document explains what each thing does. You can also get help when running grunt by typing grunt --help

The default grunt task does two things:

1. compile sass into css
2. compile the templates in core/client/tpl into the hbs-tpl.js file

These are commonly needed after pulling changes from master, so it's recommended to always do it after a pull as a matter of habit.

If you have a fresh repo and are running grunt for the first time, you'll need to run grunt init rather than just grunt as this also installs bourbon. This only has to be done once on a repo.

grunt validate runs 3 sets of tests: jsLint, mocha unit tests and casperjs functional tests.

This can take a while, so it makes sense to run the individual sections if you're working on specific things.

• grunt jslint will run just the linter
• grunt test-unit will run all of the unit tests, grunt test-api will run the data model unit tests which are incorrectly labeled api, see mochacli config in Gruntfile.js for a full set of the individual groups of tests which can be run and feel free to add your own.
• grunt test-functional will run the functional tests

The grunt prod task goes one step beyond the default grunt task and minifies the Ghost JavaScript source for production via an additional uglify task.

When you're ready to deploy to production, running grunt prod first is a wise choice.