📜  Grunt-创建任务

📅  最后修改于: 2020-10-25 09:43:56             🧑  作者: Mango


 

在本章中,让我们学习创建任务。每当您运行Grunt时,都会指定一个或多个任务来运行,以通知Grunt您想要做什么。如果指定默认任务,则它将默认运行。

别名任务

每当指定任务列表时,一个新的任务就可以为一个或多个其他任务起别名。运行别名将依次运行taskList中的每个指定任务。 taskList参数应为任务数组,如下所示:

grunt.registerTask(taskName, [description, ] taskList)    

例如,当你定义一个任务列表jshint,CONCAT丑化任务,并指定TASKNAME默认,所有列出的任务时,自动将不指定任何任务执行咕噜运行。

grunt.registerTask('default', ['jshint', 'concat', 'uglify']);

您还可以指定任务参数,如下所示:

grunt.registerTask('dist', ['concat:dist', 'uglify:dist']);    

在上述任务中,别名dist同时运行concatuglify任务。

多任务

每当您运行多个任务时,Grunt都会在Grunt配置中搜索同名的属性。这些任务可以具有多种配置,这些配置将使用任意命名的target进行定义。

当您同时指定任务和目标时,将仅处理指定的目标配置。

grunt concat:foo

上面的命令将仅运行目标foo

如果仅指定任务,则将处理所有目标。

grunt concat

上面的命令将遍历concat任务的所有目标。

使用grunt.task.renameTask重命名任务时,Grunt在配置对象中搜索具有任务名称的属性。

grunt.initConfig({
   log: {
      foo: [1, 2, 3],
      bar: 'Welcome to tutorialspoint',
      sap: true
   }
});

grunt.registerMultiTask('log', 'Log stuff.', function() {
   grunt.log.writeln(this.target + ': ' + this.data);
});

在上面的示例中,如果通过grunt log:foo运行Grunt,则多任务将记录foo:1,2,3,否则它将记录bar:欢迎通过grunt log:bar运行欢迎来到tutorialspoint 。它将记录foo:1、2、3,然后是bar:欢迎来到tutorialspoint,然后是sap:当Grunt作为grunt log运行时为true

基本任务

每当您运行基本任务时,Grunt都不会搜索配置或环境。相反,它运行指定的任务函数,并传递在中指定的所有以冒号分隔的参数作为函数参数。

grunt.registerTask(taskName, [description, ] taskFunction)    

在以下示例中,该任务记录了foo,如果通过grunt foo:testing:123命令执行了Grunt,则测试123 。只要任务在运行时没有参数如grunt foo ,任务就会记录foo,没有args

grunt.registerTask('foo', 'A simple task to logs stuff.', function(arg1, arg2) {
   if (arguments.length === 0) {
      grunt.log.writeln(this.name + ", no args");
   } else {
      grunt.log.writeln(this.name + ", " + arg1 + " " + arg2);
   }
});

自定义任务

如果您不想遵循多任务结构,则可以定义自定义任务,如下所示:

grunt.registerTask('default', 'My "default" task description.', function() {
  grunt.log.writeln('Currently running the "default" task.');
});  

可以在另一个任务中运行一个任务,如下所示:

grunt.registerTask('foo', 'My "foo" task.', function() {
   // Enqueue bar and baz tasks, to run after foo completes, in-order.
   grunt.task.run('bar', 'baz');
   // Or:
   grunt.task.run(['bar', 'baz']);
});  

您还可以创建异步任务,如下所示:

grunt.registerTask('asyncfoo', 'My "asyncfoo" task.', function() {
   // Force task into async mode and grab a handle to the done() function.
   var done = this.async();
   // Run some sync stuff.
   grunt.log.writeln('Processing your task..');
   // Run some async stuff.
   setTimeout(function() {
      grunt.log.writeln('Finished!');
      done();
   }, 1000);
});

您可以创建可以访问其名称和参数的任务,如下所示:

grunt.registerTask('foo', 'My task "foo" .', function(a, b) {
   grunt.log.writeln(this.name, a, b);
});

// Usage:
// grunt foo
//   logs: "foo", undefined, undefined
// grunt foo:bar
//   logs: "foo", "bar", undefined
// grunt foo:bar:baz
//   logs: "foo", "bar", "baz"

您可以通过以下方式创建任务:每当记录任何错误时,任务都会失败,如下所示:

grunt.registerTask('foo', 'My task "foo" .', function() {
   if (failureOfSomeKind) {
      grunt.log.error('This is an error message.');
   }

   // If this task had errors then fail by returning false
   if (ifErrors) { return false; }

   grunt.log.writeln('This is success message');
});  

每当任务失败时,除非指定了–force ,否则随后的所有任务都会终止。

grunt.registerTask('foo', 'My task "foo" .', function() {
   // Fail synchronously.
   return false;
});

grunt.registerTask('bar', 'My task "bar" .', function() {
   var done = this.async();
   setTimeout(function() {
      // Fail asynchronously.
      done(false);
   }, 1000);
});  

任务可以依赖于其他任务来成功执行。请记住, grunt.task.requires实际上不会执行其他任务,而是只会检查它是否已执行且未失败。

grunt.registerTask('foo', 'My task "foo" .', function() {
   return false;
});

grunt.registerTask('bar', 'My task "bar" .', function() {
   // Fail task if foo task failed or never ran.
   grunt.task.requires('foo');
   // This code executes if the foo task executed successfully.
   grunt.log.writeln('Hello, World.. Welcome to Tutorialspoint!..');
});

// Usage:
// grunt foo bar doesn't log, because foo failed to execute.
// **Note: This is an example of space-separated sequential commands,
// (similar to executing two lines of code: `grunt foo` then `grunt bar`)
// grunt bar doesn't log, because foo never ran.  

找不到所需的配置属性时,任务甚至可能失败。

grunt.registerTask('foo', 'My task "foo" .', function() {
   // Fail task if meta.name config properties is missing
   // Format 1: String 
   grunt.config.requires('meta.name');
   // or Format 2: Array
   grunt.config.requires(['meta', 'name']);
   // Log... conditionally.
   grunt.log.writeln('This only log if meta.name is defined in the config.');
});  

任务可以如下所示访问配置属性-

grunt.registerTask('foo', 'My task "foo" .', function() {
   // Log the value of the property. Returns null if the property is undefined.
   grunt.log.writeln('The meta.name property is: ' + grunt.config('meta.name'));
   // Also logs the value of the property. Returns null if the property is undefined.
   grunt.log.writeln('The meta.name property is: ' + grunt.config(['meta', 'name']));
});