Skip to content

TestEndToEndWithObsidianTestOptions

Options for testEndToEndWithObsidianTest.

Import:

import type { TestEndToEndWithObsidianTestOptions } from '@mnaoumov/obsidian-dev-toolkit/test-runners/obsidian-test-runner';

Signature:

export interface TestEndToEndWithObsidianTestOptions

Properties

PropertyTypeDescription
obsidianCommand?stringThe command that launches Obsidian. Defaults to obsidian-test's own, obsidian; point it at the executable when obsidian is not on PATH.
shouldUseCache?booleanWhether obsidian-test may replay its cached results when the plugin, the tests and Obsidian are unchanged. Defaults to true; false passes --force.
testPattern?stringThe glob of the test files, relative to the project root. Defaults to DEFAULT_END_TO_END_SPECS. obsidian-test's own default also matches every *.test.ts, which would bundle the unit tests into Obsidian.
vaultPath?stringThe vault to run in, relative to the project root. obsidian-test installs the plugin INTO it, so it must be a scratch vault, never the demo vault. Defaults to a temporary vault.

Links to this page: