wdio-obsidian-service 2.3.3 → 3.0.0

package/README.md

@@ -80,7 +80,7 @@ export const config: WebdriverIO.Config = {
     mochaOpts: {
         ui: 'bdd',
         timeout: 60000,
-        // You can set mocha settings like "retry" and "bail"
+        // You can set mocha settings like "retries" and "bail"
     },
     logLevel: "warn",
 }

package/dist/index.d.ts

@@ -287,17 +287,26 @@ type ObsidianBrowserCommands = typeof browserCommands & {
      * {@link ObsidianPage.resetVault} instead, which modifies vault files in place without rebooting Obsidian. If all
      * your tests use the same vault, you can also just set the vault in the `wdio.conf.mts` capabilities section.
      *
-     * @param params.vault Path to the vault to open. The vault will be copied, so any changes made in your tests won't
-     *     be persited to the original. If omitted, it will reboot Obsidian with the current vault without creating a
-     *     new copy of the vault.
+     * @param params.vault Path to the vault to open. The vault will be copied by default, so any changes made in your
+     *   tests won't be persisted to the original. Set `copy` to `false` to use the vault in-place. If omitted, it will
+     *   reboot Obsidian with the current vault without creating a new copy of the vault.
+     * @param params.copy Whether to copy the vault to a temporary directory before running tests in it (default true).
+     *   When `true` (the default), the vault is copied so that tests don't modify the original and parallel tests will
+     *   work on separate copies of the vault. When `false`, the vault is used in-place, useful for debugging or
+     *   read-only tests on large vaults.
+     *
+     *   **WARNING**: With `copy: false`, even with "read-only" tests, Obsidian will often make changes under
+     *   `.obsidian` that will get persisted. This also means that running parallel tests on the same vault with
+     *   `copy: false` is unsafe.
      * @param params.plugins List of plugin ids to enable. If omitted it will keep current plugin list. Note, all the
-     *     plugins must be defined in your wdio.conf.mts capabilities. You can also use the enablePlugin and
-     *     disablePlugin commands to change plugins without relaunching Obsidian.
+     *   plugins must be defined in your wdio.conf.mts capabilities. You can also use the enablePlugin and disablePlugin
+     *   commands to change plugins without relaunching Obsidian.
      * @param params.theme Name of the theme to enable. If omitted it will keep the current theme. Pass "default" to
-     *     switch back to the default theme. Like with plugins, the theme must be defined in wdio.conf.mts.
+     *   switch back to the default theme. Like with plugins, the theme must be defined in wdio.conf.mts.
      */
     reloadObsidian(params?: {
         vault?: string;
+        copy?: boolean;
         plugins?: string[];
         theme?: string;
     }): Promise<void>;
@@ -421,11 +430,24 @@ interface ObsidianCapabilityOptions {
     /**
      * The path to the vault to open.
      *
-     * The vault will be copied, so any changes made in your tests won't affect the original. If omitted, no vault will
-     * be opened and you'll need to call {@link ObsidianBrowserCommands.reloadObsidian|browser.reloadObsidian} to open a
-     * vault during your tests. Path is relative to your `wdio.conf.mts`.
+     * By default the vault will be copied to a temporary directory, so any changes made in your tests won't affect
+     * the original. Set {@link copy} to `false` to use the vault in-place. If omitted, no vault will be opened and
+     * you'll need to call {@link ObsidianBrowserCommands.reloadObsidian|browser.reloadObsidian} to open a vault
+     * during your tests. Path is relative to your `wdio.conf.mts`.
      */
     vault?: string;
+    /**
+     * Whether to copy the vault to a temporary directory before running tests in it (the default).
+     *
+     * When `true` (the default), the vault is copied so that tests don't modify the original and parallel tests will
+     * work on separate copies of the vault. When `false`, the vault is used in-place, useful for debugging or
+     * read-only tests on large vaults.
+     *
+     * **WARNING**: With `copy: false`, even with "read-only" tests, Obsidian will often make changes under `.obsidian`
+     * that will get persisted. This also means that running parallel tests on the same vault with `copy: false` is
+     * unsafe.
+     */
+    copy?: boolean;
     /**
      * Set to true to emulate mobile on the Electron desktop app. This uses Obsidian `app.emulateMobile()` to switch
      * Obsidian to the mobile UI, and you can use Chrome's mobileEmulation to set the screen size. You can compare
@@ -531,11 +553,9 @@ declare class ObsidianWorkerService implements Services.ServiceInstance {
     private browser;
     /** Directories to clean up after the tests */
     private tmpDirs;
-    /** Path on Android devices to store temporary vaults */
-    private androidVaultDir;
     constructor(options: ObsidianServiceOptions, capabilities: WebdriverIO.Capabilities, config: Options.Testrunner);
     /**
-     * Creates a copy of the vault with plugins and themes installed
+     * Sets up the vault with plugins and themes installed, optionally copying it first.
      */
     private setupVault;
     /**