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

Automattic · Dec 24, 2024 · d70908a · d70908a
1 parent c6d4b5d
commit d70908a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -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