内置插件

内置插件使用 rspack_macros 来帮助您避免编写样板代码,您可以使用 cargo-expandrust-analyzer 展开宏 来查看展开的代码,对于开发/测试这些宏,您可以从 rspack_macros_test 开始。

一个简单的例子

use rspack_hook::{plugin, plugin_hook};
use rspack_core::{Plugin, PluginContext, ApplyContext, CompilerOptions};
use rspack_core::CompilerCompilation;
use rspack_error::Result;

// define the plugin
#[plugin]
pub struct MyPlugin {
  options: MyPluginOptions
}

// define the plugin hook
#[plugin_hook(CompilerCompilation for MuPlugin)]
async fn compilation(&self, compilation: &mut Compilation) -> Result<()> {
  // do something...
}

// implement apply method for the plugin
impl Plugin for MyPlugin {
  fn apply(&self, ctx: PluginContext<&mut ApplyContext>, _options: &mut CompilerOptions) -> Result<()> {
    ctx.context.compiler_hooks.tap(compilation::new(self))
    Ok(())
  }
}

这里有一个 例子.

如果您需要的钩子尚未定义,您可以通过 rspack_hook::define_hook 定义它。以 compiler.hooks.assetEmitted 为例

// this will allow you define hook's arguments without limit
define_hook!(CompilerShouldEmit: AsyncSeriesBail(compilation: &mut Compilation) -> bool);
//           ------------------  --------------- -----------------------------  -------
//           hook name           exec kind       hook arguments                 return value (Result<Option<bool>>)

#[derive(Debug, Default)]
pub struct CompilerHooks {
  // ...
  // and add it here
  pub asset_emitted: CompilerAssetEmittedHook,
}

有 5 种执行类型

  • AsyncSeries,返回值是 Result<()>
  • AsyncSeriesBail,返回值是 Result<Option<T>>
  • AsyncParallel,返回值是 Result<()>
  • SyncSeries,返回值是 Result<()>
  • SyncSeriesBail,返回值是 Result<Option<T>>