Skip to content

Commit d2d5b2a

Browse files
committed
Add callout on editors section of website about Mason risks
When using Mason to manage Ruby LSP, unless only a single Ruby version is used, there are chances of strange errors due to conflicts of the Ruby ABI. For anything other than the simplest of deployments, Mason should likely not be used to manage the Ruby LSP or any Ruby IDE tooling.
1 parent 0eaaee1 commit d2d5b2a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

jekyll/editors.markdown

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,16 @@ mason_lspconfig.setup_handlers {
169169
}
170170
```
171171

172+
{: .important }
173+
> Using Mason to manage your installation of the Ruby LSP may cause errors
174+
175+
Mason installs the Ruby LSP in a folder shared among all your Rubies. Some of the
176+
Ruby LSP dependencies are C extensions, and they rely on the Ruby ABI to look and
177+
act a certain way when they were linked to Ruby. This causes issues when a shared
178+
folder is used.
179+
180+
See [this issue][mason-abi] for further information.
181+
172182
### Additional setup (optional)
173183

174184
`rubyLsp/workspace/dependencies` is a custom method currently supported only in the VS Code plugin.
@@ -293,3 +303,6 @@ To use it with Ruby LSP, you can override particular configuration items in the
293303
Kate will start an instance of the Ruby LSP server in the background for any Ruby project matching the `rootIndicationFileNames`.
294304
If starting Ruby LSP succeeds, the entries in the LSP-Client menu are activated.
295305
Otherwise the error output can be inspected in the Output window.
306+
307+
308+
[mason-abi]: https://github.com/williamboman/mason.nvim/issues/1292

0 commit comments

Comments
 (0)