编译器钩子

概述

environment

在准备编译器环境时调用,紧随配置文件中初始化插件之后。

  • 类型: SyncHook<[]>

afterEnvironment

紧随 environment 钩子之后调用,此时编译器环境设置已完成。

  • 类型: SyncHook<[]>

entryOption

在处理完来自 Rspack 选项的 entry 配置之后调用。

  • 类型: SyncBailHook<[string, EntryNormalized]>
  • 参数
    • string: 与 context 相同
    • EntryNormalized: 规范化的 entry

afterPlugins

在设置初始内部插件集之后调用。

  • 类型: SyncHook<[Compiler]>
  • 参数
    • Compiler: 当前编译器实例

afterResolvers

在解析器设置完成之后触发。

  • 类型: SyncHook<[Compiler]>
  • 参数
    • Compiler: 当前编译器实例

initialize

当初始化编译器对象时调用。

  • 类型: SyncHook<[]>

beforeRun

在运行编译器之前添加一个钩子。

  • 类型: AsyncSeriesHook<[Compiler]>
  • 参数
    • Compiler: 当前编译器实例

run

在构建执行开始时调用。

  • 类型: AsyncSeriesHook<[Compiler]>
  • 参数
    • Compiler: 当前编译器实例

watchRun

在监视模式下,触发新的编译之后但实际开始编译之前,执行一个插件。

  • 类型: AsyncSeriesHook<[Compiler]>
  • 参数
    • Compiler: 当前编译器实例

beforeCompile

在创建编译参数之后执行一个插件。

  • 类型: AsyncSeriesHook<[]>

compile

紧随 beforeCompile 之后调用,在创建新的编译之前。

  • 类型: SyncHook<[]>

thisCompilation

在初始化编译时调用,紧随调用 compilation 钩子之前。

  • 类型: SyncHook<[Compilation]>
  • 参数
    • Compilation: 创建的 编译 对象

compilation

在创建编译之后运行一个插件。

  • 类型: SyncHook<[Compilation]>
  • 参数
    • Compilation: 创建的 编译 对象

make

在 make 阶段之前调用。

在 make 阶段,Rspack 将从入口开始构建模块图,并使用加载器处理每个模块。

  • 类型: AsyncParallelHook<[Compilation]>
  • 参数
    • Compilation: 当前 编译 对象

afterCompile

在 make 阶段之后以及 seal 阶段之前调用。

在 seal 阶段,Rspack 将从模块图创建块图,然后生成资源。

  • 类型: AsyncSeriesHook<[Compilation]>
  • 参数
    • Compilation: 当前 编译 对象

shouldEmit

在发出资源之前调用。应返回一个布尔值,指示是否发出。

  • 类型: SyncBailHook<[Compilation]>
  • 参数
    • Compilation: 当前 编译 对象

emit

在将资源发出到输出目录之前调用。

  • 类型: AsyncSeriesHook<[Compilation]>
  • 参数
    • Compilation: 当前 编译 对象

afterEmit

在将资源发出到输出目录之后调用。

  • 类型: AsyncSeriesHook<[Compilation]>
  • 参数
    • Compilation: 当前 编译 对象

done

当编译完成时调用。

  • 类型: AsyncSeriesHook<Stats>
  • 参数
    • Stats: 生成的统计信息对象

afterDone

done 钩子之后调用。

  • 类型: SyncHook<Stats>
  • 参数
    • Stats: 生成的统计信息对象

failed

如果编译失败,则调用。

  • 类型: SyncHook<[Error]>

watchClose

当监视编译停止时调用。

  • 类型: SyncHook<[]>

shutdown

当编译器关闭时调用。

  • 类型: AsyncSeriesHook<[]>