zed-industries/zed
1
1
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-09-18 18:08:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update Ruby docs (#12283)

Browse Source 
This PR updates the Ruby docs with a note on how to switch to using
`ruby-lsp`.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-05-25 10:50:54 -04:00 committed by GitHub
parent 5213f6207d
commit 66e40a5d7e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/src/languages/ruby.md
View File

@ -3,7 +3,25 @@
- Tree Sitter: [tree-sitter-ruby](https://github.com/tree-sitter/tree-sitter-ruby)
- Language Servers: [solargraph](https://github.com/castwide/solargraph), [ruby-lsp](https://github.com/Shopify/ruby-lsp)
### Setting up `solargraph`
## Choosing a language server
The Ruby extension offers both `solargraph` and `ruby-lsp` language server support.
`solargraph` is enabled by default.
To switch to `ruby-lsp`, add the following to your `settings.json`:
```json
{
"languages": {
"Ruby": {
"language_servers": ["ruby-lsp", "..."]
}
}
}
```
## Setting up `solargraph`
Zed currently doesn't install Solargraph automatically. To use Solargraph, you need to install the gem. Zed just looks for an executable called `solargraph` on your `PATH`.
@ -38,7 +56,7 @@ Solargraph has formatting and diagnostics disabled by default. We can tell Zed t
Solargraph reads its configuration from a file called `.solargraph.yml` in the root of your project. For more information about this file, see the [Solargraph configuration documentation](https://solargraph.org/guides/configuration).
### Setting up `ruby-lsp`
## Setting up `ruby-lsp`
Zed currently doesn't install Ruby LSP automatically. To use Ruby LSP, you need to install the gem. Zed just looks for an executable called `ruby-lsp` on your `PATH`.