harper-ls

harper-ls is the Language Server Protocol frontend for Harper. Out of the box, it has built-in support for parsing the comments of most programming languages, as well as any and all markdown files.

Installation

Binary releases are coming soon, so if you are looking for a single file download, you'll have to wait.

However, if you happen to have Rust installed, you're in luck! To install harper-ls, the variant of Harper for text editors like Neovim, simply run:

cargo install harper-ls

Neovim Setup

Right now we only support using nvim-lspconfig to run Harper in Neovim. Refer to the documentation for more information.

Dictionaries

harper-ls has three kinds of dictionaries: user, file-local, and static dictionaries.

User Dictionary

Each user of harper-ls has their own dictionary, located in the following directories on each operating system:

This dictionary is a simple word list in plain-text. You can add and remove words at will. You can add to the user dictionary with code actions on misspelled words.

File-Local Dictionary

Sometimes, you'll encounter a word (or name) that is only valid within the context of a specific file. In this case, you can use the code action that adds the word to the file-local dictionary. Any words added to this dictionary will, like the name implies, only be included in the dictionary when performing corrections on the file at that specific path.

You can find the file-local dictionaries in the following directories on each operation system:

The format of these files is identical to user dictionaries.

Static Dictionary

The static dictionary is built into the binary and is (as of now) immutable. It contains almost all words you could possibly encounter.

I do take pull requests or issues for adding words to the static dictionary. It is composed of two files: harper-core/dictionary.dict and harper-core/dictionary.dict