Programmatically set options for grunt task?

16

votes

I have a grunt task that looks at options with grunt.option('foo'). If I'm calling this task from grunt.task.run('my-task'), how can I change those arguments?

I'm looking for something like:

grunt.task.run('my-task', {foo: 'bar'});

which would be the equivalent of:

$ grunt my-task --foo 'bar'

Is this possible?

(This question is another issue I ran in to but is not exactly the same, because in this case I don't have access to the original task's Gruntfile.js.)

javascriptgruntjs

20

votes

If you can use task-based config options instead of grunt.option, this should work to give you more granular control:

grunt.config.set('task.options.foo', 'bar');

12

votes

Looks like I can use the following:

grunt.option('foo', 'bar');
grunt.task.run('my-task');

It feels a bit odd to set the options globally instead of just for that command, but it works.

7

votes

Create a new task which set the option, then call the modified task. This is a real life example with assemble:

grunt.registerTask('build_prod', 'Build with production options', function () {
  grunt.config.set('assemble.options.production', true);
  grunt.task.run('build');
});

4

votes

In addition to @Alessandro Pezzato

Gruntfile.js:

grunt.registerTask('build', ['clean:dist', 'assemble', 'compass:dist', 'cssmin', 'copy:main']);

    grunt.registerTask('build-prod', 'Build with production options', function () {
        grunt.config.set('assemble.options.production', true);
        grunt.task.run('build');
    });

    grunt.registerTask('build-live', 'Build with production options', function () {
        grunt.option('assemble.options.production', false);
        grunt.task.run('build');
    });

Now you can run

$ grunt build-prod

-OR-

$ grunt build-live

They will both do the full task 'build' and respectively pass a value to one of the options of assemble, namely production 'true' or 'false'.

In addition to illustrate the assemble example a bit more:

In assemble you have the option to add a {{#if production}}do this on production{{else}}do this not non production{{/if}}

1

votes

grunt is all programmatic.. so if you have set options on tasks before, you have done this programmatically.

just use grunt.initConfig({ ... }) to set options for tasks.

and if you already initialized, and need to change configuration afterwards, you can do something like

grunt.config.data.my_plugin.goal.options = {};

I am using it for my project and it works.

0

votes

I recently ran up against this same issue: programmatically setting grunt options and running tasks multiple times from within a single parent task. As @Raphael Verger mentions, this is not possible, as grunt.task.run defers the running of the task until the current task is finished:

grunt.option('color', 'red');
grunt.task.run(['logColor']);
grunt.option('color', 'blue');
grunt.task.run(['logColor']);

Will result in the color blue being logged twice.

After some fiddling, I came up with a grunt task that allows dynamically specifying a different option/config for each sub-task to be run. I've published the task as grunt-galvanize. Here's how it works:

var galvanizeConfig = [
  {options: {color: 'red'}, configs: {}},
  {options: {color: 'blue'}, configs: {}}
];
grunt.option('galvanizeConfig', galvanizeConfig);
grunt.task.run(['galvanize:log']);

This will log red then blue, as desired by running the log task with each of the options/configs specified in galvanizeConfig.

Programmatically set options for grunt task?

6 Answers