BuildObsidianPluginParams
Options for buildObsidianPlugin.
Import:
import type { BuildObsidianPluginParams } from '@mnaoumov/obsidian-dev-toolkit/bundlers/esbuild-impl/obsidian-plugin-builder';Signature:
export interface BuildObsidianPluginParams extends ObsidianPluginDeploymentOptions, ObsidianPluginFeatureOptionsExtends: ObsidianPluginDeploymentOptions, ObsidianPluginFeatureOptions
Properties
| Property | Type | Description |
|---|---|---|
| customEsbuildPlugins? | Plugin[] | Custom esbuild plugins to be used during the build process. |
| customizeEsbuildOptions? | (options: EsbuildOptions) => void | Customizes the esbuild options. |
| framework? | ObsidianPluginFramework | The UI framework whose components the build compiles. (Inherited from ObsidianPluginFeatureOptions) |
| mode | BuildMode | A build mode, either Development or Production |
| obsidianConfigFolder? | string | A folder for Obsidian configuration. Defaults to the OBSIDIAN_CONFIG_FOLDER environment variable, read from the process or from a .env file in the project root.(Inherited from ObsidianPluginDeploymentOptions) |
| reload? | ObsidianPluginReload | How a development build is reloaded in Obsidian once it is copied into the vault. Defaults to 'hot-reload-plugin'.(Inherited from ObsidianPluginDeploymentOptions) |
| styles? | ObsidianPluginStylesOptions | The stylesheet pipeline. (Inherited from ObsidianPluginFeatureOptions) |
| wasm? | boolean | Whether import bytes from './module.wasm' imports the module's bytes as a Uint8Array, inlined into main.js.(Inherited from ObsidianPluginFeatureOptions) |
Links to this page: