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 [email protected] --save-dev 命令,其中VERSION代表你所需要的版本。这样就安装完成了,然后将其添加到package.json文件中的devDependencies小节中。package.json文件中出现的将是波浪线标记的版本范围 。

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

所以我们必须指定版本,跟安装指定版本的 Grunt 一样,执行npm install [email protected] --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 $*

加油!

时间: 2024-10-19 23:14:45

grunt入门讲解5:创建插件,安装Grunt以及常见问题的相关文章

grunt入门讲解4:如何创建task(任务)

每当运行Grunt时, 你可以为其指定一个或多个任务, 这些任务用于告诉Grunt你想要它做什么事情. 如果你没有指定一个任务,并且你已经定义一个名为 "default" 的任务,那么该任务将会默认被执行. 任务别名 如果指定了一个任务列表taskList,新任务名taskName将是这一个或多个指定任务的别名.当运行此 "任务别名" 时,在taskList 中指定的每个任务都会按照其出现的顺序依次执行.taskList参数必须是一个任务数组.grunt.regis

grunt入门讲解1:grunt的基本概念和使用

Grunt和 Grunt 插件是通过 npm 安装并管理的,npm是 Node.js 的包管理器. Grunt 0.4.x 必须配合Node.js >= 0.8.0版本使用.老版本的 Node.js 被认为是不稳定的开发版.之前,在用grunt来合并文件时,老是报错,原因是node.js的版本太低了. 在安装grunt之前,你需要先将Grunt命令行(CLI)安装到全局环境中. npm install -g grunt-cli 上述命令执行完后,grunt 命令就被加入到你的系统路径中了,以后就

grunt入门讲解3:实例讲解使用 Gruntfile 配置任务

这个Gruntfile 实例使用到了5个 Grunt 插件: grunt-contrib-uglify grunt-contrib-qunit grunt-contrib-concat grunt-contrib-jshint grunt-contrib-watch 上面的uglify,concat,watch这三个插件用的最多,第一个插件是用来压缩文件的,第二个插件是用来合并文件的,第三个插件用来监听文件内容的,如果文件内容改变了,就会触发回调方法进行相应的处理. 我们一步一步来讲解这个 Gr

grunt入门讲解2:如何使用 Gruntfile 配置任务

Grunt的task配置都是在 Gruntfile 中的grunt.initConfig方法中指定的.此配置主要包括以任务名称命名的属性,和其他任意数据.一旦这些代表任意数据的属性与任务所需要的属性相冲突,就将被忽略. 举个例子: grunt.initConfig({ concat: { // 这里是concat任务的配置信息. }, uglify: { // 这里是uglify任务的配置信息 }, // 任意数据. my_property: 'whatever', my_src_files:

grunt入门讲解6:grunt使用步骤和总结

Grunt是啥? 很火的前端自动化小工具,基于任务的命令行构建工具. Grunt能帮我们干啥? 假设有这样一个场景: 编码完成后,你需要做以下工作 HTML去掉注析.换行符 - HtmlMin CSS文件压缩合并 – CssMinify JS代码风格检查 – JsHint JS代码压缩 – Uglyfy image压缩 - imagemin 重复而枯燥的工作太多了,我们需要一个自动化的工作流程,让我们更专注于coding,而不是coding外的繁琐工作.于是Grunt应运而生.可以想像,如果在n

grunt入门讲解7:项目脚手架grunt-init

grunt-init是一个用于自动创建项目脚手架的工具.它会基于当前工作环境和你给出的一些配置选项构建一个完整的目录结构.至于其所生成的具体文件和内容,依赖于你所选择的模版和构建过程中你对具体信息所给出的配置选项. 注意:这个独立的程序曾经是作为Grunt内置的"init"任务而存在的. 安装 为了使用grunt-init,需要将其安装到全局环境中. npm install -g grunt-init这样就会把grunt-init命令安装到你的系统路径中,从而允许你在任何目录中都可以运

groovy入门()Groovy插件安装:Maven报Plugin execution not covered by lifecycle configuration

参考链接:http://www.cnblogs.com/rightmin/p/4945797.html 1.引入groovy的jar包 2.引入groovy编译插件 3.遇到问题 Plugin execution not covered by lifecycle configuration 4.解决办法 quickfix+删除重导入工程大法!! 下面是网上介绍的解决方法,下次遇到再试试: 5.附录代码 - eclipse开发Groovy代码,与java集成,maven打包编译 5.1.设置类路径

Grunt入门教程之(三)

Grunt入门教程之三 Yuidoc插件 Yuidoc 是一个可以将代码注释生成HTML格式文档的工具,文档的生成完全基于JavaDoc风格的代码注释规则. 我们在写公共模块或者API的时候,往往会输出文档给调用者查看,这时候Yuidoc就是一个很好的助手. 下面介绍一下如何在Grunt中使用Yuidoc. 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 grunt.initConfig({ pkg: grunt.file.readJSON('package.jso

grunt 入门实践实记

在Javascript的 开发过程中,经常会遇到一些重复性的任务,比如合并文件.压缩代码.检查语法错误.将Sass代码转成CSS代码等等.通 常,我们需要使用不同的工具,来完成不同的任务,既重复劳动又非常耗时.Grunt就是为了解决这个问题而发明的工具,可以帮助我们自动管理和运行各种任务. sudo npm install grunt-cli -g //grunt-cli表示安装的是grunt的命令行界面,参数g表示全局安装. npm install //这种方法是针对已有package.jso