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

Grunt的task配置都是在 Gruntfile 中的grunt.initConfig方法中指定的。此配置主要包括以任务名称命名的属性,和其他任意数据。一旦这些代表任意数据的属性与任务所需要的属性相冲突,就将被忽略。

举个例子:

grunt.initConfig({   concat: { // 这里是concat任务的配置信息。 },   uglify: { // 这里是uglify任务的配置信息 },   // 任意数据。   my_property: ‘whatever‘,   my_src_files: [‘foo/*.js‘, ‘bar/*.js‘]});

当运行一个任务时,Grunt会自动查找配置对象中的同名属性。多任务(multi-task)可以通过任意命名的“目标(target)”来定义多个配置。在下面的例子中,concat任务有名为foo和bar两个目标,而uglify任务仅仅只有一个名为bar目标。

grunt.initConfig({
  concat: {
    foo: {
      // concat task "foo" target options and files go here.
    },
    bar: {
      // concat task "bar" target options and files go here.
    },
  },
  uglify: {
    bar: {
      // uglify task "bar" target options and files go here.
    },
  },
});

如果同时指定任务(task)和目标(target),例如grunt concat:foo或者grunt concat:bar,将只会处理指定目标(target)的配置,而运行grunt concat将遍历所有目标(target)并依次处理。注意,如果一个任务使用grunt.task.renameTask重命名过,Grunt将在配置对象中查找以新的任务名命名的属性。

在一个任务配置中,options属性可以用来指定覆盖内置属性的默认值。此外,每一个目标(target)中还可以拥有一个专门针对此目标(target)的options属性。目标(target)级的options将会覆盖任务级的options。options对象是可选的,如果不需要,可以忽略。

举个例子:

grunt.initConfig({
  concat: {
      options: {
          // 这里是任务级的Options,覆盖默认值
      },
      foo: {
          options: {
            // "foo" target options may go here, overriding task-level options.
          }
      },
      bar: {
          // No options specified; this target will use task-level options.
      }
  }
});

由于大多的任务都是执行文件操作,Grunt有一个强大的抽象层用于声明任务应该操作哪些文件。

这里有好几种定义src-dest(源文件-目标文件)文件映射的方式,均提供了不同程度的描述和控制的操作方式。任何一种多任务(multi-task)都能理解下面的格式,所以你只需要选择满足你需求的格式就行。

简洁格式

这种形式允许每个目标对应一个src-dest文件映射。通常情况下它用于只读任务,比如grunt-contrib-jshint,它就只需要一个单一的src属性,而不需要关联的dest选项。这种格式还支给每个src-dest文件映射指定额外的属性,举个例子:

grunt.initConfig({
  jshint: {
    foo: {
      src: [‘src/aa.js‘, ‘src/aaa.js‘]
    },
  },
  concat: {
    bar: {
      src: [‘src/bb.js‘, ‘src/bbb.js‘],
      dest: ‘dest/b.js‘,    ......
    },
  },
});

文件对象格式

这种形式支持每个目标对应多个src-dest形式的文件映射,属性名就是目标文件,源文件就是它的值(源文件列表则使用数组格式声明)。可以使用这种方式指定多个src-dest文件映射, 但是不能够给每个映射指定附加的属性。举个例子:

grunt.initConfig({
  concat: {
    foo: {
      files: {
        ‘dest/a.js‘: [‘src/aa.js‘, ‘src/aaa.js‘],
        ‘dest/a1.js‘: [‘src/aa1.js‘, ‘src/aaa1.js‘],
      },
    },
    bar: {
      files: {
        ‘dest/b.js‘: [‘src/bb.js‘, ‘src/bbb.js‘],
        ‘dest/b1.js‘: [‘src/bb1.js‘, ‘src/bbb1.js‘],
      },
    },
  },
});

文件数组格式

这种形式支持每个目标对应多个src-dest文件映射,同时也允许每个映射拥有额外属性,举个例子:

grunt.initConfig({
  concat: {
    foo: {
      files: [
        {src: [‘src/aa.js‘, ‘src/aaa.js‘], dest: ‘dest/a.js‘},
        {src: [‘src/aa1.js‘, ‘src/aaa1.js‘], dest: ‘dest/a1.js‘},
      ],
    },
    bar: {
      files: [
        {src: [‘src/bb.js‘, ‘src/bbb.js‘], dest: ‘dest/b/‘, nonull: true},
        {src: [‘src/bb1.js‘, ‘src/bbb1.js‘], dest: ‘dest/b1/‘, filter: ‘isFile‘},
      ],
    },
  },
});

较老的格式

此种格式已经不赞成使用,请尽量不要使用,所以不讲解了。

以上所有的文件格式都支持src和dest属性,此外"Compact"[简洁格式]和"Files Array"[文件数组格式]还支持以下一些额外的属性:

(1)filter:它通过接受任意一个有效的fs.Stats方法名或者一个函数来匹配src文件路径并根据匹配结果返回true或者false。
(2)nonull:如果被设置为 true,未匹配的模式也将执行。结合Grunt的--verbore标志, 这个选项可以帮助用来调试文件路径的问题。
(3)dot:它允许模式匹配句点开头的文件名,即使模式并不明确文件名开头部分是否有句点。
(4)matchBase:如果设置这个属性,缺少斜线的模式(意味着模式中不能使用斜线进行文件路径的匹配)将不会匹配包含在斜线中的文件名。 例如,a?b将匹配/xyz/123/acb但不匹配/xyz/acb/123。
(5)expand:处理动态的src-dest文件映射,更多的信息请查看动态构建文件对象,这里先不用了解,下面有详细讲解。
(6)其他的属性将作为匹配项传递给底层的库。 请查看node-glob 和minimatch 文档以获取更多信息,这里先不用了解,下面有详细讲解。

自定义过滤函数

filter属性可以给你的目标文件提供一个更高级的详细帮助信息。只需要使用一个有效的fs.Stats 方法名。下面的配置仅仅清理一个与模式匹配的真实的文件:

grunt.initConfig({
  clean: {
    foo: {
      src: [‘tmp/**/*‘],
      filter: ‘isFile‘,
    },
  },
});

或者创建你自己的filter函数,根据文件是否匹配来返回true或者false。下面的例子将仅仅清理一个空目录:

grunt.initConfig({
  clean: {
    foo: {
      src: [‘tmp/**/*‘],
      filter: function(filepath) {
        return (grunt.file.isDir(filepath) && require(‘fs‘).readdirSync(filepath).length === 0);
      },
    },
  },
});

通配符模式

通常分别指定所有源文件路径是不切实际的,因此Grunt通过内置支持node-glob 和 minimatch 库来匹配文件名(又叫作globbing)。

你只需要知道如何在文件路径匹配过程中使用它们即可:

*:匹配任意数量的字符,但不匹配 /
?:匹配单个字符,但不匹配 /
**:匹配任意数量的字符,包括 /,只要它是路径中唯一的一部分
{}:允许使用一个逗号分割的“或”表达式列表
!:在模式的开头用于排除一个匹配模式所匹配的任何文件
每个人都需要知道的是:foo/*.js将匹配位于foo/目录下的所有的.js结尾的文件;而foo/**/*js将匹配foo/目录以及其子目录中所有以.js结尾的文件。

此外, 为了简化原本复杂的通配符模式,Grunt允许指定一个数组形式的文件路径或者一个通配符模式。所有模式按顺序处理,模式处理的过程中,带有!前缀的模式所匹配的文件将不包含在结果集中。 而且其结果集中的每一项也是唯一的。

例如:

// 指定单个文件:
{src: ‘foo/this.js‘, dest: ...}
// 指定一个文件数组:
{src: [‘foo/this.js‘, ‘foo/that.js‘, ‘foo/the-other.js‘], dest: ...}
// 使用一个匹配模式:
{src: ‘foo/th*.js‘, dest: ...}

// 一个独立的node-glob模式:
{src: ‘foo/{a,b}*.js‘, dest: ...}
// 也可以这样编写:
{src: [‘foo/a*.js‘, ‘foo/b*.js‘], dest: ...}

// foo目录中所有的.js文件,按字母顺序排序:
{src: [‘foo/*.js‘], dest: ...}
// 首先是bar.js,接着是剩下的.js文件,并按字母顺序排序:
{src: [‘foo/bar.js‘, ‘foo/*.js‘], dest: ...}

// 除bar.js之外的所有的.js文件,按字母顺序排序:
{src: [‘foo/*.js‘, ‘!foo/bar.js‘], dest: ...}
// 按字母顺序排序的所有.js文件,但是bar.js在最后。
{src: [‘foo/*.js‘, ‘!foo/bar.js‘, ‘foo/bar.js‘], dest: ...}

// 模板也可以用于文件路径或者匹配模式中:
{src: [‘src/<%= basename %>.js‘], dest: ‘build/<%= basename %>.min.js‘}
// 它们也可以引用在配置中定义的其他文件列表:
{src: [‘foo/*.js‘, ‘<%= jshint.all.src %>‘], dest: ...}

动态构建文件对象

当你希望处理大量的单个文件时,这里有一些附加的属性可以用来动态的构建一个文件列表。这些属性都可以用于简洁格式和文件数组格式的文件映射格式。

expand 设置为true用于启用下面的选项:

(1)cwd:所有src指定的匹配都将相对于此处指定的路径(但不包括此路径) 。
(2)src:相对于cwd路径的匹配模式。
(3)dest:目标文件路径前缀。
(4)ext:对于生成的dest路径中所有实际存在文件,均使用这个属性值替换扩展名。
(5)flatten:从生成的dest路径中移除所有的路径部分。
(6)rename:对每个匹配的src文件调用这个函数(在重命名后缀和移除路径之后)。dest和匹配的src路径将被作为参数传入,此函数应该返回一个新的dest值。 如果相同的dest返回不止一次,那么,每个返回此值的src来源都将被添加到一个数组中作为源列表。

举个例子:

grunt.initConfig({
  uglify: {
    static_mappings: {
      // Because these src-dest file mappings are manually specified, every
      // time a new file is added or removed, the Gruntfile has to be updated.
      files: [
        {src: ‘lib/a.js‘, dest: ‘build/a.min.js‘},
        {src: ‘lib/b.js‘, dest: ‘build/b.min.js‘},
        {src: ‘lib/subdir/c.js‘, dest: ‘build/subdir/c.min.js‘},
        {src: ‘lib/subdir/d.js‘, dest: ‘build/subdir/d.min.js‘},
      ],
    },
    dynamic_mappings: {
      // Grunt will search for "**/*.js" under "lib/" when the "uglify" task
      // runs and build the appropriate src-dest file mappings then, so you
      // don‘t need to update the Gruntfile when files are added or removed.
      files: [
        {
          expand: true,     // Enable dynamic expansion.
          cwd: ‘lib/‘,      // Src matches are relative to this path.
          src: [‘**/*.js‘], // Actual pattern(s) to match.
          dest: ‘build/‘,   // Destination path prefix.
          ext: ‘.min.js‘,   // Dest filepaths will have this extension.
        },
      ],
    },
  },
});

在上面的例子中,uglify 任务中的static_mappings和dynamic_mappings两个目标具有相同的src-dest文件映射列表, 这是因为任务运行时Grunt会自动展开dynamic_mappings文件对象为4个单独的静态src-dest文件映射--假设这4个文件能够找到。可以指定任意静态src-dest和动态的src-dest文件映射相互结合。

模板

使用<% %>分隔符指定的模板,会在任务从它们的配置中读取相应的数据时,将自动扩展扫描。模板会被递归的展开,直到配置中不再存在遗留的模板相关的信息(与模板匹配的)。

此外,在模板中使用grunt以及它的方法都是有效的,例如: <%= grunt.template.today(‘yyyy-mm-dd‘) %>

  • <%= prop.subprop %> 将会自动展开配置信息中的prop.subprop的值,不管是什么类型。像这样的模板不仅可以用来引用字符串值,还可以引用数组或者其他对象类型的值。
  • <% %> 执行任意内联的JavaScript代码。对于控制流或者循环来说是非常有用的。

举个例子:

grunt.initConfig({
  concat: {
    sample: {
      options: {
        banner: ‘/* <%= baz %> */\n‘,   // ‘/* abcde */\n‘
      },
      src: [‘<%= qux %>‘, ‘baz/*.js‘],  // [[‘foo/*.js‘, ‘bar/*.js‘], ‘baz/*.js‘]
      dest: ‘build/<%= baz %>.js‘,      // ‘build/abcde.js‘
    },
  },
  //用于任务配置模板的任意属性
  foo: ‘c‘,
  bar: ‘b<%= foo %>d‘, // ‘bcd‘
  baz: ‘a<%= bar %>e‘, // ‘abcde‘
  qux: [‘foo/*.js‘, ‘bar/*.js‘],
});

上面以concat任务配置为例,运行grunt concat:sample时,将通过banner中的/* abcde */,连同foo/*.js+bar/*.js+baz/*.js匹配的所有文件,来生成一个名为build/abcde.js的文件。

导入外部数据

Grunt有grunt.file.readJSON和grunt.file.readYAML两个方法分别用于引入JSON和YAML数据。

举个例子:

grunt.initConfig({
  pkg: grunt.file.readJSON(‘package.json‘),
  uglify: {
    options: {
      banner: ‘/*! <%= pkg.name %> <%= grunt.template.today("yyyy-mm-dd") %> */\n‘
    },
    dist: {
      src: ‘src/<%= pkg.name %>.js‘,
      dest: ‘dist/<%= pkg.name %>.min.js‘
    }
  }
});

在上面的Gruntfile中,项目的元数据是从package.json文件中导入到Grunt配置中的,并且grunt-contrib-uglify 插件中的 uglify 任务被配置用于压缩一个源文件以及使用该元数据动态的生成一个banner注释。

加油!

时间: 2024-10-08 02:27:01

grunt入门讲解2:如何使用 Gruntfile 配置任务的相关文章

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入门讲解6:grunt使用步骤和总结

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

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入门讲解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)为你的插

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

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

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

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

grunt 入门学习

前端工作流,Grunt上手指南 Posted@2013-04-20 7:15 a.m. CategoriesGrunt ,  javascript 我想先花点时间回忆一下作为一个前端需要做的工作(Loading...) JS合并 JS压缩 CSS压缩 CSS Sprite 图片优化 测试 静态资源缓存(版本更新) ... 对应的,一个全副武装的前端可能会是这样的: JSHint CSSLint Jade CoffeeScript RequireJS/SeaJS Compass/Stylus/Le

Grunt入门教程之二 —— concat插件

Grunt入门教程之二 Concat插件 concat是grunt中用来做文件连接的常用插件,比如说你写了一个类库,有三大模块,如: a.js b.js c.js 当你的项目准备发布的时候,你可能需要将这三个模块合并成一个大的模块all.js,这样做可以减少HTTP请求,增快页面的响应速度. 如果我们每次发布的时候又要连接这三个模块,并测试all.js,确保大模块无BUG之后再发布,就显得很蛋疼了.一种好的方式是,每当你修改了其中一个小模块,他都会自动连接成all.js,并且你的项目在开发的时候

AndEngine入门讲解

摘要:AndEngine是一款基于OpenGL ES技术的2D游戏引擎,可以运行在Android1.6及以上版本的系统中.拥有更多的游戏组件与扩展功能,在默认情况下已经可以支持中文. 虽然AndEngine作为游戏引擎在功能上较libGDX更为丰富和人性化,但相比libGDX的绘图渲染机能却逊色不少.libGDX有较为完善的OpenGLES环境适应性,而AndEngine在这方面的投入明显不足.所以你是否选择AndEngine,需要从实际出发,多做几次真机测试才好下决定,下面小编将逐步讲解And