从零开始Grunt

 

[20141025]从0开始Grunt

首先，Grunt是什么？

Grunt是JavaScript任务运行工具。使用它可以自动化诸如文件(夹)操作、代码压缩、代码编译、单元测试、代码规范校验等等重复的任务。

如何安装Grunt？（Windows）

Step1、Grunt依赖Node扩展包，那么必须要安装Node：

1. 打开Node官网：http://nodejs.org/
2. 点击 INSTALL 按钮，会自动适配环境，下载一个安装包，双击安装即可
3. 打开cmd命令行，输入命令代码： node -v ，如果输出一个具体的版本号，如 v0.10.xx ，则表示安装成功。

Step2、安装grunt的命令行工具： 1. 打开cmd命令行，输入命令代码：npm install -g grunt-cli ,该命令表示全局安装grunt的命令行

到此，Grunt算是安装完成。

如何使用？（以一个SPA为例）

首先，创建该项目SPADemo，目录结构如下：

SPADemo
    src
        images     //图片文件夹
        styles     //样式表文件夹
        scripts    //脚本文件夹
            vendor //存放第三方组件
        index.html //默认页

第二步，书写package.json 文件，确定依赖项。放在src同级目录,内容如下：

{
  "name": "SPADemo",
  "version": "0.1.0",
  "devDependencies": {
    "grunt": "~0.4.2"
  }
}

第三步，打开SPADemo根文件夹，在路径栏输入cmd，进入当前目录的cmd模式，输入 npm i ,初始化依赖项。当更该package.json后，可重复执行该命令。将依赖项重新初始化。会生成一个node_modules文件夹。

第四步，进行Grunt配置。默认配置文件名为Gruntfile.js（.coffee也可以，但是Gruntfile不能更改，同时必须放在src同级目录）

第五步，配置Gruntfile.js/coffee

module.exports = function(grunt){
    //初始化Grunt
    grunt.initConfig({});

    // registerTask(taskName,taskDescription,taskFunc/childTaskArray)
    grunt.registerTask('default','任务入口',function(){
        grunt.log.write('任务已启动！');
    });
};

到现在，一个Grunt已经完整配置好了。进入SPADemo目录的cmd命令行，输入grunt，会显示“任务已启动！”

如何使用插件？

文件清理插件 grunt-contrib-clean

该插件用于清除目录/文件

首先在package.json中添加该依赖包。变化后配置如下：

{
  "name": "SPADemo",
  "version": "0.1.0",
  "devDependencies": {
    "grunt": "~0.4.2",
    "grunt-contrib-clean": "~0.6.0"
  }
}

然后在Gruntfile.js中增加该插件的配置，代码如下（更详细的配置请参考插件地址）：

module.exports = function(grunt){
    grunt.initConfig({
        //clean插件的配置项，名字不能变化。
        //插件地址：https://github.com/gruntjs/grunt-contrib-clean
        clean: {
            //任务具体配置，清除dist文件夹
            cleanDist: {
                force: true, //允许操作当前工作目录之外的目录
                src: 'dist/**/*' //dist下的所有文件和目录
            }
        }
    });

    grunt.loadNpmTasks('grunt-contrib-clean');// 必须，使用clean插件，必须要调用该方法，加载插件

    // registerTask(taskName,taskDescription,taskFunc/childTaskArray)
    grunt.registerTask('default','任务入口',function(){
        grunt.log.write('任务已启动！');
        grunt.task.run([
            'clean:cleanDist' //使用clean任务的cleanDist配置运行任务
        ]);
    });
};

最后cmd运行grunt命令，就可以执行对dist目录的清理了。可以手动新建dist文件夹测试。

写在最后

Grunt是一个庞大的生态系统，我们可以自由的选择数以百计的插件来帮助处理自动化任务。同时，如果发现没有合适的插件，我们还可以自己创建插件并通过npm发布，以供更多人使用和完善。