Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add link to test-plugin suggestions #733

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add link to test-plugin suggestions #733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions ... Workflows, & Courses/Guides/How to test plugin code that uses Obsidian APIs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ This technique is demonstrated in the talk [[Plugin Testing for Developers]].

There are some useful discussions and links in the Obsidian API issue [Error running tests #13](https://github.com/obsidianmd/obsidian-api/issues/13).

- Test frameworks that have attempted to help with testing Obsidian plugins:
- [trashhalo/obsidian-plugin-e2e-test](https://github.com/trashhalo/obsidian-plugin-e2e-test): a sample repo with obsidian plugin e2e tests [suggested by](https://github.com/obsidianmd/obsidian-api/issues/13#issuecomment-880504457) `@lishid`
- [[obsimian-exporter]]: an Obsidian simulation framework for testing Obsidian plugins [suggested by](https://github.com/obsidianmd/obsidian-api/issues/13#issuecomment-880504457) `@lishid`
- [obsidian-community/jest-environment-obsidian](https://github.com/obsidian-community/jest-environment-obsidian) A Jest environment to facilitate unit testing for Obsidian plugins
- These are many months old, and may not be being maintained

- In [this comment](https://github.com/obsidianmd/obsidian-api/issues/13#issuecomment-819035670) [[renehernandez]] describes abstracting the usage of the filesystem capabilities from obsidian through an internal interface and depending on that interface instead of FileSystemAdapter directly. That way they can introduce a fake object during test to verify the logic they wanted in the FileDoc object.
- In [this comment](https://github.com/obsidianmd/obsidian-api/issues/13#issuecomment-880504457) `@lishid` lists some test frameworks that have attempted to help with testing Obsidian plugins:
- [trashhalo/obsidian-plugin-e2e-test](https://github.com/trashhalo/obsidian-plugin-e2e-test): a sample repo with obsidian plugin e2e tests
- [[obsimian-exporter#Obsimian Exporter]]: an Obsidian simulation framework for testing Obsidian plugins
- These are both many months old, and may not be being maintained
- In [this comment](https://github.com/obsidianmd/obsidian-api/issues/13#issuecomment-1003880942) [[timhor]] reported that If anyone just needs to test editor-related functionality, he has had success substituting [CodeMirror](https://codemirror.net/doc/manual.html) as the editor on which his tests run (that's what Obsidian uses under the hood anyway). There are links showing how he did this.

%% Hub footer: Please don't edit anything below this line %%
Expand Down