grunt入门讲解5：创建插件，安装Grunt以及常见问题

创建插件

创建插件主要有以下几个步骤：

（1）通过 npm install -g grunt-init 命令安装 grunt-init 。
（2）通过 git clone git://github.com/gruntjs/grunt-init-gruntplugin.git ~/.grunt-init/gruntplugin 命令安装grunt插件模版。
（3）在一个空的目录中执行 grunt-init gruntplugin 。
（4）执行 npm install 命令以准备开发环境。
（5）为你的插件（任务）书写代码。
（6）执行 npm publish 命令将你创建的 Grunt 插件（任务）发布到npm！

注意：你的task命名，"grunt-contrib" 命名空间保留给 Grunt 团队维护的task使用，请给你自己的task起一个合适名字，避免使用被保留的命名空间。

Grunt默认隐藏了error stack traces，但是可以通过 --stack 参数启用，方便你调试自己的task。如果你希望 Grunt 在出现错误时总是能记录下stack trace，可以在你的shell中创建一个命令别名（alias）。例如，在bash中，可以通过 alias grunt='grunt --stack' 命令创建一个别名。这样，你执行grunt时，其实就是在执行grunt --stack。

默认情况下，包含gruntfile文件的目录被设置为当前工作目录。用户可以在自己的gruntfile中通过执行grunt.file.setBase() 改变当前工作目录。

安装Grunt

Grunt 和 Grunt 插件应当在项目的package.json文件中的devDependencies小节中定义。这样就可以通过一个命令将当前项目依赖的模块安装完毕：npm install。当前 Grunt 的稳定版本和开发版本都会在项目的wiki页面中列出。

如果你需要某个特定版本的 Grunt 或 Grunt 插件，执行npm install grunt@VERSION --save-dev 命令，其中VERSION代表你所需要的版本。这样就安装完成了，然后将其添加到package.json文件中的devDependencies小节中。package.json文件中出现的将是波浪线标记的版本范围 。

随着新功能被开发出来，Grunt 会被定期的发布到npm上。如果不指定版本号，这种构建的版本是 根本 不会被安装的。

所以我们必须指定版本，跟安装指定版本的 Grunt 一样，执行npm install grunt@VERSION --save-dev命令，其中VERSION 是你指定的版本，npm将在项目目录中安装此版本的grunt，并将其添加到package.json文件中的devDependencies小节。

注意，不管你指定的是什么版本，都将按照[波浪线标记的版本范围]将其添加到package.json文件中。这个危害很大，当指定的开发版出现新版本，尤其是不兼容的patch版本时，也会被npm安装，这就有可能扰乱你的项目，使其无法编译。

一旦出现这种情况，最重要的是要手工编辑 package.json文件，将 ~ (tilde)从版本号中去除掉。这样就能锁定到你所指定的某个具体的开发版本了。这个技巧同样可以用于安装已经发布的 Grunt 插件的开发版本。

当然，你也可以从github上直接安装，这样将可以确保你的项目永远使用一个精确版本的grunt。

常见问题

Grunt可以在Windows上工作吗?

Grunt可以很好的在windows上工作，因为Node.js和npm都能够很好的在windows上工作。通常情况下，问题在于Cygwin，因为它捆绑着一个较老版本的Node.js。

避免这个问题最好的办法是使用msysGit installer安装二进制的git和使用Node.js installer去安装二进制的node和npm，然后使用内置的Windows command prompt 或 PowerShell 去替代Cygwin。

如何启用shell中的tab键自动补全功能?
为了给grunt增加tab键自动补全功能，可以在你的~/.bashrc文件中添加下面一行代码：

eval "$(grunt --completion=bash)"
当然，你已经使用npm install -g grunt，在全局安装好了Grunt，因为Grunt目前仅支持bash命令。

我如何让多个任务共享参数？
虽然每个任务可以使用它自己的参数，但是，这里有几个方法允许你在多个task中共享参数。

（1）"动态的" 任务别名

这是多个任务共享参数的首选方法

一个普通的task可以使用grunt.task.run方法来执行。在下面这个例子中，在命令行中执行grunt build:001，最终效果是执行foo:001、bar:001 和 baz:001这三个task。

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);

});

（2）选项

多个任务共享参数的方式可以使用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');

　　// do something useful with target here

});

grunt.registerTask('deploy', ['validate', 'upload']);

注意，布尔类型的参数可以使用一个没有值的键。例如，在命令行中执行grunt deploy --staging会让grunt.option('staging') 返回true。

（3）全局和配置

在其他情况下，你可能希望暴露一个配置的值或者全局的值。 在这种情况下，可以在注册任务时设置其参数作为一个全局对象的值或者项目配置的值。

在下面的例子中，在命令行运行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);

});

为什么我得到一个调用栈大小超过最大值的错误?
你可能用普通的任务名创建了一个别名任务， 比如: grunt.registerTask('uglify', ['uglify:my_target']); 应该改成： grunt.registerTask('myUglify', ['uglify:my_target']);。

我怎么样才能移除我不想要的插件？
至少有两种方法解决：

第一种方法是通过npm remove [GRUNT_PLUGIN] --save-dev这个命令来移除，这将会从你的package.json文件中以及node模块包中移除。

你也可以从package.json文件中删除这个插件，然后运行npm prune。

在Windows的 Grunt 0.3中，为什么当我尝试运行grunt时我的JS编辑器会打开?

如果你在Gruntfile所在的目录中，当你输入grunt时Windows会尝试去执行那个文件。因此你需要输入grunt.cmd。

另一个选择是使用DOSKEY命令去创建一个Grunt宏，这样就可以使用grunt替代grunt.cmd了。

可以使用所示如下的DOSKEY命令:DOSKEY grunt=grunt.cmd $*

 

 

 

 

加油！