目录

Webpack 2.2 中文文档

Node.js API

webpack 提供了 Node.js API,可以在 Node.js 运行时下直接使用。

当你需要自定义构建或开发流程时,Node.js API 非常有用,因为此时所有的报告和错误处理都必须自行实现,webpack 仅仅负责编译的部分。所以 stats 配置选项不会在 webpack() 调用中生效。

安装(Installation)

开始使用 webpack 的 Node.js API 之前,首先你需要安装 webpack:

npm install webpack --save-dev

然后在 Node.js 脚本中 require webpack 模块:

const webpack = require("webpack");

// 或者如果你喜欢 ES2015:
import webpack from "webpack";

webpack()

导入的 webpack 函数需要传入一个 webpack 配置对象,当同时传入回调函数时就会执行 webpack compiler:

const webpack = require("webpack");

webpack({
  // [配置对象](/configuration/)
}, (err, [stats](#stats-object)) => {
  if (err || stats.hasErrors()) {
    // [在这里处理错误](#-error-handling-)
  }
  // 处理完成
});

>> 编译错误不在 err 对象内,而是需要使用 stats.hasErrors() 单独处理,你可以在指南的 错误处理 部分查阅到更多细节。err 对象只会包含 webpack 相关的问题,比如配置错误等。

注意 你可以传入一个配置选项数组到 webpack 函数内:

webpack([
  { /* 配置对象 */ },
  { /* 配置对象 */ },
  { /* 配置对象 */ }
], (err, [stats](#stats-object)) => {
  // ...
});

>> webpack 不会并行执行多个配置。每个配置只会在前一个处理结束后才会开始处理。如果你需要 webpack 并行执行它们,你可以使用像 parallel-webpack 这样的第三方解决方案。

Compiler 实例(Compiler Instance)

如果你不传入回调函数到 webpack 执行函数中,就会得到一个 webpack Compiler 实例。你可以通过它手动触发 webpack 执行器,或者是让它执行构建并监听变更。和 CLI API 很类似。Compiler 实例提供了以下方法:

.run(callback)
.watch(watchOptions, handler)

执行(Run)

调用 Compiler 实例的 run 方法跟上文提到的快速执行方法很相似:

const webpack = require("webpack");

const compiler = webpack({
  // [配置对象](/configuration/)
});

compiler.run((err, [stats](#stats-object)) => {
  // ...
});

监听(Watching)

调用 watch 方法会触发 webpack 执行器,但之后会监听变更(很像 CLI 命令: webpack –watch),一旦 webpack 检测到文件变更,就会重新执行编译。该方法返回一个 Watching 实例。

watch(watchOptions, callback)
const webpack = require("webpack");

const compiler = webpack({
  // [配置对象](/configuration/)
});

const watching = compiler.watch({
  
/* [watchOptions](/configuration/watch/#watchoptions) */ aggregateTimeout: 300, poll: undefined
}, (err, [stats](#stats-object)) => { // 在这里打印 watch/build 结果... console.log(stats); });

Watching 配置选项的细节可以在这里查阅

关闭 Watching(Close Watching)

watch 方法返回一个 Watching 实例,它会暴露一个 .close(callback) 方法。调用该方法将会结束监听:

watching.close(() => {
  console.log("Watching Ended.");
});

>> 不允许在当前监听器已经关闭或失效前再次监听或执行。

作废 Watching(Invalidate Watching)

手动将当前的编译阶段废弃,但不停止监听。

watching.invalidate(() => {
  console.warn("Invalidated.");
});

Stats 对象(Stats Object)

stats 对象会被作为 webpack() 回调函数的第二个参数传入,可以通过它获取到代码编译过程中的有用信息,包括:

  • 错误和警告(如有)
  • 计时
  • 模块和 chunk 信息
  • 其他信息

webpack CLI 正是基于这些信息在控制台展示友好的格式输出。

该对象暴露了以下方法:

stats.hasErrors()

可以用来检查编译期是否有错误,返回 true 或 false。

stats.hasWarnings()

可以用来检查编译期是否有警告,返回 true 或 false。

stats.toJson(options)

以 JSON 对象形式返回编译信息。options 可以是一个字符串(预设值)或是颗粒化控制的对象:

stats.toJson("minimal"); // [更多选项如: "verbose" 等](/configuration/stats).
stats.toJson({
  assets: false,
  hash: true
});

所有可用的配置选项和预设值记录在 Stats 文档

这里有 该函数输出的示例

stats.toString(options)

以格式化的字符串形式返回描述编译信息(类似 CLI 的输出)。

配置对象与 stats.toJson(options) 一致,除了额外增加的一个选项:

stats.toString({
  // ...
  // 增加控制台颜色开关
  colors: true
});

下面是 stats.toString() 用法的示例:

const webpack = require("webpack");

webpack({
  // [配置对象](/configuration/)
}, (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }

  console.log(stats.toString({
    chunks: false,  // 使构建过程更静默无输出
    colors: true    // 在控制台展示颜色
  }));
});

错误处理(Error Handling)

完备的错误处理中需要考虑以下三种类型的错误:

  • 致命的 wepback 错误(配置出错等)
  • 编译错误(缺失的模块,语法错误等)
  • 编译警告

下面是一个覆盖这些场景的示例:

const webpack = require("webpack");

webpack({
  // [配置对象](/configuration/)
}, (err, stats) => {
  if (err) {
    console.error(err.stack || err);
    if (err.details) {
      console.error(err.details);
    }
    return;
  }

  const info = stats.toJson();

  if (stats.hasErrors()) {
    console.error(info.errors);
  }

  if (stats.hasWarnings()) {
    console.warn(info.warnings)
  }

  // 记录结果...
});

编译到内存中(Compiling to Memory)

webpack 默认将输出写入到磁盘上指定的文件中。如果你希望 webpack 将它们写入到其他类型的文件系统中(比如内存、webDAV 等),你可以在 compiler 上设置 outputFileSystem 选项:

const MemoryFS = require("memory-fs");
const webpack = require("webpack");

const fs = new MemoryFS();
const compiler = webpack({ /* options*/ });

compiler.outputFileSystem = fs;
compiler.run((err, stats) => {
  // 之后读取输出:
  const content = fs.readFileSync("...");
});

>> 你指定的输出文件系统需要兼容 Node 自身的 fs 模块接口。

原文:https://webpack.js.org/api/node/

上一篇: 下一篇: