rolldown_plugin 1.2.15

Plugin interface for Rolldown bundler
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use arcstr::ArcStr;

use crate::HookNoopReturn;
use crate::PluginDriver;
use crate::types::hook_hot_update_args::HookHotUpdateArgs;
use anyhow::Context;
use rolldown_common::WatcherChangeKind;
use rolldown_error::CausedPlugin;

impl PluginDriver {
  #[tracing::instrument(
    level = "trace",
    target = "rolldown_plugin::plugin_driver::watch_hooks::total::watch_change",
    skip(self)
  )]
  pub async fn watch_change(&self, path: &str, event: WatcherChangeKind) -> HookNoopReturn {
    for (_, plugin, ctx) in self.iter_plugin_with_context_by_order(&self.order_by_watch_change_meta)
    {
      let result = plugin.call_watch_change(ctx, path, event).await;
      result.with_context(|| CausedPlugin::new(plugin.call_name()))?;
    }
    Ok(())
  }

  /// Dev-mode only (experimental). Runs the `hotUpdate` replace-chain over plugins in hook
  /// order: each plugin receives the current affected-module set for the changed file and may
  /// replace it (an empty vec suppresses the update). Returns the final set, or `None` when no
  /// plugin returned a replacement — the caller's default set stands, and the caller can tell
  /// an explicit plugin selection apart from the default flow.
  #[tracing::instrument(
    level = "trace",
    target = "rolldown_plugin::plugin_driver::watch_hooks::total::hot_update",
    skip(self, default_modules)
  )]
  pub async fn hot_update(
    &self,
    kind: WatcherChangeKind,
    file: &str,
    default_modules: Vec<ArcStr>,
  ) -> anyhow::Result<Option<Vec<ArcStr>>> {
    let mut args = HookHotUpdateArgs { kind, file: ArcStr::from(file), modules: default_modules };
    let mut replaced = false;
    for (_, plugin, ctx) in self.iter_plugin_with_context_by_order(&self.order_by_hot_update_meta) {
      let result = plugin.call_hot_update(ctx, &args).await;
      if let Some(modules) = result.with_context(|| CausedPlugin::new(plugin.call_name()))? {
        args.modules = modules;
        replaced = true;
      }
    }
    Ok(replaced.then_some(args.modules))
  }

  /// Cheap check for the HMR stage to skip the `hotUpdate` path entirely when no plugin
  /// registered the hook.
  pub fn has_hot_update_hook(&self) -> bool {
    !self.order_by_hot_update_meta.is_empty()
  }

  #[tracing::instrument(
    level = "trace",
    target = "rolldown_plugin::plugin_driver::watch_hooks::total::close_watcher",
    skip(self)
  )]
  pub async fn close_watcher(&self) -> HookNoopReturn {
    for (_, plugin, ctx) in
      self.iter_plugin_with_context_by_order(&self.order_by_close_watcher_meta)
    {
      let result = plugin.call_close_watcher(ctx).await;
      result.with_context(|| CausedPlugin::new(plugin.call_name()))?;
    }
    Ok(())
  }
}