ObsidianPluginReload

How a development build is reloaded in Obsidian once it is copied into the vault.

• 'hot-reload-plugin': the build writes the .hotreload marker, and npm run dev opens the vault in an Obsidian instance it owns, with the HotReload plugin installed and enabled there. - 'obsidian-cli': every rebuild runs obsidian plugin:reload against the Obsidian you already have open, through the Obsidian CLI (Settings → General → Command line interface). No HotReload, no second instance. - false: the build is copied into the vault and nothing reloads it.

Import:

import type { ObsidianPluginReload } from '@mnaoumov/obsidian-dev-toolkit/bundlers/obsidian-plugin-build';

Signature:

export type ObsidianPluginReload

Signature:

type ObsidianPluginReload = 'hot-reload-plugin' | 'obsidian-cli' | false

Type: ‘hot-reload-plugin’ | ‘obsidian-cli’ | false

---

Links to this page:

• BuildObsidianPluginParams
• BuildOptions
• ObsidianPluginBuildContext
• ObsidianPluginDeploymentOptions
• ResolveObsidianPluginBuildContextParams
• DeployToObsidianPluginsFolderParams
• BuildOptions
• ObsidianPluginRollupOptions
• ObsidianPluginViteOptions
• ObsidianPluginWebpackPluginOptions