Struct farmfe_plugin_html::FarmPluginHtml

pub struct FarmPluginHtml { /* private fields */ }

Implementations

impl FarmPluginHtml

pub fn new(_: &Config) -> Self

Trait Implementations

impl Plugin for FarmPluginHtml

fn transform( &self, param: &PluginTransformHookParam<'_>, context: &Arc<CompilationContext> ) -> Result<Option<PluginTransformHookResult>>

Inherit base html

fn name(&self) -> &str

fn resolve( &self, param: &PluginResolveHookParam, context: &Arc<CompilationContext>, hook_context: &PluginHookContext ) -> Result<Option<PluginResolveHookResult>>

fn load( &self, param: &PluginLoadHookParam<'_>, _context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<PluginLoadHookResult>>

fn parse( &self, param: &PluginParseHookParam, context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<ModuleMetaData>>

fn analyze_deps( &self, param: &mut PluginAnalyzeDepsHookParam<'_>, _context: &Arc<CompilationContext> ) -> Result<Option<()>>

fn render_resource_pot_modules( &self, resource_pot: &ResourcePot, context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<ResourcePotMetaData>>

fn generate_resources( &self, resource_pot: &mut ResourcePot, _context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<PluginGenerateResourcesHookResult>>

Generate resources based on the ResourcePot, return Vec represents the final generated files. For example, a .js file and its corresponding source map file

fn plugin_cache_loaded( &self, cache: &Vec<u8>, _context: &Arc<CompilationContext> ) -> Result<Option<()>>

fn write_plugin_cache( &self, context: &Arc<CompilationContext> ) -> Result<Option<Vec<u8>>>

fn priority(&self) -> i32

fn config(&self, _config: &mut Config) -> Result<Option<()>, CompilationError>

fn build_start( &self, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn process_module( &self, _param: &mut PluginProcessModuleHookParam<'_>, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn finalize_module( &self, _param: &mut PluginFinalizeModuleHookParam<'_>, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn build_end( &self, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

The module graph should be constructed and finalized here

fn generate_start( &self, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn optimize_module_graph( &self, _module_graph: &mut ModuleGraph, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Some optimization of the module graph should be performed here, for example, tree shaking, scope hoisting

fn analyze_module_graph( &self, _module_graph: &mut ModuleGraph, _context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<ModuleGroupGraph>, CompilationError>

Analyze module group based on module graph

fn partial_bundling( &self, _modules: &Vec<ModuleId>, _context: &Arc<CompilationContext>, _hook_context: &PluginHookContext ) -> Result<Option<Vec<ResourcePot>>, CompilationError>

partial bundling modules to Vec

fn process_resource_pots( &self, _resource_pots: &mut Vec<&mut ResourcePot>, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

process resource graph before render and generating each resource

fn render_start( &self, _config: &Config, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn render_resource_pot( &self, _resource_pot: &PluginRenderResourcePotHookParam, _context: &Arc<CompilationContext> ) -> Result<Option<PluginRenderResourcePotHookResult>, CompilationError>

Transform rendered bundled code for the given resource_pot

fn augment_resource_hash( &self, _render_pot_info: &ResourcePotInfo, _context: &Arc<CompilationContext> ) -> Result<Option<String>, CompilationError>

fn optimize_resource_pot( &self, _resource: &mut ResourcePot, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Optimize the resource pot, for example, minimize

fn finalize_resources( &self, _param: &mut PluginFinalizeResourcesHookParams<'_>, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Do some finalization work on the generated resources, for example, add hash to the file name, or insert the generated resources into html

fn generate_end( &self, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn finish( &self, _stat: &Stats, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

fn update_modules( &self, _params: &mut PluginUpdateModulesHookParams, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Called when calling compiler.update(module_paths). Useful to do some operations like clearing previous state or ignore some files when performing HMR

fn module_graph_updated( &self, _param: &PluginModuleGraphUpdatedHookParams, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Called when calling compiler.update(module_paths). Useful to do some operations like modifying the module graph

fn update_finished( &self, _context: &Arc<CompilationContext> ) -> Result<Option<()>, CompilationError>

Called when calling compiler.update(module_paths). This hook is called after all compilation work is done, including the resources regeneration and finalization.

fn handle_persistent_cached_module( &self, _module: &Module, _context: &Arc<CompilationContext> ) -> Result<Option<bool>, CompilationError>