ObsidianPluginBuildContext
Where a plugin build writes its output and what it builds.
Import:
import type { ObsidianPluginBuildContext } from '@mnaoumov/obsidian-dev-toolkit/bundlers/obsidian-plugin-build';Signature:
export interface ObsidianPluginBuildContextProperties
| Property | Type | Description |
|---|---|---|
| distFolder | string | The absolute path of the folder the build writes main.js, styles.css and manifest.json into. |
| entryPoint | string | The absolute path of the plugin's entry point, src/main.ts. |
| isProductionBuild | boolean | Whether this is a production build. |
| mainJsPath | string | The absolute path of the emitted main.js. |
| obsidianConfigFolder | string | The Obsidian configuration folder a development build is deployed into, or an empty string when none is configured. |
| pluginName | string | The plugin's folder name inside <vault>/.obsidian/plugins, which is the package name. |
| reload | ObsidianPluginReload | How a development build is reloaded in Obsidian once it is deployed. |
Links to this page: