Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

52 lines (33 sloc) 3.771 kB

Grunt homepage | Documentation table of contents

Frequently Asked Questions

When will I be able to use in-development feature 'X'?

While critical bug fixes are applied to both the latest stable release as well as the in-development version of grunt, new features are usually only added to the in-development version.

If you want to install the latest bleeding-edge, in-development version, you can npm install grunt@devel. This is something you do not want to do in a project, as the in-development version of grunt is constantly evolving and a feature you've come to depend on may have changed between installs of grunt@devel, thus breaking your build.

If you want to install an in-development version of grunt, locked in at a specific commit (totally fine for projects), follow the instructions for specifying a git URL as a dependency, and be sure to specify an actual commit SHA (not a branch name) as the commit-ish.

Finally, it is preferable to specify grunt as a devDependency in your project's package.json and instruct users to do npm install than to have them install grunt explicitly with npm install grunt. This makes the task of installing grunt (and any other dev dependencies) much easier and less error-prone.

On Windows, why does my JS editor open when I try to run grunt?

If you're in the same directory as the grunt.js gruntfile, Windows tries to execute that file when you type grunt. So you need to type grunt.cmd instead.

An alternative would be to use the DOSKEY command to create a grunt macro, following these directions. That would allow you to use grunt instead of grunt.cmd.

This is the DOSKEY command you'd use:

DOSKEY grunt=grunt.cmd $*

Why does grunt complain that PhantomJS isn't installed?

In order for the qunit task to work properly, PhantomJS must be installed and in the system PATH (if you can run "phantomjs" at the command line, this task should work).

Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS.

Note that the phantomjs executable needs to be in the system PATH for grunt to see it.

Why doesn't my asynchronous task complete?

Chances are this is happening because you have forgotten to call the this.async method to tell grunt that your task is asynchronous. For simplicity's sake, grunt uses a synchronous coding style, which can be switched to asynchronous by calling this.async() within the task body.

Note that passing false to the done() function tells grunt that the task has failed.

For example:

grunt.registerTask('asyncme', 'My asynchronous task.', function() {
  var done = this.async();
  doSomethingAsync(done);
});
Jump to Line
Something went wrong with that request. Please try again.