Add outdated version info to troubleshooting guide #2060
Conversation
andyw8
force-pushed
the
andyw8/add-outdated-version-troubleshooting-notes
branch
3 times, most recently
from
ff05304
to
83d5878
Compare
andyw8
force-pushed
the
andyw8/add-outdated-version-troubleshooting-notes
branch
2 times, most recently
from
6339750
to
5ae2b6d
Compare
andyw8
force-pushed
the
andyw8/add-outdated-version-troubleshooting-notes
branch
from
5ae2b6d
to
fdf122c
Compare
TROUBLESHOOTING.md
Outdated
| @@ -160,6 +160,36 @@ ruby-lsp | |||
| Is there any extra information given from booting the server manually? Or does it only fail when booting through the | |||
| extension? | |||
|
|
|||
| ### Outdated Version | |||
There was a problem hiding this comment.
This is under Diagnosing the problem; would it make sense to move it to under Common issues?
Co-authored-by: Dirceu Pereira Tiegs <dirceutiegs@gmail.com>
Co-authored-by: Dirceu Pereira Tiegs <dirceutiegs@gmail.com>
andyw8
added
documentation
| **How to solve it** | ||
|
|
||
| You can add a dependency constraint to your Gemfile limiting the Prism version to that maximum supported by Ruby LSP. | ||
| For example: | ||
|
|
||
| ``` | ||
| gem "prism", "< 0.28" # example for Ruby LSP v0.16.6 | ||
| ``` |
There was a problem hiding this comment.
I'm not sure we want to tell folks to pin their Prism version. Once Prism v1 is out, we will relax our constraints and the issue will be greatly mitigated. Then how do we tell everybody to remove this from their gemfiles?
There was a problem hiding this comment.
I know it's not ideal. But in that time between a Prism release and the update to Ruby LSP, it's a lousy experience for developers.
One way to mitigate this could be align with Kevin so that when the next Prism release is ready, we verify it and pre-emptively bump the constraint a day or two before the actual Prism release.
There was a problem hiding this comment.
That might be a smoother option. Also, my understanding is that Prism is almost there with the v1.0.0, so this problem might be resolved very soon.
There was a problem hiding this comment.
The next release is going to be v1.0.0, so I'll let you know before it goes out and we can test it.
Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>
Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>
Partially addresses #1945