Skip to content

Commit 138172c

Browse files
committed
docs: add info on metadata dumping
1 parent 3ebd730 commit 138172c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,11 @@ This document describes how to make a code contribution to the repo.
5555
- There are no unit tests for UI
5656
- This is because svelte-testing-library is not very good, and js-dom is not a good fit for testing things like drag-and-drop.
5757
- There are no E2E tests
58-
- There is no easy way to write E2E tests for an Obsidian plugin, so we don't do those.
58+
- There is no easy way to write E2E tests for an Obsidian plugin, so we don't do those.
59+
- `fixtures/` contains ICAL, markdown files & metadata on these files for integration tests. This allows us to use real Obsidian & Dataview to produce metadata on these files instead of writing it all by hand. You can update corresponding Dataview fixtures manually:
60+
1. Build the plugin in dev mode
61+
2. Copy `fixture-vault` into an Obsidian vault: `cp fixture-vault <obsidian>`. If you cloned the project into a test vault, just run: `cp -r fixtures/fixture-vault/ ../../../fixtures/`
62+
3. Open your Obsidian test vault and run the command: `Dump metadata`
5963

6064
### UI, Svelte guidelines
6165

0 commit comments

Comments
 (0)