Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat(vscode-plugin): add docs for `harper-ls.path` setting

Matthew Espinod70908a0aa34
diff --git a/packages/vscode-plugin/CHANGELOG.md b/packages/vscode-plugin/CHANGELOG.md
index e973ae8f6..02e1b73e4 100644
--- a/packages/vscode-plugin/CHANGELOG.md
+++ b/packages/vscode-plugin/CHANGELOG.md
@@ -4,6 +4,7 @@
- Linting Python, Shellscript/Bash, and Git Commit files now work properly.
- Add support for Nix and Plaintext files.
+- Add the `harper-ls.path` setting to optionally use a different `harper-ls` executable.
## 0.12.0
diff --git a/packages/vscode-plugin/README.md b/packages/vscode-plugin/README.md
index 95701db8a..8cdb55af0 100644
--- a/packages/vscode-plugin/README.md
+++ b/packages/vscode-plugin/README.md
@@ -20,10 +20,11 @@ If you use OpenVSX, for instance if you use VSCodium, you'll want to install fro
### Settings
-| Setting | Possible Values | Default Value | Description |
-| ------------------------------ | ------------------------------------------------- | --------------- | ----------------------------------------------------------------- |
-| `harper-ls.linters.*` | `true`, `false` | Varies | Detect and provide suggestions in a variety of common situations. |
-| `harper-ls.diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"information"` | How severe do you want diagnostics to appear in the editor? |
+| Setting | Type | Default Value | Description |
+| ------------------------------ | ------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `harper-ls.path` | `string` | `""` | Optional path to a `harper-ls` executable to use. Primarily useful if the bundled binary doesn't work in your system like in immutable Linux distributions. |
+| `harper-ls.linters.*` | `boolean` | Varies | Detect and provide suggestions in a variety of common situations. |
+| `harper-ls.diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"information"` | How severe do you want diagnostics to appear in the editor? |
## Developing and Contributing