Shopify / Shopify/ruby-lsp

Conditionally provide hints/definitions on typed files.

Open
#2,294 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement pinned
Dominant language
Ruby
Stars
2k
Forks
281
Avg merge
2h 14m
Merged PRs (30d)
6

Description

I have checked that this feature is not already implemented
  • This feature does not exist
Use case

Our ruby codebase uses sorbet types in some of it'sfiles (lots of typed: false still hanging around). So devs like to have both ruby-lsp and the sorbet lsp running, one for the typed files and one for untyped files.

This works well for the untyped files as sorbet tends not display signature helpers/definitions etc. But once we are in the realm of typed: true, both ruby-lsp and sorbet will try do similar things. So sometimes both of the LSP's will provide similar information/details.

Description

I think that it would be great if the ruby lsp were to integrate a little tighter with the sorbet LSP. We could give users control of which typed files are worth displaying hints on. I'm thinking a setting that allows users to toggle whether we want ruby-lsp to be suggesting on typed: {true|strict} files.

Implementation

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the ruby-lsp handling of typed Ruby files and its user settings, then compare how Sorbet LSP provides hints and definitions. Define the setting behavior for typed: true and typed: strict files and confirm the expected interaction between both language servers before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.