Skip to content

Commit

Permalink
Add kate to editors list
Browse files Browse the repository at this point in the history
This adds some notes, how to setup the kate editor with ruby-lsp.

Co-authored-by: Andy Waite <github.aw@andywaite.com>
Co-authored-by: Stan Lo <stan001212@gmail.com>
  • Loading branch information
3 people committed Aug 2, 2024
1 parent 8bf0c50 commit 9b78aa2
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions EDITORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ new H2 header in this file containing the instructions. -->
- [Sublime Text LSP](#sublime-text-lsp)
- [Zed](#zed)
- [RubyMine](#RubyMine)
- [Kate](#Kate)

## Emacs Eglot

Expand Down Expand Up @@ -185,6 +186,26 @@ Note that there might be overlapping functionality when using it with RubyMine,

[Ruby LSP plugin](https://plugins.jetbrains.com/plugin/24413-ruby-lsp)

## Kate

[The LSP Client Plugin](https://docs.kde.org/stable5/en/kate/kate/kate-application-plugin-lspclient.html) for Kate is configured by default to use Solargraph for Ruby.
To use it with Ruby LSP, you can override particular configuration items in the "User Server Settings" in the LSP Client plugin as shown below:

```json
{
"servers": {
"ruby": {
"command": ["ruby-lsp"],
"url": "https://github.com/Shopify/ruby-lsp"
}
}
}
```

Kate will start an instance of the Ruby LSP server in the background for any Ruby project matching the `rootIndicationFileNames`.
If starting Ruby LSP succeeds, the entries in the LSP-Client menu are activated.
Otherwise the error output can be inspected in the Output window.

# Indexing Configuration

To configure indexing, pass a JSON hash as part of the initialization options for your editor, for example:
Expand Down

0 comments on commit 9b78aa2

Please sign in to comment.