DefineWdioObsidianConfigOptions
Options for defineWdioObsidianConfig.
Import:
import type { DefineWdioObsidianConfigOptions } from '@mnaoumov/obsidian-dev-toolkit/test-runners/wdio-obsidian';Signature:
export interface DefineWdioObsidianConfigOptionsProperties
| Property | Type | Description |
|---|---|---|
| appVersions? | readonly string[] | The Obsidian app versions to test, one capability each: a version such as 1.8.10, latest, latest-beta, or earliest (the minAppVersion of manifest.json). Defaults to ['latest']; ['earliest', 'latest'] tests both ends of the supported range. |
| cacheFolder? | string | The folder Obsidian versions are downloaded into, relative to the project root. Defaults to .obsidian-cache, which belongs in .gitignore. |
| installerVersion? | string | The Obsidian installer (Electron) version, earliest or latest compatible with each app version, or an exact one. Defaults to the service's own choice. |
| maxInstances? | number | How many Obsidian instances run in parallel. Defaults to WebdriverIO's. |
| pluginFolder? | string | The folder holding the built plugin (main.js, manifest.json, styles.css), relative to the project root. Defaults to dist/build, where the production build writes it. |
| specs? | readonly string[] | The spec files, relative to the project root. Defaults to DEFAULT_END_TO_END_SPECS. |
| testTimeoutInMilliseconds? | number | The per-test timeout, in milliseconds. Defaults to DEFAULT_WDIO_OBSIDIAN_TEST_TIMEOUT_IN_MILLISECONDS. |
| vault? | false | string | The vault every test starts from, relative to the project root. The service opens a COPY of it, so the tests never change the folder. Defaults to the plugin's demo vault (demo-vault) when the project has one, and to an empty vault otherwise; false forces the empty vault. |
Links to this page: