obsidian-integration-testing 8.4.0 → 9.1.0

package/README.md

@@ -26,7 +26,7 @@ import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
-    globalSetup: ['obsidian-integration-testing/vitest-global-setup'],
+    globalSetup: ['obsidian-integration-testing/vitest-global-setup-plugin'],
   },
 });
 ```
@@ -52,8 +52,8 @@ Or add it to `compilerOptions.types` in your `tsconfig.json`:
 ```ts
 // jest.config.ts
 export default {
-  globalSetup: 'obsidian-integration-testing/jest-global-setup',
-  globalTeardown: 'obsidian-integration-testing/jest-global-teardown',
+  globalSetup: 'obsidian-integration-testing/jest-global-setup-plugin',
+  globalTeardown: 'obsidian-integration-testing/jest-global-teardown-plugin',
 };
 ```
 
@@ -383,7 +383,7 @@ Use `getTempVault()` to get the temporary vault created by the global setup:
 ```ts
 import { describe, expect, it } from 'vitest';
 import { evalInObsidian } from 'obsidian-integration-testing';
-import { getTempVault } from 'obsidian-integration-testing/vitest-global-setup';
+import { getTempVault } from 'obsidian-integration-testing/vitest-global-setup-plugin';
 
 describe('my-plugin', () => {
   const vault = getTempVault();
@@ -418,7 +418,7 @@ describe('my-plugin', () => {
 
 ```ts
 import { evalInObsidian } from 'obsidian-integration-testing';
-import { getTempVault } from 'obsidian-integration-testing/jest-global-setup';
+import { getTempVault } from 'obsidian-integration-testing/jest-global-setup-plugin';
 
 describe('my-plugin', () => {
   const vault = getTempVault();
@@ -444,7 +444,7 @@ This capability reaches all three consumption paths.
 
 ```ts
 // integration-global-setup.ts
-import { createSetup } from 'obsidian-integration-testing/vitest-global-setup';
+import { createSetup } from 'obsidian-integration-testing/vitest-global-setup-plugin';
 
 export const { setup, teardown } = createSetup({
   populate: () => ({
@@ -469,7 +469,7 @@ export default defineConfig({
 
 ```ts
 // integration-global-setup.ts — shared createSetup pair
-import { createSetup } from 'obsidian-integration-testing/jest-global-setup';
+import { createSetup } from 'obsidian-integration-testing/jest-global-setup-plugin';
 
 export const { setup, teardown } = createSetup({
   populate: () => ({
@@ -500,6 +500,58 @@ Both files share the same `createSetup` instance (via the common module), so `te
 
 **Manual** — when wiring `TempVault` yourself (without a framework global setup), call `vault.populate()` before `vault.register()`, as shown in [Create a temporary vault](#create-a-temporary-vault).
 
+### Seed a plugin's `demo-vault/` and enable extra community plugins
+
+A plugin's committed `demo-vault/` often needs more than the plugin-under-test — e.g. **CodeScript Toolkit** (`fix-require-modules`) to run its `code-button` blocks, or the `demo-vault-helper` bootstrap. Two pieces make this a one-liner:
+
+- **`enableCommunityPlugins`** — a `createSetup` option listing community-plugin ids to enable **in addition to** the plugin-under-test, after it is enabled. Each id's built files must already be in the vault (seed them below). This replaces the hand-rolled `beforeAll` that turned off restricted mode and called `enablePlugin(...)` in every demo-vault test.
+- **`buildDemoVaultPopulate`** — reads the repo's `demo-vault/` tree, carries over selected `.obsidian/*` config (`app.json`, `appearance.json`, `core-plugins.json` by default), and seeds each injected plugin's binaries (+ optional `data.json`) — returning a `populate` map. It complements the release-time demo-vault archiving in `obsidian-dev-utils`.
+
+```ts
+// integration-global-setup.ts
+import { buildDemoVaultPopulate } from 'obsidian-integration-testing';
+import { createSetup } from 'obsidian-integration-testing/vitest-global-setup-plugin';
+import { getRootFolder } from 'obsidian-dev-utils/script-utils/root';
+import { join } from 'node:path';
+
+const CST_ID = 'fix-require-modules';
+
+export const { setup, teardown } = createSetup({
+  // Turn on the seeded extra plugins (the plugin-under-test is enabled automatically).
+  enableCommunityPlugins: [CST_ID],
+  populate: () =>
+    buildDemoVaultPopulate({
+      demoVaultPath: join(getRootFolder() ?? process.cwd(), 'demo-vault'),
+      // CST binaries come from the demo vault's local (gitignored) install; `data` writes its data.json.
+      injectPlugins: [{ pluginId: CST_ID, data: { modulesRoot: '_assets' } }]
+    })
+});
+```
+
+`buildDemoVaultPopulate` throws an actionable error if an injected plugin's `main.js`/`manifest.json` is missing from the demo vault — open `demo-vault/` in Obsidian once so `demo-vault-helper` installs it, then re-run. `enableCommunityPlugins` also composes with `installPlugin: false` (enable extras into an otherwise plugin-less vault).
+
+### Non-plugin consumers
+
+If your project is **not** a plugin — a tool that only needs a registered, empty vault to `evalInObsidian` against (e.g. a typings crawler) — point `globalSetup` at the **`-no-plugin`** entry point instead of `-plugin`. It still launches one owned, off-screen Obsidian instance and publishes its endpoint to workers so each worker **attaches** to it, but skips reading `dist/manifest.json`, copying a plugin, writing `community-plugins.json`, and enabling a plugin. No wrapper module needed:
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globalSetup: ['obsidian-integration-testing/vitest-global-setup-no-plugin']
+  }
+});
+```
+
+```ts
+// your.integration.test.ts — read the empty registered vault's path
+import { getTempVault } from 'obsidian-integration-testing/vitest-global-setup-no-plugin';
+```
+
+For Jest, use `obsidian-integration-testing/jest-global-setup-no-plugin` (`globalSetup`) + `obsidian-integration-testing/jest-global-teardown-no-plugin` (`globalTeardown`). If you also need to pre-populate the empty vault, build the pair yourself with `createSetup({ installPlugin: false, populate })` from the `-plugin` factory and re-export its `setup`/`teardown` (the same wrapper pattern shown above for `populate`).
+
 > [!WARNING]
 >
 > **Parallelism:**
@@ -591,7 +643,7 @@ By default the library **launches and owns an isolated Obsidian instance** in a
    export default defineConfig({
      test: {
        fileParallelism: false,
-       globalSetup: ['obsidian-integration-testing/vitest-global-setup'],
+       globalSetup: ['obsidian-integration-testing/vitest-global-setup-plugin'],
      },
    });
    ```
@@ -721,7 +773,7 @@ Runs tests against Obsidian Mobile on an Android emulator or real device via App
    export default defineConfig({
      test: {
        fileParallelism: false,
-       globalSetup: ['obsidian-integration-testing/vitest-global-setup'],
+       globalSetup: ['obsidian-integration-testing/vitest-global-setup-plugin'],
        environmentOptions: {
          obsidianTransport: {
            type: 'obsidian-android-appium',
@@ -765,6 +817,25 @@ save a snapshot, and always boot from that snapshot. Either way, an ANR signals
 under-provisioned, so also give the AVD more vCPUs/RAM and confirm hardware acceleration
 (`emulator -accel-check`).
 
+#### Troubleshooting: "Android AVD ... not found" / "Appium server ... exited during startup"
+
+The Android setup fails fast (rather than spinning out a timeout) when the toolchain cannot be brought
+up, naming what is missing:
+
+- **`Android AVD "<name>" not found. Available AVDs: ...`** — the `avdName` you passed does not exist.
+  Run `emulator -list-avds`, then either point `avdName` at a listed AVD or create the one you want
+  (Android Studio Device Manager, or `avdmanager create avd`). AVD creation is not automated — it needs a
+  system-image download, license acceptance, and hardware/API-level choices.
+- **`Auto-started Appium server ... during startup` / `... did not become ready ...`** — the harness
+  auto-started Appium (`npx --no-install appium`) but it exited or never responded; the message appends
+  the captured server output. Usually a missing/broken toolchain: pass `isAppiumConsoleVisible: true` to
+  watch the live server log, or manage Appium yourself (`shouldAutoStartAppium: false`, pointing
+  `appiumUrl` at your own running server).
+- **`Appium was installed ... but is still not resolvable ...`** — the auto-install ran
+  `npm install -g appium`, but the npm global bin dir is not on PATH (common with scoop/nvm-managed Node).
+  Add it to PATH (see `npm config get prefix`), or set `shouldAutoInstallAppiumDependencies: false` and
+  install Appium yourself.
+
 #### Troubleshooting: "Obsidian layout did not become ready"
 
 Registering a vault reloads the page, triggering a full Obsidian re-init (reopen the vault and
@@ -789,7 +860,7 @@ export default defineConfig({
         test: {
           name: 'integration-tests:desktop-cdp',
           fileParallelism: false,
-          globalSetup: ['obsidian-integration-testing/vitest-global-setup'],
+          globalSetup: ['obsidian-integration-testing/vitest-global-setup-plugin'],
           include: ['src/**/*.integration.test.ts'],
           exclude: ['src/**/*.android.integration.test.ts'],
           // default transport, can be omitted
@@ -802,7 +873,7 @@ export default defineConfig({
         test: {
           name: 'integration-tests:android-appium',
           fileParallelism: false,
-          globalSetup: ['obsidian-integration-testing/vitest-global-setup'],
+          globalSetup: ['obsidian-integration-testing/vitest-global-setup-plugin'],
           include: ['src/**/*.android.integration.test.ts'],
           environmentOptions: {
             obsidianTransport: {

package/dist/lib/cjs/avd-list.cjs

@@ -0,0 +1,36 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var avd_list_exports = {};
+__export(avd_list_exports, {
+  checkAvdExists: () => checkAvdExists,
+  listAvailableAvds: () => listAvailableAvds
+});
+module.exports = __toCommonJS(avd_list_exports);
+function checkAvdExists(params) {
+  return listAvailableAvds(params.avdListOutput).includes(params.avdName);
+}
+function listAvailableAvds(avdListOutput) {
+  return avdListOutput.split("\n").map((line) => line.trim()).filter((line) => line.length > 0 && !line.includes("|"));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  checkAvdExists,
+  listAvailableAvds
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2F2ZC1saXN0LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogUHVyZSBoZWxwZXJzIGZvciBwYXJzaW5nIGBlbXVsYXRvciAtbGlzdC1hdmRzYCBvdXRwdXQ6IGV4dHJhY3RpbmcgdGhlXG4gKiBhdmFpbGFibGUgQVZEIG5hbWVzIGFuZCBjaGVja2luZyB3aGV0aGVyIGEgcmVxdWVzdGVkIEFWRCBleGlzdHMuXG4gKlxuICogS2VwdCBzZXBhcmF0ZSBmcm9tIHRoZSBpbnRlZ3JhdGlvbi1vbmx5IGB0cmFuc3BvcnQtZmFjdG9yeWAgKGV4Y2x1ZGVkIGZyb21cbiAqIHVuaXQgdGVzdHMpIHNvIHRoZSBwYXJzaW5nIHN0YXlzIHVuaXQtdGVzdGFibGUgXHUyMDE0IHRoZSBmYWN0b3J5IGl0c2VsZiBzaGVsbHMgb3V0XG4gKiB0byB0aGUgYGVtdWxhdG9yYCBiaW5hcnkuXG4gKi9cblxuLyoqXG4gKiBQYXJhbWV0ZXJzIGZvciB7QGxpbmsgY2hlY2tBdmRFeGlzdHN9LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIENoZWNrQXZkRXhpc3RzUGFyYW1zIHtcbiAgLyoqIFJhdyBzdGRvdXQgb2YgYGVtdWxhdG9yIC1saXN0LWF2ZHNgIFx1MjAxNCBvbmUgQVZEIG5hbWUgcGVyIGxpbmUuICovXG4gIHJlYWRvbmx5IGF2ZExpc3RPdXRwdXQ6IHN0cmluZztcblxuICAvKiogVGhlIEFWRCBuYW1lIHRvIGxvb2sgZm9yLiAqL1xuICByZWFkb25seSBhdmROYW1lOiBzdHJpbmc7XG59XG5cbi8qKlxuICogRGVjaWRlcyB3aGV0aGVyIGEgZ2l2ZW4gQVZEIGV4aXN0cywgZnJvbSB0aGUgcmF3IHN0ZG91dCBvZlxuICogYGVtdWxhdG9yIC1saXN0LWF2ZHNgLlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgbGlzdGluZyBvdXRwdXQgYW5kIHRoZSBBVkQgbmFtZSB0byBjaGVjay5cbiAqIEByZXR1cm5zIGB0cnVlYCB3aGVuIHRoZSBBVkQgbmFtZSBhcHBlYXJzIGluIHRoZSBsaXN0aW5nLlxuICovXG5leHBvcnQgZnVuY3Rpb24gY2hlY2tBdmRFeGlzdHMocGFyYW1zOiBDaGVja0F2ZEV4aXN0c1BhcmFtcyk6IGJvb2xlYW4ge1xuICByZXR1cm4gbGlzdEF2YWlsYWJsZUF2ZHMocGFyYW1zLmF2ZExpc3RPdXRwdXQpLmluY2x1ZGVzKHBhcmFtcy5hdmROYW1lKTtcbn1cblxuLyoqXG4gKiBQYXJzZXMgdGhlIGF2YWlsYWJsZSBBVkQgbmFtZXMgZnJvbSB0aGUgcmF3IHN0ZG91dCBvZiBgZW11bGF0b3IgLWxpc3QtYXZkc2AuXG4gKlxuICogVGhlIGNvbW1hbmQgcHJpbnRzIG9uZSBBVkQgbmFtZSBwZXIgbGluZTsgYmxhbmsgbGluZXMgYW5kIHN1cnJvdW5kaW5nXG4gKiB3aGl0ZXNwYWNlIGFyZSBpZ25vcmVkLiBTb21lIGVtdWxhdG9yIGJ1aWxkcyBlbWl0IGFuIGluZm9ybWF0aW9uYWwgYmFubmVyXG4gKiAoZS5nLiBgSU5GTyAgICB8IC4uLmApIHRvIHN0ZG91dCBiZWZvcmUgdGhlIGxpc3QsIHNvIHRob3NlIGxpbmVzIGFyZSBkcm9wcGVkLlxuICpcbiAqIEBwYXJhbSBhdmRMaXN0T3V0cHV0IC0gUmF3IHN0ZG91dCBvZiBgZW11bGF0b3IgLWxpc3QtYXZkc2AuXG4gKiBAcmV0dXJucyBUaGUgYXZhaWxhYmxlIEFWRCBuYW1lcywgaW4gbGlzdGVkIG9yZGVyLlxuICovXG5leHBvcnQgZnVuY3Rpb24gbGlzdEF2YWlsYWJsZUF2ZHMoYXZkTGlzdE91dHB1dDogc3RyaW5nKTogc3RyaW5nW10ge1xuICByZXR1cm4gYXZkTGlzdE91dHB1dFxuICAgIC5zcGxpdCgnXFxuJylcbiAgICAubWFwKChsaW5lKSA9PiBsaW5lLnRyaW0oKSlcbiAgICAuZmlsdGVyKChsaW5lKSA9PiBsaW5lLmxlbmd0aCA+IDAgJiYgIWxpbmUuaW5jbHVkZXMoJ3wnKSk7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUE2Qk8sU0FBUyxlQUFlLFFBQXVDO0FBQ3BFLFNBQU8sa0JBQWtCLE9BQU8sYUFBYSxFQUFFLFNBQVMsT0FBTyxPQUFPO0FBQ3hFO0FBWU8sU0FBUyxrQkFBa0IsZUFBaUM7QUFDakUsU0FBTyxjQUNKLE1BQU0sSUFBSSxFQUNWLElBQUksQ0FBQyxTQUFTLEtBQUssS0FBSyxDQUFDLEVBQ3pCLE9BQU8sQ0FBQyxTQUFTLEtBQUssU0FBUyxLQUFLLENBQUMsS0FBSyxTQUFTLEdBQUcsQ0FBQztBQUM1RDsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/avd-list.d.cts

@@ -0,0 +1,38 @@
+/**
+ * @file
+ *
+ * Pure helpers for parsing `emulator -list-avds` output: extracting the
+ * available AVD names and checking whether a requested AVD exists.
+ *
+ * Kept separate from the integration-only `transport-factory` (excluded from
+ * unit tests) so the parsing stays unit-testable — the factory itself shells out
+ * to the `emulator` binary.
+ */
+/**
+ * Parameters for {@link checkAvdExists}.
+ */
+export interface CheckAvdExistsParams {
+    /** Raw stdout of `emulator -list-avds` — one AVD name per line. */
+    readonly avdListOutput: string;
+    /** The AVD name to look for. */
+    readonly avdName: string;
+}
+/**
+ * Decides whether a given AVD exists, from the raw stdout of
+ * `emulator -list-avds`.
+ *
+ * @param params - The listing output and the AVD name to check.
+ * @returns `true` when the AVD name appears in the listing.
+ */
+export declare function checkAvdExists(params: CheckAvdExistsParams): boolean;
+/**
+ * Parses the available AVD names from the raw stdout of `emulator -list-avds`.
+ *
+ * The command prints one AVD name per line; blank lines and surrounding
+ * whitespace are ignored. Some emulator builds emit an informational banner
+ * (e.g. `INFO    | ...`) to stdout before the list, so those lines are dropped.
+ *
+ * @param avdListOutput - Raw stdout of `emulator -list-avds`.
+ * @returns The available AVD names, in listed order.
+ */
+export declare function listAvailableAvds(avdListOutput: string): string[];

package/dist/lib/cjs/demo-vault-populate.cjs

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var demo_vault_populate_exports = {};
+__export(demo_vault_populate_exports, {
+  buildDemoVaultPopulate: () => buildDemoVaultPopulate
+});
+module.exports = __toCommonJS(demo_vault_populate_exports);
+var import_node_fs = require("node:fs");
+var import_node_path = require("node:path");
+var import_demo_vault_tree = require("./demo-vault-tree.cjs");
+var import_type_guards = require("./type-guards.cjs");
+const OBSIDIAN_CONFIG_DIR = ".obsidian";
+const PLUGINS_DIR = "plugins";
+const DATA_JSON = "data.json";
+const MANIFEST_JSON = "manifest.json";
+const MAIN_JS = "main.js";
+const DATA_JSON_INDENT = 2;
+const DEFAULT_OBSIDIAN_CONFIG_FILES = ["app.json", "appearance.json", "core-plugins.json"];
+function buildDemoVaultPopulate(params) {
+  const { demoVaultPath, excludedNames, injectPlugins = [], obsidianConfigFiles = DEFAULT_OBSIDIAN_CONFIG_FILES } = params;
+  const map = (0, import_demo_vault_tree.readDemoVaultTree)(excludedNames === void 0 ? { demoVaultPath } : { demoVaultPath, excludedNames });
+  for (const configFile of obsidianConfigFiles) {
+    const configPath = (0, import_node_path.join)(demoVaultPath, OBSIDIAN_CONFIG_DIR, configFile);
+    if ((0, import_node_fs.existsSync)(configPath)) {
+      map[`${OBSIDIAN_CONFIG_DIR}/${configFile}`] = (0, import_node_fs.readFileSync)(configPath);
+    }
+  }
+  for (const plugin of injectPlugins) {
+    seedPlugin(demoVaultPath, plugin, map);
+  }
+  return map;
+}
+function seedPlugin(demoVaultPath, plugin, map) {
+  const { data, pluginId } = plugin;
+  const sourceDir = plugin.sourceDir ?? (0, import_node_path.join)(demoVaultPath, OBSIDIAN_CONFIG_DIR, PLUGINS_DIR, pluginId);
+  const pluginPrefix = `${OBSIDIAN_CONFIG_DIR}/${PLUGINS_DIR}/${pluginId}`;
+  const fileNames = (0, import_node_fs.existsSync)(sourceDir) ? (0, import_node_fs.readdirSync)(sourceDir, { withFileTypes: true }).filter((entry) => entry.isFile()).map((entry) => entry.name) : [];
+  for (const requiredFile of [MAIN_JS, MANIFEST_JSON]) {
+    if (!fileNames.includes(requiredFile)) {
+      throw new Error(
+        `Community plugin "${pluginId}" is not installed in the demo vault (${(0, import_node_path.join)(sourceDir, requiredFile)} missing). Open demo-vault/ in Obsidian once so demo-vault-helper installs it, then re-run.`
+      );
+    }
+  }
+  for (const fileName of fileNames) {
+    if (fileName === DATA_JSON && data !== void 0) {
+      continue;
+    }
+    map[`${pluginPrefix}/${fileName}`] = (0, import_node_fs.readFileSync)((0, import_node_path.join)(sourceDir, fileName));
+  }
+  if (data !== void 0) {
+    const dataJson = (0, import_type_guards.ensureNonNullable)(JSON.stringify(data, null, DATA_JSON_INDENT));
+    map[`${pluginPrefix}/${DATA_JSON}`] = `${dataJson}
+`;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildDemoVaultPopulate
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/demo-vault-populate.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Builds a complete {@link PopulateFilesParams} map for a plugin's in-repo `demo-vault/`, ready to seed into\n * the temp vault before Obsidian opens it. Composes {@link readDemoVaultTree} (the note tree) with the two\n * pieces it deliberately omits: selected `.obsidian/*` config files, and the built binaries (+ `data.json`)\n * of any extra community plugins the demo vault depends on (e.g. CodeScript Toolkit, `demo-vault-helper`).\n *\n * Pairs with the `enableCommunityPlugins` option of the global-setup `createSetup`: this seeds the binaries,\n * that turns them on. It intentionally does NOT write `community-plugins.json` \u2014 the harness owns that file\n * (it lists the plugin-under-test), and enabling the extras persists them.\n */\n\nimport {\n  existsSync,\n  readdirSync,\n  readFileSync\n} from 'node:fs';\nimport { join } from 'node:path';\n\nimport type { PopulateFilesParams } from './temp-vault.cjs';\n\nimport { readDemoVaultTree } from './demo-vault-tree.cjs';\nimport { ensureNonNullable } from './type-guards.cjs';\n\nconst OBSIDIAN_CONFIG_DIR = '.obsidian';\nconst PLUGINS_DIR = 'plugins';\nconst DATA_JSON = 'data.json';\nconst MANIFEST_JSON = 'manifest.json';\nconst MAIN_JS = 'main.js';\nconst DATA_JSON_INDENT = 2;\n\nconst DEFAULT_OBSIDIAN_CONFIG_FILES = ['app.json', 'appearance.json', 'core-plugins.json'];\n\n/**\n * Parameters for {@link buildDemoVaultPopulate}.\n */\nexport interface BuildDemoVaultPopulateParams {\n  /**\n   * Absolute path to the plugin repo's `demo-vault/` directory.\n   */\n  readonly demoVaultPath: string;\n\n  /**\n   * Names (of files or directories, matched at any depth) to skip while reading the note tree \u2014 forwarded to\n   * {@link readDemoVaultTree}.\n   *\n   * @default `['.git', '.obsidian']`\n   */\n  readonly excludedNames?: Iterable<string>;\n\n  /**\n   * Community plugins to seed into `.obsidian/plugins/<pluginId>/` (binaries + optional `data.json`). Turn\n   * them on with the global-setup `createSetup({ enableCommunityPlugins })` option.\n   */\n  readonly injectPlugins?: readonly InjectPluginParams[];\n\n  /**\n   * `.obsidian/*` config files to carry over from the demo vault. {@link readDemoVaultTree} excludes the whole\n   * `.obsidian` directory, so config the vault relies on (preview-mode default, core plugins, appearance) must\n   * be re-added explicitly. Files that do not exist are skipped.\n   *\n   * @default `['app.json', 'appearance.json', 'core-plugins.json']`\n   */\n  readonly obsidianConfigFiles?: readonly string[];\n}\n\n/**\n * A community plugin to seed into the demo vault alongside the note tree.\n */\nexport interface InjectPluginParams {\n  /**\n   * Overlay written as `.obsidian/plugins/<pluginId>/data.json` (JSON, 2-space indent). Omit to keep whatever\n   * `data.json` (if any) already lives in {@link InjectPluginParams.sourceDir}.\n   */\n  readonly data?: unknown;\n\n  /**\n   * The community plugin's id (its `.obsidian/plugins/<pluginId>` folder name).\n   */\n  readonly pluginId: string;\n\n  /**\n   * Directory to read the plugin's built files from. Every file directly inside it is copied into\n   * `.obsidian/plugins/<pluginId>/`; `main.js` and `manifest.json` are required.\n   *\n   * @default `<demoVaultPath>/.obsidian/plugins/<pluginId>`\n   */\n  readonly sourceDir?: string;\n}\n\n/**\n * Builds the full populate map for a plugin's `demo-vault/`: the note tree, the selected `.obsidian/*` config\n * files, and every injected plugin's binaries (+ optional `data.json`).\n *\n * @param params - The {@link BuildDemoVaultPopulateParams}.\n * @returns The populate map, ready to hand to a global setup's `populate` or {@link TempVault.populate}.\n */\nexport function buildDemoVaultPopulate(params: BuildDemoVaultPopulateParams): PopulateFilesParams {\n  const { demoVaultPath, excludedNames, injectPlugins = [], obsidianConfigFiles = DEFAULT_OBSIDIAN_CONFIG_FILES } = params;\n\n  const map = readDemoVaultTree(excludedNames === undefined ? { demoVaultPath } : { demoVaultPath, excludedNames });\n\n  for (const configFile of obsidianConfigFiles) {\n    const configPath = join(demoVaultPath, OBSIDIAN_CONFIG_DIR, configFile);\n    if (existsSync(configPath)) {\n      map[`${OBSIDIAN_CONFIG_DIR}/${configFile}`] = readFileSync(configPath);\n    }\n  }\n\n  for (const plugin of injectPlugins) {\n    seedPlugin(demoVaultPath, plugin, map);\n  }\n\n  return map;\n}\n\n/**\n * Seeds one injected plugin's binaries (and optional `data.json`) into the populate map.\n *\n * @param demoVaultPath - The demo vault root, used to resolve the default source directory.\n * @param plugin - The plugin to seed.\n * @param map - The populate map to write into.\n */\nfunction seedPlugin(demoVaultPath: string, plugin: InjectPluginParams, map: PopulateFilesParams): void {\n  const { data, pluginId } = plugin;\n  const sourceDir = plugin.sourceDir ?? join(demoVaultPath, OBSIDIAN_CONFIG_DIR, PLUGINS_DIR, pluginId);\n  const pluginPrefix = `${OBSIDIAN_CONFIG_DIR}/${PLUGINS_DIR}/${pluginId}`;\n\n  const fileNames = existsSync(sourceDir)\n    ? readdirSync(sourceDir, { withFileTypes: true }).filter((entry) => entry.isFile()).map((entry) => entry.name)\n    : [];\n\n  for (const requiredFile of [MAIN_JS, MANIFEST_JSON]) {\n    if (!fileNames.includes(requiredFile)) {\n      throw new Error(\n        `Community plugin \"${pluginId}\" is not installed in the demo vault (${join(sourceDir, requiredFile)} missing). `\n          + 'Open demo-vault/ in Obsidian once so demo-vault-helper installs it, then re-run.'\n      );\n    }\n  }\n\n  for (const fileName of fileNames) {\n    // `data.json` is regenerated from `data` below (when provided); skip the on-disk copy to avoid seeding it twice.\n    if (fileName === DATA_JSON && data !== undefined) {\n      continue;\n    }\n    map[`${pluginPrefix}/${fileName}`] = readFileSync(join(sourceDir, fileName));\n  }\n\n  if (data !== undefined) {\n    const dataJson: string = ensureNonNullable(JSON.stringify(data, null, DATA_JSON_INDENT));\n    map[`${pluginPrefix}/${DATA_JSON}`] = `${dataJson}\\n`;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,qBAIO;AACP,uBAAqB;AAIrB,6BAAkC;AAClC,yBAAkC;AAElC,MAAM,sBAAsB;AAC5B,MAAM,cAAc;AACpB,MAAM,YAAY;AAClB,MAAM,gBAAgB;AACtB,MAAM,UAAU;AAChB,MAAM,mBAAmB;AAEzB,MAAM,gCAAgC,CAAC,YAAY,mBAAmB,mBAAmB;AAkElF,SAAS,uBAAuB,QAA2D;AAChG,QAAM,EAAE,eAAe,eAAe,gBAAgB,CAAC,GAAG,sBAAsB,8BAA8B,IAAI;AAElH,QAAM,UAAM,0CAAkB,kBAAkB,SAAY,EAAE,cAAc,IAAI,EAAE,eAAe,cAAc,CAAC;AAEhH,aAAW,cAAc,qBAAqB;AAC5C,UAAM,iBAAa,uBAAK,eAAe,qBAAqB,UAAU;AACtE,YAAI,2BAAW,UAAU,GAAG;AAC1B,UAAI,GAAG,mBAAmB,IAAI,UAAU,EAAE,QAAI,6BAAa,UAAU;AAAA,IACvE;AAAA,EACF;AAEA,aAAW,UAAU,eAAe;AAClC,eAAW,eAAe,QAAQ,GAAG;AAAA,EACvC;AAEA,SAAO;AACT;AASA,SAAS,WAAW,eAAuB,QAA4B,KAAgC;AACrG,QAAM,EAAE,MAAM,SAAS,IAAI;AAC3B,QAAM,YAAY,OAAO,iBAAa,uBAAK,eAAe,qBAAqB,aAAa,QAAQ;AACpG,QAAM,eAAe,GAAG,mBAAmB,IAAI,WAAW,IAAI,QAAQ;AAEtE,QAAM,gBAAY,2BAAW,SAAS,QAClC,4BAAY,WAAW,EAAE,eAAe,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,MAAM,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,MAAM,IAAI,IAC3G,CAAC;AAEL,aAAW,gBAAgB,CAAC,SAAS,aAAa,GAAG;AACnD,QAAI,CAAC,UAAU,SAAS,YAAY,GAAG;AACrC,YAAM,IAAI;AAAA,QACR,qBAAqB,QAAQ,6CAAyC,uBAAK,WAAW,YAAY,CAAC;AAAA,MAErG;AAAA,IACF;AAAA,EACF;AAEA,aAAW,YAAY,WAAW;AAEhC,QAAI,aAAa,aAAa,SAAS,QAAW;AAChD;AAAA,IACF;AACA,QAAI,GAAG,YAAY,IAAI,QAAQ,EAAE,QAAI,iCAAa,uBAAK,WAAW,QAAQ,CAAC;AAAA,EAC7E;AAEA,MAAI,SAAS,QAAW;AACtB,UAAM,eAAmB,sCAAkB,KAAK,UAAU,MAAM,MAAM,gBAAgB,CAAC;AACvF,QAAI,GAAG,YAAY,IAAI,SAAS,EAAE,IAAI,GAAG,QAAQ;AAAA;AAAA,EACnD;AACF;",
  "names": []
}


package/dist/lib/cjs/demo-vault-populate.d.cts

@@ -0,0 +1,71 @@
+/**
+ * @file
+ *
+ * Builds a complete {@link PopulateFilesParams} map for a plugin's in-repo `demo-vault/`, ready to seed into
+ * the temp vault before Obsidian opens it. Composes {@link readDemoVaultTree} (the note tree) with the two
+ * pieces it deliberately omits: selected `.obsidian/*` config files, and the built binaries (+ `data.json`)
+ * of any extra community plugins the demo vault depends on (e.g. CodeScript Toolkit, `demo-vault-helper`).
+ *
+ * Pairs with the `enableCommunityPlugins` option of the global-setup `createSetup`: this seeds the binaries,
+ * that turns them on. It intentionally does NOT write `community-plugins.json` — the harness owns that file
+ * (it lists the plugin-under-test), and enabling the extras persists them.
+ */
+import type { PopulateFilesParams } from './temp-vault.cjs';
+/**
+ * Parameters for {@link buildDemoVaultPopulate}.
+ */
+export interface BuildDemoVaultPopulateParams {
+    /**
+     * Absolute path to the plugin repo's `demo-vault/` directory.
+     */
+    readonly demoVaultPath: string;
+    /**
+     * Names (of files or directories, matched at any depth) to skip while reading the note tree — forwarded to
+     * {@link readDemoVaultTree}.
+     *
+     * @default `['.git', '.obsidian']`
+     */
+    readonly excludedNames?: Iterable<string>;
+    /**
+     * Community plugins to seed into `.obsidian/plugins/<pluginId>/` (binaries + optional `data.json`). Turn
+     * them on with the global-setup `createSetup({ enableCommunityPlugins })` option.
+     */
+    readonly injectPlugins?: readonly InjectPluginParams[];
+    /**
+     * `.obsidian/*` config files to carry over from the demo vault. {@link 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.
+     *
+     * @default `['app.json', 'appearance.json', 'core-plugins.json']`
+     */
+    readonly obsidianConfigFiles?: readonly string[];
+}
+/**
+ * A community plugin to seed into the demo vault alongside the note tree.
+ */
+export interface InjectPluginParams {
+    /**
+     * Overlay written as `.obsidian/plugins/<pluginId>/data.json` (JSON, 2-space indent). Omit to keep whatever
+     * `data.json` (if any) already lives in {@link InjectPluginParams.sourceDir}.
+     */
+    readonly data?: unknown;
+    /**
+     * The community plugin's id (its `.obsidian/plugins/<pluginId>` folder name).
+     */
+    readonly pluginId: string;
+    /**
+     * Directory to read the plugin's built files from. Every file directly inside it is copied into
+     * `.obsidian/plugins/<pluginId>/`; `main.js` and `manifest.json` are required.
+     *
+     * @default `<demoVaultPath>/.obsidian/plugins/<pluginId>`
+     */
+    readonly sourceDir?: string;
+}
+/**
+ * Builds the full populate map for a plugin's `demo-vault/`: the note tree, the selected `.obsidian/*` config
+ * files, and every injected plugin's binaries (+ optional `data.json`).
+ *
+ * @param params - The {@link BuildDemoVaultPopulateParams}.
+ * @returns The populate map, ready to hand to a global setup's `populate` or {@link TempVault.populate}.
+ */
+export declare function buildDemoVaultPopulate(params: BuildDemoVaultPopulateParams): PopulateFilesParams;

package/dist/lib/cjs/demo-vault-tree.cjs

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var demo_vault_tree_exports = {};
+__export(demo_vault_tree_exports, {
+  readDemoVaultTree: () => readDemoVaultTree
+});
+module.exports = __toCommonJS(demo_vault_tree_exports);
+var import_node_fs = require("node:fs");
+var import_node_path = require("node:path");
+const DEFAULT_EXCLUDED_NAMES = [".git", ".obsidian"];
+function readDemoVaultTree(params) {
+  const { demoVaultPath } = params;
+  const excludedNames = new Set(params.excludedNames ?? DEFAULT_EXCLUDED_NAMES);
+  const map = {};
+  collect(demoVaultPath, demoVaultPath, excludedNames, map);
+  return map;
+}
+function collect(root, dir, excludedNames, map) {
+  for (const entry of (0, import_node_fs.readdirSync)(dir, { withFileTypes: true })) {
+    if (excludedNames.has(entry.name)) {
+      continue;
+    }
+    const absolutePath = (0, import_node_path.join)(dir, entry.name);
+    if (entry.isDirectory()) {
+      collect(root, absolutePath, excludedNames, map);
+      continue;
+    }
+    const relativePath = (0, import_node_path.relative)(root, absolutePath).split(import_node_path.sep).join("/");
+    map[relativePath] = (0, import_node_fs.readFileSync)(absolutePath);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  readDemoVaultTree
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2RlbW8tdmF1bHQtdHJlZS50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFJlYWRzIGEgcGx1Z2luJ3MgaW4tcmVwbyBgZGVtby12YXVsdC9gIHRyZWUgaW50byBhIHBvcHVsYXRlIG1hcCBzbyBhIFZpdGVzdC9KZXN0IGdsb2JhbCBzZXR1cCBjYW5cbiAqIHNlZWQgaXQgaW50byB0aGUgdGVtcCB2YXVsdCBCRUZPUkUgT2JzaWRpYW4gb3BlbnMgaXQuIFNlZWRpbmcgcHJlLWxhdW5jaCBsZXRzIE9ic2lkaWFuJ3Mgc3RhcnR1cCBzY2FuXG4gKiBpbmRleCBldmVyeSBub3RlIGluIG9uZSBwYXNzLCBhdm9pZGluZyB0aGUgZmlsZS13YXRjaGVyIHJhY2UgdGhhdCBzaWxlbnRseSBkcm9wcyBldmVudHMgdW5kZXIgYSBidWxrXG4gKiBwb3N0LWxhdW5jaCB7QGxpbmsgVGVtcFZhdWx0LnBvcHVsYXRlfS5cbiAqL1xuXG5pbXBvcnQge1xuICByZWFkZGlyU3luYyxcbiAgcmVhZEZpbGVTeW5jXG59IGZyb20gJ25vZGU6ZnMnO1xuaW1wb3J0IHtcbiAgam9pbixcbiAgcmVsYXRpdmUsXG4gIHNlcFxufSBmcm9tICdub2RlOnBhdGgnO1xuXG5pbXBvcnQgdHlwZSB7IFBvcHVsYXRlRmlsZXNQYXJhbXMgfSBmcm9tICcuL3RlbXAtdmF1bHQuY2pzJztcblxuLyoqXG4gKiBQYXJhbWV0ZXJzIGZvciB7QGxpbmsgcmVhZERlbW9WYXVsdFRyZWV9LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIFJlYWREZW1vVmF1bHRUcmVlUGFyYW1zIHtcbiAgLyoqXG4gICAqIEFic29sdXRlIHBhdGggdG8gdGhlIGRlbW8gdmF1bHQgZGlyZWN0b3J5IHRvIHJlYWQuXG4gICAqL1xuICByZWFkb25seSBkZW1vVmF1bHRQYXRoOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIE5hbWVzIChvZiBmaWxlcyBvciBkaXJlY3RvcmllcywgbWF0Y2hlZCBhdCBhbnkgZGVwdGgpIHRvIHNraXAuIERlZmF1bHRzIHRvIGAuZ2l0YCBhbmQgYC5vYnNpZGlhbmA6XG4gICAqIHRoZSBoYXJuZXNzIHByb3Zpc2lvbnMgYC5vYnNpZGlhbi9wbHVnaW5zLzxpZD5gIGl0c2VsZiwgc28gdGhlIHZhdWx0J3Mgb3duIGAub2JzaWRpYW5gIG11c3Qgbm90IGJlXG4gICAqIGNvcGllZCBvdmVyIGl0LlxuICAgKlxuICAgKiBAZGVmYXVsdCBgWycuZ2l0JywgJy5vYnNpZGlhbiddYFxuICAgKi9cbiAgcmVhZG9ubHkgZXhjbHVkZWROYW1lcz86IEl0ZXJhYmxlPHN0cmluZz47XG59XG5cbmNvbnN0IERFRkFVTFRfRVhDTFVERURfTkFNRVMgPSBbJy5naXQnLCAnLm9ic2lkaWFuJ107XG5cbi8qKlxuICogUmVhZHMgYSBkZW1vIHZhdWx0IGRpcmVjdG9yeSB0cmVlIHJlY3Vyc2l2ZWx5IGludG8gYSB7QGxpbmsgUG9wdWxhdGVGaWxlc1BhcmFtc30gbWFwICh2YXVsdC1yZWxhdGl2ZVxuICogUE9TSVggcGF0aCB0byBmaWxlIGJ5dGVzKSwgc2tpcHBpbmcge0BsaW5rIFJlYWREZW1vVmF1bHRUcmVlUGFyYW1zLmV4Y2x1ZGVkTmFtZXN9LlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUge0BsaW5rIFJlYWREZW1vVmF1bHRUcmVlUGFyYW1zfS5cbiAqIEByZXR1cm5zIFRoZSBwb3B1bGF0ZSBtYXAsIHJlYWR5IHRvIGhhbmQgdG8ge0BsaW5rIFRlbXBWYXVsdC5wb3B1bGF0ZX0gb3IgYSBnbG9iYWwgc2V0dXAncyBgcG9wdWxhdGVgLlxuICovXG5leHBvcnQgZnVuY3Rpb24gcmVhZERlbW9WYXVsdFRyZWUocGFyYW1zOiBSZWFkRGVtb1ZhdWx0VHJlZVBhcmFtcyk6IFBvcHVsYXRlRmlsZXNQYXJhbXMge1xuICBjb25zdCB7IGRlbW9WYXVsdFBhdGggfSA9IHBhcmFtcztcbiAgY29uc3QgZXhjbHVkZWROYW1lcyA9IG5ldyBTZXQocGFyYW1zLmV4Y2x1ZGVkTmFtZXMgPz8gREVGQVVMVF9FWENMVURFRF9OQU1FUyk7XG4gIGNvbnN0IG1hcDogUG9wdWxhdGVGaWxlc1BhcmFtcyA9IHt9O1xuICBjb2xsZWN0KGRlbW9WYXVsdFBhdGgsIGRlbW9WYXVsdFBhdGgsIGV4Y2x1ZGVkTmFtZXMsIG1hcCk7XG4gIHJldHVybiBtYXA7XG59XG5cbmZ1bmN0aW9uIGNvbGxlY3Qocm9vdDogc3RyaW5nLCBkaXI6IHN0cmluZywgZXhjbHVkZWROYW1lczogU2V0PHN0cmluZz4sIG1hcDogUG9wdWxhdGVGaWxlc1BhcmFtcyk6IHZvaWQge1xuICBmb3IgKGNvbnN0IGVudHJ5IG9mIHJlYWRkaXJTeW5jKGRpciwgeyB3aXRoRmlsZVR5cGVzOiB0cnVlIH0pKSB7XG4gICAgaWYgKGV4Y2x1ZGVkTmFtZXMuaGFzKGVudHJ5Lm5hbWUpKSB7XG4gICAgICBjb250aW51ZTtcbiAgICB9XG5cbiAgICBjb25zdCBhYnNvbHV0ZVBhdGggPSBqb2luKGRpciwgZW50cnkubmFtZSk7XG4gICAgaWYgKGVudHJ5LmlzRGlyZWN0b3J5KCkpIHtcbiAgICAgIGNvbGxlY3Qocm9vdCwgYWJzb2x1dGVQYXRoLCBleGNsdWRlZE5hbWVzLCBtYXApO1xuICAgICAgY29udGludWU7XG4gICAgfVxuXG4gICAgY29uc3QgcmVsYXRpdmVQYXRoID0gcmVsYXRpdmUocm9vdCwgYWJzb2x1dGVQYXRoKS5zcGxpdChzZXApLmpvaW4oJy8nKTtcbiAgICBtYXBbcmVsYXRpdmVQYXRoXSA9IHJlYWRGaWxlU3luYyhhYnNvbHV0ZVBhdGgpO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBU0EscUJBR087QUFDUCx1QkFJTztBQXVCUCxNQUFNLHlCQUF5QixDQUFDLFFBQVEsV0FBVztBQVM1QyxTQUFTLGtCQUFrQixRQUFzRDtBQUN0RixRQUFNLEVBQUUsY0FBYyxJQUFJO0FBQzFCLFFBQU0sZ0JBQWdCLElBQUksSUFBSSxPQUFPLGlCQUFpQixzQkFBc0I7QUFDNUUsUUFBTSxNQUEyQixDQUFDO0FBQ2xDLFVBQVEsZUFBZSxlQUFlLGVBQWUsR0FBRztBQUN4RCxTQUFPO0FBQ1Q7QUFFQSxTQUFTLFFBQVEsTUFBYyxLQUFhLGVBQTRCLEtBQWdDO0FBQ3RHLGFBQVcsYUFBUyw0QkFBWSxLQUFLLEVBQUUsZUFBZSxLQUFLLENBQUMsR0FBRztBQUM3RCxRQUFJLGNBQWMsSUFBSSxNQUFNLElBQUksR0FBRztBQUNqQztBQUFBLElBQ0Y7QUFFQSxVQUFNLG1CQUFlLHVCQUFLLEtBQUssTUFBTSxJQUFJO0FBQ3pDLFFBQUksTUFBTSxZQUFZLEdBQUc7QUFDdkIsY0FBUSxNQUFNLGNBQWMsZUFBZSxHQUFHO0FBQzlDO0FBQUEsSUFDRjtBQUVBLFVBQU0sbUJBQWUsMkJBQVMsTUFBTSxZQUFZLEVBQUUsTUFBTSxvQkFBRyxFQUFFLEtBQUssR0FBRztBQUNyRSxRQUFJLFlBQVksUUFBSSw2QkFBYSxZQUFZO0FBQUEsRUFDL0M7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/demo-vault-tree.d.cts

@@ -0,0 +1,34 @@
+/**
+ * @file
+ *
+ * Reads a plugin's in-repo `demo-vault/` tree into a populate map so a Vitest/Jest global setup can
+ * seed it into the temp vault BEFORE Obsidian opens it. Seeding pre-launch lets Obsidian's startup scan
+ * index every note in one pass, avoiding the file-watcher race that silently drops events under a bulk
+ * post-launch {@link TempVault.populate}.
+ */
+import type { PopulateFilesParams } from './temp-vault.cjs';
+/**
+ * Parameters for {@link readDemoVaultTree}.
+ */
+export interface ReadDemoVaultTreeParams {
+    /**
+     * Absolute path to the demo vault directory to read.
+     */
+    readonly demoVaultPath: string;
+    /**
+     * Names (of files or directories, matched at any depth) to skip. Defaults to `.git` and `.obsidian`:
+     * the harness provisions `.obsidian/plugins/<id>` itself, so the vault's own `.obsidian` must not be
+     * copied over it.
+     *
+     * @default `['.git', '.obsidian']`
+     */
+    readonly excludedNames?: Iterable<string>;
+}
+/**
+ * Reads a demo vault directory tree recursively into a {@link PopulateFilesParams} map (vault-relative
+ * POSIX path to file bytes), skipping {@link ReadDemoVaultTreeParams.excludedNames}.
+ *
+ * @param params - The {@link ReadDemoVaultTreeParams}.
+ * @returns The populate map, ready to hand to {@link TempVault.populate} or a global setup's `populate`.
+ */
+export declare function readDemoVaultTree(params: ReadDemoVaultTreeParams): PopulateFilesParams;