Grunt 深入任务内幕(2)-木庄网络博客

注意，在多任务形式中，任务目标名不会被设置为一个标记。

this.errorCount

当前任务执行期间grunt.log.error方法被调用的次数。如果在任务运行期间有错误信息输出，它可以用来让任务执行失败。

this.options

返回一个options对象。defaultsObj是一个可选参数，它的属性会被任意的任务级options对象的属性覆盖；在多任务形式中，它的属性会进一步被目标级的options对象的属性覆盖。

this.options([defaultsObj])

下面给出了一个例子，展示了在任务中可以如何使用this.options方法：

var options = this.options({
  enabled: false,
});

doSomething(options.enabled);

在配置任务指南中，有一个例子展示了如何从用户任务的角度来指定options。

多任务形式内部可用的方法/属性

this.target

在一个多任务形式中，这个属性包含了当前正被遍历的目标的名称。例如，如果一个名为"sample"的多任务带有{sample: {foo: "bar"}}这样的配置数据，当以grunt sample:foo的形式运行这个任务时，那么在这个任务函数内部，this.target属性的值就为"foo"。

this.files

在一个多任务形式中，使用Grunt支持的文件格式和选项，通配符模式或者动态映射方式指定的文件，都会被自动标准化为一个唯一的格式：即文件数组格式。

这意味着，任务不需要为了明确的处理自定义文件格式，通配符格式，源文件到目标文件映射或者过滤输出文件或者目录而包含大量模板。任务只需要根据配置任务指南中的说明指定文件，Grunt会自动处理所有任务细节。

this.files属性永远都是一个数组。你的任务应该利用数组中每个对象的src和dest属性遍历this.files数组。在你的任务关注每个目标文件的多个源文件的情况下，src`属性也永远是一个数组。

注意，有可能不存在的文件也被包含在 src 的值当中，因此，你应该在使用前检查源文件是否存在。

下面的例子展示了一个简单的"concat"任务是怎样使用this.files属性的：

this.files.forEach(function(file) {
  var contents = file.src.filter(function(filepath) {
    // Remove nonexistent files (it's up to you to filter or warn here).
    if (!grunt.file.exists(filepath)) {
      grunt.log.warn('Source file "' + filepath + '" not found.');
      return false;
    } else {
      return true;
    }
  }).map(function(filepath) {
    // Read and return the file's source.
    return grunt.file.read(filepath);
  }).join('\n');
  // Write joined contents to destination filepath.
  grunt.file.write(file.dest, contents);
  // Print a success message.
  grunt.log.writeln('File "' + file.dest + '" created.');
});

如果你还需要使用原始文件对象的属性，可以通过每个单独的文件对象的orig属性来获取并使用，但是目前都没发现有访问原始属性的用例。

this.filesSrc

在多任务形式中，在src中通过任意的文件格式指定的文件都会被归并到一个数组。如果你的任务是"只读"的并且无需关心目标文件路径，可以使用这个数组来替代this.files。

下面这个例子展示了一个简单的"lint"的任务是怎样使用this.filesSrc属性的：

// Lint specified files.
var files = this.filesSrc;
var errorCount = 0;
files.forEach(function(filepath) {
  if (!lint(grunt.file.read(filepath))) {
    errorCount++;
  }
});

// Fail task if errors were logged.
if (errorCount > 0) { return false; }

// Otherwise, print a success message.
grunt.log.ok('Files lint free: ' + files.length);

this.data

在多任务形式中，这是存储在给定目标的Grunt配置对象中的实际数据。例如，如果一个名为"sample"的多任务带有{sample: {foo: "bar"}}这样的配置数据，当以grunt sample:foo的形式运行这个任务时，那么在这个任务函数内部，this.data的值就为"bar"。

推荐使用this.options，this.files和this.filesSrc来替代this.data, 因为它们的值都是经过标准化的。

标签：Grunt

返回前面的内容