创建插件 Creating Plugins

目录

• 1. 创建插件
• 2. 注意
• 2.1 命名你的任务
• 2.2 调试
• 2.3 存储任务文件
• 2.4 避免改变当前工作目录：process.cwd()

---

29 March 2013

原文：https://github.com/gruntjs/grunt/wiki/Configuring-tasks

1. 创建插件 ⬆

1. 运行 `npm install -g grunt-init` 安装 [grunt-init](https://github.com/gruntjs/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！

2. 注意 ⬆

2.1 命名你的任务 ⬆

命名空间“grunt-contrib”是保留给 Grunt 团队维护的任务，请适当的命名你的任务，避免该命名方案。

2.2 调试 ⬆

Grunt 默认隐藏堆栈跟踪信息，为了更容易调试任务，可以启用选项 --stack。如果你希望 Grunt 在发生错误时总是打印堆栈跟踪信息，在你的 shell 中创建一个别名。例如，在 bash 中你可以运行 alias grunt='grunt --stack'。

2.3 存储任务文件 ⬆

只在项目根目录的路径 .grunt/[npm-module-name]/ 存储数据文件，并且在适当的时候清理掉。这并不是一个临时文件解决方案，在这种情况下，使用利用了操作系统级别的临时文件的 common npm 模块（例如 temporary、tmp）。

2.4 避免改变当前工作目录：process.cwd() ⬆

默认情况下，当前工作目录被设置为包含了 Gruntfile 的目录。用户可以在 Gruntfile 中使用 grunt.file.setBase() 改变当前工作目录，但是插件应当小心不要改变它。

path.resolve('foo') 可以用于获取文件路径 'foo' 相对于 Gruntfile 的绝对路径。