BootstrapDemoVaultPluginsParams
Parameters for bootstrapDemoVaultPlugins.
Import:
import type { BootstrapDemoVaultPluginsParams } from 'obsidian-integration-testing';Signature:
export interface BootstrapDemoVaultPluginsParamsProperties
| Property | Type | Description |
|---|---|---|
| demoVaultPath | string | Absolute path to the plugin repo's demo-vault/ directory. |
| injectPlugins | readonly InjectPluginParams[] | The injected plugins to install — the same list passed to buildDemoVaultPopulate. Plugins whose binaries are already present, and not stale against their version / minVersion, are skipped (unless BootstrapDemoVaultPluginsParams.shouldForce), as are plugins carrying an explicit sourceDirectory. |
| shouldForce? | boolean | undefined | Whether to re-download plugins that are already installed, replacing them with the current release. Defaults to false — the normal path installs only what is missing, so a warm checkout does no network I/O at all. |
| shouldSkipUnlistedPlugins? | boolean | undefined | Whether a plugin with no explicit repo that Obsidian's community plugin registry does not list is reported in BootstrapDemoVaultPluginsResult.unlistedPluginIds instead of failing the run. Defaults to false: a setup names exactly the plugins it needs, so one it cannot install is an error. The CLI turns it on when it sweeps a whole .obsidian/plugins/ folder, which holds local plugins such as demo-vault-helper that were never published. |
Links to this page: