├── .gitignore ├── screenshot.webp ├── manifest.json ├── justfile ├── .github └── workflows │ └── build.yml ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | main.js 2 | harper 3 | harper-obsidian-plugin.zip 4 | -------------------------------------------------------------------------------- /screenshot.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Automattic/harper-obsidian-plugin/HEAD/screenshot.webp -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "harper", 3 | "name": "Harper", 4 | "version": "1.2.0", 5 | "minAppVersion": "1.7.7", 6 | "description": "The Grammar Checker for Developers", 7 | "author": "Elijah Potter", 8 | "authorUrl": "https://elijahpotter.dev", 9 | "isDesktopOnly": false 10 | } 11 | -------------------------------------------------------------------------------- /justfile: -------------------------------------------------------------------------------- 1 | clean: 2 | rm -rf harper 3 | 4 | # Pull and checkout the source code for the plugin version specified in `manifest.json` 5 | pull-source: 6 | #! /bin/bash 7 | set -eo pipefail 8 | 9 | just clean 10 | 11 | version=v`cat manifest.json | jq -r '.version'` 12 | 13 | echo Pulling version $version 14 | 15 | git clone https://github.com/elijah-potter/harper 16 | cd harper 17 | git checkout tags/$version 18 | 19 | # Build the plugin, assuming the source has already been downloaded 20 | build: 21 | cd harper && just build-obsidian 22 | cp harper/packages/obsidian-plugin/main.js . 23 | zip harper-obsidian-plugin.zip main.js manifest.json 24 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | tags: 6 | - "*" 7 | 8 | env: 9 | CARGO_TERM_COLOR: always 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: 20 20 | - name: Enable Corepack 21 | run: corepack enable 22 | - name: Install Rust Nightly 23 | run: rustup toolchain install nightly && rustup component add rustfmt --toolchain nightly 24 | - uses: extractions/setup-just@v1 25 | - name: Install `pandoc` 26 | run: sudo apt-get update && sudo apt-get install pandoc -y 27 | - name: Install `wasm-pack` 28 | run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh 29 | - name: Checkout Harper 30 | run: just pull-source 31 | - name: Build 32 | run: just build 33 | - name: Upload Artifact 34 | uses: actions/upload-artifact@v4 35 | with: 36 | name: harper-obsidian-plugin.zip 37 | path: harper-obsidian-plugin.zip 38 | - uses: ncipollo/release-action@v1 39 | with: 40 | artifacts: harper/packages/obsidian-plugin/main.js,manifest.json 41 | allowUpdates: true 42 | draft: true 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `harper-obsidian-plugin` 2 | 3 | ![Downloads](https://img.shields.io/github/downloads/automattic/harper-obsidian-plugin/total) 4 | 5 | Put simply, [Harper](https://writewithharper.com/) is a grammar checking plugin that doesn't violate your privacy. 6 | Other systems, like LanguageTool, ship your writing over the internet to centralized servers, where it's used for god-knows-what. 7 | Harper isn't like that. 8 | 9 | Instead, Harper runs its grammar checking engine directly _inside Obsidian_. 10 | That means your data doesn't go anywhere you don't want it to. 11 | Your Obsidian vault should be just what you expect: locked down and private. 12 | 13 | ![A screenshot of Obsidian with Harper installed](./screenshot.webp) 14 | 15 | Unlike other offerings (like Grammarly) Harper also explicitly ignores the contents of code fences and inline code blocks. 16 | Since it runs entirely on-device, Harper also ends up being noticeably faster than alternatives, partly because there is no network latency. 17 | 18 | ### Open Source 19 | 20 | - Harper is fully open source, allowing transparency and community contributions to improve its functionality. 21 | - Developers can review the codebase or contribute directly via the [GitHub repository](https://github.com/automattic/harper). 22 | 23 | ## How It Compares to Other Plugins 24 | 25 | | Feature | Harper | LanguageTool | 26 | | ---------------------- | ----------------------------- | --------------------------------- | 27 | | **Privacy** | 100% offline | Requires self-hosting for privacy | 28 | | **Real-Time Checking** | Yes | Yes | 29 | | **Language Support** | English (extensible) | 30+ languages | 30 | | **Open Source** | Yes | Partially | 31 | | **Ease of Use** | Simple setup | Requires API/self-hosting setup | 32 | | **Performance** | Fast and lightweight | Resource-intensive | 33 | 34 | ## Installation Guide 35 | 36 | 1. Open Obsidian and navigate to **Settings → Community Plugins → Browse**. 37 | 2. Search for "Harper" in the plugin library. 38 | 3. Click "Install" and then "Enable." 39 | 4. Start typing in your notes—Harper will automatically highlight errors as you go! 40 | 41 | > **Warning** 42 | > Harper expects an up-to-date version of the Obsidian installer. If you have issues, [reinstall Obsidian](https://obsidian.md/download) or otherwise update your installer version. 43 | 44 | ## Where's all the code? 45 | 46 | All the code for the Harper Obsidian plugin lives [in the main Harper monorepo](https://github.com/automattic/harper/tree/master/packages/obsidian-plugin). 47 | This repository exists to satisfy the [requirements](https://docs.obsidian.md/Plugins/Releasing/Submit+your+plugin) laid out by the Obsidian team for their plugins. 48 | 49 | ## I have a problem or feature request... 50 | 51 | Let me know if you have any problems, feature requests, or feedback of any kind by filling out an [issue on the main repository](https://github.com/automattic/harper/issues/new). 52 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2024 Elijah Potter 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------