Obsidian Debug

Debug Loop

Drive the running Obsidian app through obsidian to verify plugin changes against real rendered state. The DOM is the source of truth.

Vault setup, once per worktree

1. Run obsidian version. If the command is missing, follow the official Obsidian CLI installation guide, then restart the terminal. Use the registered obsidian command on every platform.
2. Run packages/scripts/scripts/obsidian-vault.ts --help.
3. Before you use a vault command, read its <command> --help output.
4. Run packages/scripts/scripts/obsidian-vault.ts check. Vault setup is complete when the command succeeds. Follow its recovery instructions when it fails.
5. Build the plugin, then use the live open command to prepare this worktree's Development Vault:

pnpm --filter @zotlit/obsidian build:dev

Editing the Fixture Spec or its committed vault-page assets changes the next Fixture build, not the open Development Vault. Use the live open command before you look for those changes. Use the live remove command when you tear the vault down.

Commands

The CLI always exits 0. Read the output text: => prefixes a result, and failures come back as Error: … or Vault not found.

Loop

1. Build — pnpm --filter @zotlit/obsidian build:dev copies the bundle into this worktree's Development Vault.
2. Reload — obsidian vault=<id> plugin:reload id=zotlit.
3. Open — obsidian command id=zotlit:<cmd>, or eval to mount a view in a specific split.
4. Probe — obsidian eval code='…' with getComputedStyle(el) / el.getBoundingClientRect() to assert what actually rendered. A computed-style assertion is worth more than eyeballing a screenshot, and it is the only way to catch a state that expires on its own — a flash class is gone by the time the capture lands.
5. Screenshot — obsidian dev:screenshot path=<absolute-path>. Save inside the workspace.
6. Errors — obsidian dev:errors / obsidian dev:console.

Driving state

Values change through code, and DOM ops check how the UI looks and behaves.

setControlValue runs the same SettingsService path the rendered control does and persists to the plugin's data.json; getControlValue reads the effective value back. Read the value first and put it back when you are done.

Gotchas

Settings land in their own window

app.setting.open() renders into a separate Electron window by default since 1.13.4, and eval, dev:dom, and dev:screenshot all address the main one — so settings read as never opened. Run /obsidian-settings → "Verifying on screen" for the config that brings the modal back into the main window, and for reaching the separate window when its own chrome is the thing under test.

No await in eval

Code runs in a non-async wrapper — top-level await is a syntax error. Fire the promise and verify in a follow-up eval, or grab references synchronously. Hold the leaf from getLeaf(...) and revealLeaf(it) in the same call rather than re-querying getLeavesOfType(...) after an async setViewState (races, returns []).

Stale screenshots

A capture taken right after reload or revealLeaf may show old DOM while the change is already live. Cross-check against an eval DOM/computed-style query — if they disagree, the DOM query wins. Re-shoot. A DevTools window open over Obsidian can also steal the capture — close it first.

Confirm which vault answered

An untargeted command goes to the focused window, which may belong to another worktree. Pass vault=<id>, and confirm with eval code='app.vault.adapter.basePath' — it must print the Development Vault path reported by obsidian-vault.ts --help for the worktree you build from. data.json edits target that same path.

Occluded window

When document.visibilityState === "hidden", scroll events don't dispatch and the compositor stops repainting — scroll-driven UI (e.g. TanStack Virtual) looks frozen and screenshots return stale frames. Drive scrolling with el.scrollTop = x; el.dispatchEvent(new Event("scroll")) and assert via DOM queries.

Full-scale Fixture data

Build a Stress Build with pnpm fixture stress. Read the current Device Override before you change it:

obsidian vault=<id> eval \
  code='app.plugins.plugins.zotlit.services.zoteroPref.dataDirOverride'

Point the live plugin at the absolute tmp/acceptance-fixture/zotero-data path:

obsidian vault=<id> eval \
  code='app.plugins.plugins.zotlit.services.zoteroPref.setDataDir("<absolute path>")'

Afterwards, call setDataDir again with the previous value, or null when it was empty. This restores the vault-scoped Device Override and reconnects the database service.