Skip to content

Obsidian sidebar - #3915

Open
LukeBenhase wants to merge 3 commits into
Automattic:masterfrom
LukeBenhase:obsidianSidebar
Open

Obsidian sidebar#3915
LukeBenhase wants to merge 3 commits into
Automattic:masterfrom
LukeBenhase:obsidianSidebar

Conversation

@LukeBenhase

@LukeBenhase LukeBenhase commented Jul 29, 2026

Copy link
Copy Markdown

Issues

none

Description

I added a sidebar for Obsidian. The sidebar will show all of the improvements that Harper finds in the active page. You can open this sidebar with the command line in Obsidian under "Harper: Open Harper spellcheck sidebar". This will open the sidebar showing all of the errors. This sidebar was inspired by how Grammarly will allow the user to see all of their errors in a list, and it makes correcting errors much faster. The sidebar also brings in the 3 words before and after the mistake so that it is easier to see the correct word from the sidebar. A picture is below.

Demo

sidebar

How Has This Been Tested?

I tested my changes on my Linux computer by compiling them into main.js and running it in Obsidian. It runs good and I have a screenshot above.

AI Disclosure

I am human and used AI outside of my editor and did not use any agents. I used Google Gemini to understand some parts of Obsidian.

If Your PR Implements or Enhances a Linter

I did not change the linter.

Checklist

  • I have performed a self-review of my own code
  • I have added tests to cover my changes
  • I have considered splitting this into smaller pull requests.

@hippietrail hippietrail added obsidian-plugin Related to the Harper Obsidian integration enhancement New feature or request labels Jul 30, 2026
@elijah-potter

elijah-potter commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Oooh! I like this a lot!

I'm going to do a quick review of the code, compile this on my own machine, and come back with comments (if I have any).

@elijah-potter elijah-potter left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Definitely in the top 5% of PRs I receive. Thank you.

I have a few nits and bits, but once those are addressed, we can get this merged.

Comment thread packages/obsidian-plugin/src/SidebarView.ts Outdated
return;
}

errors.forEach((error) => {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would help readability to refactor this callback out into a separate function.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, I really like the UI you've designed.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I'm not the most creative at UI design, so I tried to keep the style and colours of the pop-up that Harper uses.

Comment thread packages/obsidian-plugin/src/SidebarView.ts Outdated
Comment thread packages/obsidian-plugin/src/index.ts Outdated
Comment thread packages/obsidian-plugin/src/SidebarView.ts Outdated
Comment thread packages/obsidian-plugin/src/lint.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request obsidian-plugin Related to the Harper Obsidian integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants