內建插件

內建插件使用 rspack_macros 來協助您避免編寫樣板程式碼，您可以使用 cargo-expand 或 rust-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(())
  }
}

這裡有一個範例。

如果您需要的 hook 尚未定義，您可以使用 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>>

內建插件#

內建插件