Shopify / Shopify/ruby-lsp

`Document `bypassTypechecker` for contributors, and enable automatically where possible

Open
#2,856 2 comments 0 reactions 1 assignee View on GitHub

@andyw8 is already working on this.

Since Jan 15, 2025.

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

Description

In normal use, when working on a codebase that uses Sorbet, Ruby LSP will defer to Sorbet's LSP for some features.

But when working on the Ruby LSP itself, we want to 'dogfood' it as we develop, so we avoid using Sorbet in the editor.

To override Ruby LSP's default behaviour, we have a bypassTypechecker setting. However, if this is not enabled, it can make it appear that some features are 'broken' when working on Ruby LSP itself. This is a confusing barrier for new contributors.

Instead, for VS Code users, we can detect if the Sorbet LSP extension is active, and automatically set bypassTypechecker.

For contributors using other editors, we should clearly document this setting.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.