Skip to content

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 ObsidianPluginBuildContext

Properties

PropertyTypeDescription
distFolderstringThe absolute path of the folder the build writes main.js, styles.css and manifest.json into.
entryPointstringThe absolute path of the plugin's entry point, src/main.ts.
isProductionBuildbooleanWhether this is a production build.
mainJsPathstringThe absolute path of the emitted main.js.
obsidianConfigFolderstringThe Obsidian configuration folder a development build is deployed into, or an empty string when none is configured.
pluginNamestringThe plugin's folder name inside <vault>/.obsidian/plugins, which is the package name.
reloadObsidianPluginReloadHow a development build is reloaded in Obsidian once it is deployed.

Links to this page: