An open API service indexing awesome lists of open source software.

https://github.com/zed-extensions/harper

Harper LS extension for the Zed editor
https://github.com/zed-extensions/harper

extension harper spellcheck zed

Last synced: 5 months ago
JSON representation

Harper LS extension for the Zed editor

Awesome Lists containing this project

README

          

# Harper Zed Extension

Zed extension for the
[Harper Grammar Checker](https://github.com/Automattic/harper) LS.

![Harper running inside zed](./images/zed_demo.png)

## Supported platforms

| Platform | X86_64 | ARM64 |
|---|---|---|
| Linux | ✅ | ✅ |
| MacOS | ✅ | ✅ |
| Windows | ✅ | ❌ |

## Install

1. [Open the Extension Gallery](https://zed.dev/docs/extensions/installing-extensions)
2. Search for `harper` in the Gallery
3. Click "Install"!

![Harper in the Zed Extension Gallery](./images/extension_in_gallery.png)

## Configuration

To disable specific rules, add following to `Zed/settings.json`.

```
"lsp: {
"harper-ls": {
"settings": {
"harper-ls": {
"linters": {
// "RuleName": false, // For rule names consult tooltips and https://writewithharper.com/docs/rules
},
},
},
},
}
```

To have a project-specific dictionary, create `.harper-dictionary.txt` in the project root or configure dictionary location by passing `"userDictPath": "%relative_path%",` inside `"settings": {"harper-ls": {...}}`. The dictionary should be a simple line-separated text file.

For additional info consult [Harper LS configuration page](https://writewithharper.com/docs/integrations/language-server#Configuration).

## Acknowledgments

- [elijah-potter](https://github.com/elijah-potter) for creating Harper
- [WeetHet](https://github.com/WeetHet) for their
[typst LS extension](https://github.com/WeetHet/typst.zed) which was used as
inspiration for this repository :)