From e4e50548768f6de0e2cdb49b66c496a9f8197489 Mon Sep 17 00:00:00 2001 From: Matthew Lyon Date: Wed, 9 Oct 2024 16:19:57 -0700 Subject: [PATCH] Add instructions for configuring Sublime Text --- docs/manual.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/manual.md b/docs/manual.md index ecee8aa..759fc03 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -50,6 +50,24 @@ require("mason-lspconfig").setup { } ``` +### Sublime Text +prerequisites: You have installed the [fennel-ls binary](#fennel-ls-language-server-binary) and the [LSP Sublime Text package](https://packagecontrol.io/packages/LSP) from Package Control. + +You can configure the LSP plugin to use fennel-ls directly by editing your `Packages/User/LSP.sublime-settings` file, which can be opened via "Preferences > Package Settings > LSP > Settings" from the menu or with the Preferences: LSP Settings command from the Command Palette. + +You should add an entry to the top-level `"clients"` object (creating it if it doesn't exist), with this configuration: +```json +"clients": { + "fennel-ls": { + "enabled": true, + "selector": "source.fennel", + "command": ["fennel-ls"] + } +} +``` + +If you run into problems, check the [LSP Client Configuration reference](https://lsp.sublimetext.io/client_configuration/) and double-check the location of fennel-ls on the $PATH is visible to Sublime Text. + ### Other editors It should be possible to set up for other text editors, but the instructions depend on which editor you use. Generally you need to tell your editor: