对于一般安装说明,请阅读新手入门指南。如果你在阅完读新手入门指南之后想要了解更多具体的信息,请阅读详细的安装Grunt指南。
依据安装Grunt指南中的说明可以了解如何安装发布的和未发布的开发版本的Grunt(对于插件,你也可以使用npm安装并添加到依赖中使用;对于新的特性可以查阅相关说明安装使用)。
Grunt可以很好的工作在Windows平台,因为Node.js和npm在Windows上都工作得很好(Grunt是基于Node.js的,因而是能够跨平台工作,对于特定平台不支持的特性一般都会有相关说明或者有兼容性的选择来支持)。通常情况下问题在于Cygwin,因为它捆绑了一个过时版本的Node.js。
避免这个问题最好的方式是使用msysGit安装器安装二进制的git
,然后使用Node.js安装器安装二进制的node
和npm
,并且使用内置的Window命令提示符或者PowerShell替代Cygwin(或者说我们首可以先安装好Git环境,然后将托管在Github上的Grunt库克隆到本地来安装使用Grunt,在工具方面Windows对Node.js的支持或许有欠缺,但是在对Node.js本身的支持上已经做得很好了)。
如果发生这种情况可能是由于你忘记调用this.async方法来告诉Grunt,你的任务是异步的。为了简单起见,Grunt使用了同步编码的风格,可以通过在任务体内调用this.async()
方法将该任务转换为异步任务。
注意,可以传递false
给done()
函数来告诉Grunt该任务失败。
例子:
grunt.registerTask('asyncme', 'My asynchronous task.', function() {
var done = this.async();
doSomethingAsync(done);
});
添加下面的代码到你的~/.bashrc
文件中来在Grunt中来启用bash tab自动补全功能:
eval "$(grunt --completion=bash)"
当然前提是你已经使用npm install -g grunt
在全局范围内安装好了Grunt。当前,自动补全唯一支持的shell脚本是bash。
虽然每个任务都可以接受它自己的参数,但是这里有几个选项可以在多个任务之间进行参数共享。
这是在多任务间共享参数的首选方法。
别名任务是非常简单的,一个常规的任务可以使用grunt.task.run方法让它编程一个有效的"动态的"别名任务函数。在下面的例子中,在命令行运行grunt build:001
的结果就是执行foo:001
,bar:001
和baz:001
这三个任务。
grunt.registerTask('build', 'Run all my build tasks.', function(n) {
if (n == null) {
grunt.warn('Build num must be specified, like build:001.');
}
grunt.task.run('foo:' + n, 'bar:' + n, 'baz:' + n);
});
另一种跨多任务共享参数的方式就是使用grunt.option。在下面的例子中,在命令行中运行grunt deploy --target=staging
将导致grunt.option('target')
返回"staging"
。
grunt.registerTask('upload','Upload code to specified target.', function(n){
var target = grunt.option('target');
//在这里使用target做一些有用的事情
});
grunt.registerTask('deploy', ['validate', 'upload']);
注意布尔类型的选项(options)可以只指定使用一个没有值的键。例如,在命行中运行grunt deploy --staging
将导致grunt.option('staging')
返回true
.
在其他情况下,你可能希望暴露一个设置配置或者全局的值方法。 在这种情况下,可以在注册任务时设置其参数作为一个全局对象的或者项目配置的值。
在下面的例子中,在命令行运行grunt set_global:name:peter set_config:target:staging deploy
会导致global.name
的值为"peter"
以及grunt.config('target')
将会返回"staging"
。由此推断,deploy
任务就可以使用这些值。
grunt.registerTask('set_global', 'Set a global variable.', function(name, val){
global[name] = val;
});
grunt.registerTask('set_config', 'Set a config property.', function(name, val){
grunt.config.set(name, val);
});
如果你在Gruntfile所在目录中(在命令行进入到这个目录),当你输入grunt时,Windows中会尝试执行该文件(实际上Windows中会尝试执行grunt.js,因为在0.4.x之前的版本中Gruntfile.js名为grunt.js)。因此你应该输入grunt.cmd
来替代。
另一种方式是使用DOSKEY
命令创建一个Grunt宏, 可以参考也读这篇文章。这样就会允许你使用grunt
来替代grunt.cmd
。
下面是你可以使用的DOSKEY
命令:
DOSKEY grunt=grunt.cmd $*