TestEndToEndWithObsidianTestOptions
Options for testEndToEndWithObsidianTest.
Import:
import type { TestEndToEndWithObsidianTestOptions } from '@mnaoumov/obsidian-dev-toolkit/test-runners/obsidian-test-runner';Signature:
export interface TestEndToEndWithObsidianTestOptionsProperties
| Property | Type | Description |
|---|---|---|
| obsidianCommand? | string | The command that launches Obsidian. Defaults to obsidian-test's own, obsidian; point it at the executable when obsidian is not on PATH. |
| shouldUseCache? | boolean | Whether obsidian-test may replay its cached results when the plugin, the tests and Obsidian are unchanged. Defaults to true; false passes --force. |
| testPattern? | string | The 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? | string | The 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: