Loader API

loader 用于对模块的源代码进行转换。它们是一些将资源文件的源码作为参数，并返回新的源码的（运行在 Node.js 中的）函数。

如何写一个 Loader

所谓 loader 只是导出为一个函数的 JavaScript 模块。loader runner 会调用这个函数，然后把上一个 loader 产生的结果或者资源文件(resource file)传入进去。函数的 this 上下文将由 webpack 填充，并且 loader runner 带有一些有用方法，可以使 loader 改变为异步调用方式，或者获取 query 参数。

第一个 loader 的传入参数只有一个：资源文件(resource file)的内容。compiler 需要得到最后一个 loader 产生的处理结果。这个处理结果应该是 String 或者 Buffer（被转换为一个 string），代表了模块的 JavaScript 源码。另外还可以传递一个可选的 SourceMap 结果（格式为 JSON 对象）。

如果是单个处理结果，可以在同步模式中直接返回。如果有多个处理结果，则需要调用 this.callback()。在异步模式中，必须调用 this.async()，来指示 loader runner 等待异步结果，它会返回 this.callback() 回调函数，随后 Loader 必须返回 undefined 并且调用该回调函数。

示例

同步 Loader

sync-loader.js

module.exports = function(content) {
    return someSyncOperation(content);
};

sync-loader-with-multiple-results.js

module.exports = function(content) {
    this.callback(null, someSyncOperation(content), sourceMaps, ast);
    return; // 当调用callback()时总是返回undefined
};

异步 Loader

async-loader.js

module.exports = function(content) {
    var callback = this.async();
    someAsyncOperation(content, function(err, result) {
        if(err) return callback(err);
        callback(null, result);
    });
};

async-loader-with-multiple-results.js

module.exports = function(content) {
    var callback = this.async();
    someAsyncOperation(content, function(err, result, sourceMaps, ast) {
        if(err) return callback(err);
        callback(null, result, sourceMaps, ast);
    });
};

loader 最初被设计为可以在同步 loader pipeline（如 Node.js ，使用 enhanced-require），与异步 pipeline（如 webpack ）中运行。然而在 Node.js 这样的单线程环境下进行耗时长的同步计算不是个好主意，我们建议尽可能地使您的 loader 异步化。但如果计算量很小，同步 loader 也是可以的。

"Raw" Loader

默认情况下，资源文件会被转化为 UTF-8 字符串，然后传给 loader。通过设置 raw，loader 可以接收原始的 Buffer。每一个 loader 都可以用 String 或者 Buffer 的形式传递它的处理结果。Complier 将会把它们在 loader 之间相互转换。

raw-loader.js

module.exports = function(content) {
    assert(content instanceof Buffer);
    return someSyncOperation(content);
    // 返回值也可以是一个 `Buffer`
    // 即使不是 raw loader 也没问题
};
module.exports.raw = true;

Pitching Loader

loader 总是从右到左地被调用，但是在一些情况下，loader 不需要关心之前处理的结果或者资源(resource)，而是只关心元数据(metadata)。在 loader 被调用前（从右到左），loader 中的 pitch 方法会从左到右依次被调用。

如果中间某个 Loader 的 pitch 方法返回了一个值，那么剩下的 Loader 都会被跳过，转而从当前 Loader 开始向左调用 Loader。data可以在 pitch 和普通的 Loader 调用间传递。

module.exports = function(content) {
    return someSyncOperation(content, this.data.value);
};
module.exports.pitch = function(remainingRequest, precedingRequest, data) {
    if(someCondition()) {
        // 直接返回
        return "module.exports = require(" + JSON.stringify("-!" + remainingRequest) + ");";
    }
    data.value = 42;
};

The loader context

Loader context 表示在 Loader 内使用 this 可以访问的一些方法或属性

假设我们在 /abc/file.js 中这样请求加载别的模块：

require("./loader1?xyz!loader2!./resource?rrr");

this.version

Loader API 的版本号。目前是 2。这对于向后兼容性有一些用处。通过这个版本号，你可以为不同版本间的破坏性变更编写不同的逻辑，或做降级处理。

this.context

模块所在的目录。某些场景下这可能会有用处。

在我们的例子中：这个属性为 /abc，因为 resource.js 在这个目录中

this.request

被解析出来的请求字符串。

在我们的例子中："/abc/loader1.js?xyz!/abc/node_modules/loader2/index.js!/abc/resource.js?rrr"

this.query

  1. 如果这个 loader 配置了 options 对象的话，this.query 就指向这个 option 对象。
  2. 如果 loader 中没有 options，而是以 query 字符串作为参数调用时，this.query 就是一个以 ? 开头的字符串。

options 已取代 query，所以此属性废弃。使用loader-utils中的 getOptions 方法来提取给定 loader 的 option。

this.callback

一个可以同步或者异步调用的可以返回多个结果的函数。预期的参数是：

this.callback(
    err: Error | null,
    content: string | Buffer,
    sourceMap?: SourceMap,
    abstractSyntaxTree?: AST
);
  1. 第一个参数必须是 Error 或者 null
  2. 第二个参数是一个 string 或者 Buffer。
  3. 可选的：第三个参数必须是一个可以被这个模块解析的 source map。
  4. 可选的：AST 可以是给定语言的抽象语法树，比如 ESTree。这个值会被 webpack 自身忽略掉，但是如果你想在多个 loader 之间共用 AST 的时候对于加速构建非常有用。

如果这个函数被调用的话，你应该返回 undefined 从而避免含糊的 loader 结果。

this.async

告诉 loader-runner 这个loader将会异步地回调。返回this.callback。

this.data

在 pitch 阶段和正常阶段之间共享的数据对象。

this.cacheable

设置是否可缓存标志的函数：

cacheable(flag = true: boolean)

默认情况下，loader 的处理结果会被标记为可缓存。调用这个方法然后传入 false，可以关闭 loader 的缓存。

一个可缓存的 Loader 在输入和相关依赖没有变化时，必须返回相同的结果。这意味着 Loader 除了 this.addDependency 里指定的以外，不应该有其它任何外部依赖。

this.loaders

所有 Loader 组成的数组。它在 pitch 阶段的时候是可以写入的。

loaders = [{request: string, path: string, query: string, module: function}]

在我们的示例中：

[
  {
    request: "/abc/loader1.js?xyz",
    path: "/abc/loader1.js",
    query: "?xyz",
    module: [Function]
  },
  {
    request: "/abc/node_modules/loader2/index.js",
    path: "/abc/node_modules/loader2/index.js",
    query: "",
    module: [Function]
  }
]

this.loaderIndex

当前 Loader 在 Loader 数组中的索引。

在我们的示例中：loader1：0，loader2：1

this.resource

请求的资源部分，包括 query 参数。

在我们的示例中："/abc/resource.js?rrr"

this.resourcePath

资源文件的路径。

在我们的示例中："/abc/resource.js"

this.resourceQuery

资源的 query 参数。

在我们的示例中："?rrr"

this.target

编译的目标。从配置选项中传递过来的。

示例："web", "node"

this.webpack

如果是 Webpack 编译的，这个布尔值会被设置为真。

Loader 最初被设计为可以同时当 Babel transform 用。如果你编写了一个 Loader 可以同时兼容二者，那么可以使用这个属性了解是否存在可用的 loaderContext 和 Webpack 的特性。

this.sourceMap

应该生成一个source map。因为生成 source map 可能会非常耗时，你应该确认 source map 确实被请求了。

this.emitWarning

emitWarning(message: string)

发出一个警告。

this.emitError

emitError(message: string)

发出一个错误。

this.loadModule

loadModule(request: string, callback: function(err, source, sourceMap, module))

解析给定的 request 到一个模块，应用所有配置的 loader ，并且利用生成的 source 、sourceMap 和 模块实例（通常是 NormalModule 的一个实例），来进行回调。如果你需要知道其他模块的源代码来生成结果的话，你可以使用这个函数。

this.resolve

resolve(context: string, request: string, callback: function(err, result: string))

像 require 表达式一样解析一个 request 。

this.addDependency

addDependency(file: string)
dependency(file: string) // 简写

加入一个文件作为产生 Loader 结果的依赖，使它们的任何变化可以被监听到。例如，html-loader 就使用了这个技巧。当它发现 src 和 src-set 属性时，就会把这些属性上的 url 加入到被解析的 html 文件的依赖中。

this.addContextDependency

addContextDependency(directory: string)

把文件夹作为 Loader 的依赖加入。

this.clearDependencies

clearDependencies()

移除 Loader 所有的依赖。甚至自己和其它 Loader 的初始依赖。考虑使用 pitch。

this.emitFile

emitFile(name: string, content: Buffer|string, sourceMap: {...})

产生一个文件。这是 webpack 独有的（原文：This is webpack-specific）。

this.fs

用于访问 compilation 的 inputFileSystem 属性。

Deprecated context properties

强烈建议不要使用这些属性，因为我们打算移除它们。它们仍然列在此处用于文档目的。

this.exec

exec(code: string, filename: string)

以模块的方式执行一些代码片段。

this.resolveSync

resolveSync(context: string, request: string) -> string

像 require 表达式一样解析一个 request 。（同步）

this.value

向下一个 Loader 传值。如果你知道了作为模块执行后的结果，请在这里赋值（以单元素数组的形式）。

this.inputValue

从上一个 Loader 那里传递过来的值。如果你会以模块的方式处理输入参数，建议预先读入这个变量。（为了性能因素）

this.options

options 的值将会传递给 Complier

this.debug

一个布尔值，当处于 debug 模式时为真。

this.minimize

决定处理结果是否应该被压缩。

this._compilation

一种 hack 写法。用于访问 Webpack 的 Compilation 对象。

this._compiler

一种 hack 写法。用于访问 Webpack 的 Compiler 对象。

this._module

一种 hack 写法。用于访问当前加载的 Module 对象。

原文：https://webpack.js.org/api/loaders/

results matching ""

    No results matching ""