Skip to content

BuildDemoVaultPopulateParams

Parameters for buildDemoVaultPopulate.

Import:

import type { BuildDemoVaultPopulateParams } from 'obsidian-integration-testing';

Signature:

export interface BuildDemoVaultPopulateParams

Properties

PropertyTypeDescription
demoVaultPathstringAbsolute path to the plugin repo's demo-vault/ directory.
excludedNames?Iterable<string>Names (of files or directories, matched at any depth) to skip while reading the note tree — forwarded to readDemoVaultTree.
injectPlugins?readonly InjectPluginParams[]Community plugins to seed into .obsidian/plugins/<pluginId>/ (binaries + optional data.json). Turn them on with the global-setup createSetup({ enableCommunityPlugins }) option.
obsidianConfigFiles?readonly string[].obsidian/* config files to carry over from the demo vault. readDemoVaultTree excludes the whole .obsidian directory, so config the vault relies on (preview-mode default, core plugins, appearance) must be re-added explicitly. Files that do not exist are skipped.

Links to this page: