BasePlugin

Plugin base class providing lifecycle management, logging, and validation.

import { BasePlugin } from '@meng-xi/vite-plugin/factory'

Abstract Methods (Required)

Method	Description
getPluginName()	Return plugin name
getDefaultOptions()	Return default options
addPluginHooks(plugin)	Add Vite plugin hooks

Optional Methods

Method	Default	Description
validateOptions()	No validation	Validate options
getEnforce()	undefined	Plugin execution timing
onConfigResolved(config)	Store config	Config resolved callback

Built-in Properties

Property	Type	Description
options	Required<T>	Merged options
logger	PluginLogger	Plugin logger
validator	Validator<T>	Config validator
viteConfig	ResolvedConfig	Resolved Vite config

Built-in Methods

safeExecute / safeExecuteSync

Safely execute functions with error handling.

protected async safeExecute<T>(fn: () => Promise<T>, context: string): Promise<T | undefined>
protected safeExecuteSync<T>(fn: () => T, context: string): T | undefined

handleError

Handle errors based on errorStrategy.

protected handleError<T>(error: unknown, context: string): T | undefined

toPlugin

Convert to Vite plugin object.

public toPlugin(): Plugin

Example

class MyPlugin extends BasePlugin<MyPluginOptions> {
	protected getPluginName() {
		return 'my-plugin'
	}

	protected getDefaultOptions() {
		return { outputPath: 'dist/output.json' }
	}

	protected addPluginHooks(plugin: Plugin) {
		plugin.buildStart = () => {
			if (!this.options.enabled) return
			this.logger.info('Build started')
		}
	}
}