Skip to content

Commit

Permalink
Add Sorbet troubleshooting note (#2871)
Browse files Browse the repository at this point in the history
  • Loading branch information
andyw8 authored Nov 18, 2024
1 parent 592495e commit adf28bd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions jekyll/troubleshooting.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ that prevents it from responding to new requests coming from the editor. If you
report [here](https://github.com/Shopify/ruby-lsp/issues/new?labels=bug&template=bug_template.yml) including the
steps that led to the server getting stuck.

### Missing Features

If you find that some features are working (such as formatting), but others aren't (such as go to definition),
and are working on a codebase that uses Sorbet, then this may indicate the
[Sorbet LSP isn't running](https://sorbet.org/docs/lsp#instructions-for-specific-language-clients).
To avoid duplicate/conflicting behavior, Ruby LSP disables some features when a Sorbet codebase is detected, with the
intention that Sorbet can provide better accuracy.

### Gem installation locations and permissions

To launch the Ruby LSP server, the `ruby-lsp` gem must be installed. And in order to automatically index your project's
Expand Down

0 comments on commit adf28bd

Please sign in to comment.