Fill "How to add automated tests to your plugin" page #754

s-blu · 2025-01-13T11:09:13Z

Edited

Hello,

I created a guide how to integrate jest to the obsidian example plugin and how to deal with the obsidian API when running code in a test environment to fill in the stub page "How to add automated tests to your plugin".

I tested the guide via a Windows Sandbox but would very appreciate if somebody else undertakes the steps to make sure that it's working as expected.

I was unsure what to do with https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/Guides/How+to+test+plugin+code+that+uses+Obsidian+APIs and if I should update it, as well. I'd love your input here. "Issue 13" of the obsidian API is not available anymore and the links under "Other people's suggestions" are not reachable. However, I am not quite aware if the guide now provide enough guidance to remove the section altogether or what's the best course of action is.

If you have pointers to improve reading flow or wording, it'd be very appreciated. Furthermore I have no experience with Obsidian Publish and do not know if I should have avoided any kind of syntax - I only controlled the look and feel in Obsidian itself.
Also, since this is my first contribution, I hope it was correct to change the tag to "evergreen".

Regards

Added

Checklist

before creating a new note, I searched the vault
new notes have the .md extension
(if applicable) attached images have descriptive file names
(if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

…raction explanation

mProjectsCode

Thanks for the PR. I have marked some things I noticed while reading through it.

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

mProjectsCode · 2025-01-13T16:02:20Z

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

+
+```ts
+// myplugin.ts
+import { Notice } from "obsidian";


Maybe use explicit import type { Notice } from "obsidian"; notation. Adding "verbatimModuleSyntax": true, to the TS config is a good idea anyways.

You have a point, but I still would like to keep it this way. If one uses a obsidian dependency, i.e. Notice, VSC creates an auto-import like this. While a type import would be cleaner, it is not necessary to use them to get the tests running and I'd like to only use and mention mandatory steps to keep the complexity lower.

That is fair. Though without explicit type imports, you are at the mercy of whatever the TS transpiler in this setup does.

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

link obsidian example plugin github repository

mProjectsCode

Noticed a few more small things, mostly with the code examples around inconsistent code style.

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

s-blu · 2025-01-14T18:31:07Z

Noticed a few more small things, mostly with the code examples around inconsistent code style.

Sorry for that, I should have invested 5 minutes to configure prettier in the example plugin after all .. :) If I might ask you to have a look again? Thanks for your time!

mProjectsCode

Almost there XD

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

mProjectsCode

LGTM

s-blu · 2025-01-19T16:08:23Z

@claremacrae Hello Clare, sorry for pinging you directly. I hope it does not bother you. If your time allows I'd be grateful if you could have a look if it's feasible to merge this PR - I'd like to clean up https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/Guides/How+to+test+plugin+code+that+uses+Obsidian+APIs as a follow up PR as soon as this one is merged. Thanks alot for your time!

claremacrae

Brilliant work - thank you very much indeed!

claremacrae · 2025-01-20T23:33:51Z

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md

+// example.spec.ts
+describe('MyPlugin Tests', () => {
+
+  it('should be able to execute test', () => {


I will go ahead and merge, but looking at this file in PyCharm, these are among several that have NBSP characters rather than ordinary spaces...

It probably won't matter in the published docs though.

I'll take a note to check and fix it in my follow up PR, thanks for pointing it out :)

claremacrae · 2025-01-20T23:35:42Z

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md


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

 # This note in GitHub

-<span class="git-footer">[Edit In GitHub](https://github.dev/obsidian-community/obsidian-hub/blob/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/Guides/How%20to%20add%20automated%20tests%20to%20your%20plugin.md "git-hub-edit-note") | [Copy this note](https://raw.githubusercontent.com/obsidian-community/obsidian-hub/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/Guides/How%20to%20add%20automated%20tests%20to%20your%20plugin.md "git-hub-copy-note") | [Download this vault](https://github.com/obsidian-community/obsidian-hub/archive/refs/heads/main.zip "git-hub-download-vault") </span>
+<span class="git-footer">[Edit In GitHub](https://github.dev/Obsidian-community/Obsidian-hub/blob/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/Guides/How%20to%20add%20automated%20tests%20to%20your%20plugin.md "git-hub-edit-note") | [Copy this note](https://raw.githubusercontent.com/Obsidian-community/Obsidian-hub/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/Guides/How%20to%20add%20automated%20tests%20to%20your%20plugin.md "git-hub-copy-note") | [Download this vault](https://github.com/Obsidian-community/Obsidian-hub/archive/refs/heads/main.zip "git-hub-download-vault") </span>


It's curious that the casing has changed here but the links still work, and will get overwritten on the next weekly automated update, so it's not a problem.

That's my fault, sorry for it. I did a find & replace on obsidian to capitalize that - I thought I reverted the changes in the footer but seemingly I did not. Good to know it'll heal itself!

claremacrae · 2025-01-20T23:37:17Z

And thank you very much @mProjectsCode for the thorough reviews too!

s-blu added 3 commits January 13, 2025 12:03

Replace stub for adding tests with a guide for jest

cec3d78

Detail limitations of testing without any obsidian dependency

d02f774

reduce intendation of code example; add some more context to last ext…

4b999ca

…raction explanation

mProjectsCode reviewed Jan 13, 2025

View reviewed changes

s-blu added 2 commits January 13, 2025 21:09

capitalize jest and obsidian, add semicolons to code examples

03a0bd0

link obsidian example plugin github repository

Add empty lines before headings, improve wordings as suggested in PR

043f6e5

s-blu requested a review from mProjectsCode January 13, 2025 21:03

enhance wording, add hint for indirect imports

da7ca22

mProjectsCode reviewed Jan 14, 2025

View reviewed changes

s-blu requested a review from mProjectsCode January 14, 2025 18:31

use spaces over tabs in code examples, add missing semicolons

20a5436

mProjectsCode reviewed Jan 14, 2025

View reviewed changes

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md Outdated Show resolved Hide resolved

04 - Guides, Workflows, & Courses/Guides/How to add automated tests to your plugin.md Outdated Show resolved Hide resolved

correct block intendation

1eb2916

mProjectsCode approved these changes Jan 14, 2025

View reviewed changes

claremacrae approved these changes Jan 20, 2025

View reviewed changes

claremacrae merged commit d05812a into obsidian-community:main Jan 20, 2025
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fill "How to add automated tests to your plugin" page #754

Fill "How to add automated tests to your plugin" page #754

s-blu commented Jan 13, 2025 •

edited

Loading

mProjectsCode left a comment

mProjectsCode Jan 13, 2025

s-blu Jan 13, 2025

mProjectsCode Jan 13, 2025

mProjectsCode left a comment

s-blu commented Jan 14, 2025

mProjectsCode left a comment

mProjectsCode left a comment

s-blu commented Jan 19, 2025

claremacrae left a comment

claremacrae Jan 20, 2025

s-blu Jan 21, 2025

claremacrae Jan 20, 2025

s-blu Jan 21, 2025

claremacrae commented Jan 20, 2025

Fill "How to add automated tests to your plugin" page #754

Fill "How to add automated tests to your plugin" page #754

Conversation

s-blu commented Jan 13, 2025 • edited Loading

Edited

Added

Checklist

mProjectsCode left a comment

Choose a reason for hiding this comment

mProjectsCode Jan 13, 2025

Choose a reason for hiding this comment

s-blu Jan 13, 2025

Choose a reason for hiding this comment

mProjectsCode Jan 13, 2025

Choose a reason for hiding this comment

mProjectsCode left a comment

Choose a reason for hiding this comment

s-blu commented Jan 14, 2025

mProjectsCode left a comment

Choose a reason for hiding this comment

mProjectsCode left a comment

Choose a reason for hiding this comment

s-blu commented Jan 19, 2025

claremacrae left a comment

Choose a reason for hiding this comment

claremacrae Jan 20, 2025

Choose a reason for hiding this comment

s-blu Jan 21, 2025

Choose a reason for hiding this comment

claremacrae Jan 20, 2025

Choose a reason for hiding this comment

s-blu Jan 21, 2025

Choose a reason for hiding this comment

claremacrae commented Jan 20, 2025

s-blu commented Jan 13, 2025 •

edited

Loading