-
Notifications
You must be signed in to change notification settings - Fork 128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add outdated version info to troubleshooting guide #2060
base: main
Are you sure you want to change the base?
Conversation
ff05304
to
83d5878
Compare
6339750
to
5ae2b6d
Compare
5ae2b6d
to
fdf122c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't have to be on this PR, but it might be good to add a table of contents on this page; the content is getting pretty big and it's not that easy to skim.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is under Diagnosing the problem
; would it make sense to move it to under Common issues
?
Co-authored-by: Dirceu Pereira Tiegs <[email protected]>
Co-authored-by: Dirceu Pereira Tiegs <[email protected]>
**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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
Co-authored-by: Vinicius Stock <[email protected]>
Partially addresses #1945