阿西河

所有教程

公众号
🌙
阿西河前端的公众号

我的收藏

    最近访问  (文章)

    教程列表

    数据库
    抓包专区
    测试专区

    grunt.task

    grunt.task

    注册、执行和加载外部任务。

    参见 task lib source 和 task util lib source 获取更多信息。

    The task API

    当一个任务正在执行时,Grunt 通过this 对象向此任务函数暴露了很多任务特定的属性和方法。参见 深入任务内幕指南,这里可以找到完整的属性和方法列表。

    很多属性和方法都可以通过 this 对象访问到。

    注意,任何标记为的 ☃ (unicode snowman) 方法也可以直接通过 grunt 对象直接访问到。参见 API首页以获取更多信息。

    创建任务

    grunt.task.registerTask

    注册 “别名任务” 或 任务函数。此方法支持以下两种类型:

    别名任务

    如果指定了一个任务列表,那么,新注册的任务将会是这一个或多个任务的别名(alias)。当此"别名任务"执行时,taskList中的所有任务都将按指定的顺序依次执行。taskList 参数必须是一个任务数组。

    grunt.task.registerTask(taskName, taskList)
    

    下面这个案例展示的是定义一个"default" 任务,当执行 Grunt 且不通过参数指定任务时, “jshint”、 “qunit”、“concat” 和 “uglify” 任务将自动执行:

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

    还可以指定任务的参数。下面的这个案例中,别名"dist"执行了 “concat” 和 “uglify” 这两个任务,并且都指定了"dist" 参数:

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

    任务函数

    如果传入descriptiontaskFunction,每当任务运行时,指定的函数(taskFunction)都会被执行。此外,当执行 grunt --help时,前面指定的描述(description)就会显示出来。特定任务的属性和方法在任务函数内部通过this对象的属性即可访问。如果任务函数返回false表示任务失败。

    注意,grunt.task.registerMultiTask方法将稍候介绍,它可以被用于定义一种特殊类型的任务,即"复合任务"。

    grunt.task.registerTask(taskName, description, taskFunction)
    

    下面这个案例中,当 Grunt 运行grunt foo:testing:123时,日志输出foo, testing 123。如果运行这个任务时不带参数,如grunt foo,日志输出foo, no args

    grunt.task.registerTask('foo', 'A sample task that 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调用。

    grunt.task.registerMultiTask

    注册一个 “复合任务(multi task)"。 复合任务是指在不指定目标(target)时,将依次执行其所包含的所有已命名的子属性(sub-properties) (也就是 目标) 。除了默认的属性和方法外,还可以通过this对象访问复合任务独有的属性。

    大多数的contrib任务,包括 jshint taskconcat task 和 uglify task 都是复合任务。

    grunt.task.registerMultiTask(taskName, description, taskFunction)
    

    给定以下配置信息,当执行grunt log:foo时,下面的复合任务将输出日志foo: 1,2,3;当执行grunt log:bar时,将输出日志bar: hello world。如果只是执行grunt log,那么,将先输出日志foo: 1,2,3,然后是bar: hello world,最后是baz: false

    grunt.initConfig({
      log: {
        foo: [1, 2, 3],
        bar: 'hello world',
        baz: false
      }
    });
    
    grunt.task.registerMultiTask('log', 'Log stuff.', function() {
      grunt.log.writeln(this.target + ': ' + this.data);
    });
    

    参见 创建任务 文档以获取更多复合任务的案例。

    此方法还可以通过 grunt.registerMultiTask 调用。

    grunt.task.requires

    Fail the task if some other task failed or never ran.

    grunt.task.requires(taskName);
    

    grunt.task.exists

    Added in 0.4.5

    Check with the name, if a task exists in the registered tasks. Return a boolean.

    grunt.task.exists(name)
    

    grunt.task.renameTask

    重命名任务。如果你希望覆盖某个任务的默认行为,并且希望保留原来的名字,这个函数将会很有用。

    注意,如果一个任务已经被重命名了, this.name 和 this.nameArgs 属性都会发生相应的变化。

    grunt.task.renameTask(oldname, newname)
    

    此方法还可以通过 grunt.renameTask 调用。

    加载外部定义的任务

    对于多数项目来说,Gruntfile 文件中可能会定义很多任务。对于大型项目或者需要在多个项目中共享任务的情况,可以从一个或多个外部目录加载任务,或者从npm安装的 Grunt 插件加载任务。

    grunt.task.loadTasks

    从指定的目录(注意:相对于 Gruntfile 所在目录)加载任务相关的文件。此方法可以从本地Grunt插件加载任务相关的文件,只需指定包含"tasks"子目录的插件目录即可。

    grunt.task.loadTasks(tasksPath)
    

    此方法还可以通过 grunt.loadTasks 调用。

    grunt.task.loadNpmTasks

    从指定的 Grunt 插件中加载任务。此插件必须通过npm安装到本地,并且是参照 Gruntfile 文件的相对路径。Grunt插件还可以通过 grunt-init grunt插件模版创建: grunt init:gruntplugin

    grunt.task.loadNpmTasks(pluginName)
    

    此方法还可以通过 grunt.loadNpmTasks 调用。

    队列任务

    Grunt 自动将命令行中指定的任务加入队列并执行,但是,一些独特的任务可以向队列中加入额外需要执行的任务。

    grunt.task.run

    将一个或多个任务放入队列中。 taskList 中的每个任务都会按照其在队列中的顺序,在当前任务执行完毕后立即执行。任务列表可以是一个任务数组或单个任务。

    grunt.task.run(taskList)
    

    grunt.task.clearQueue

    完全清空任务队列。除非将额外的任务加入队列,否则将不会执行任何任务。

    grunt.task.clearQueue()
    

    grunt.task.normalizeMultiTaskFiles

    将目标(target)的配置对象标准化为一个src-dest文件映射数组。此方法在内部由复合任务系统的this.files / grunt.task.current.files属性调用。

    grunt.task.normalizeMultiTaskFiles(data [, targetname])
    
    卖前端学习教程

    只需几十元,就能买到培训班的内部教程!开启高薪之路!

    零基础小白阿里P7的教程都有!

    同时长期收购所有培训班的前端教程

    目录
    目录