Skip to content
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

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

Open
andyw8 opened this issue Nov 14, 2024 · 1 comment
Assignees
Labels
pinned This issue or pull request is pinned and won't be marked as stale

Comments

@andyw8
Copy link
Contributor

andyw8 commented Nov 14, 2024

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.

@andyw8 andyw8 changed the title Document bypassTypechecker" for contributors Document bypassTypechecker` for contributors Nov 14, 2024
@andyw8 andyw8 changed the title Document bypassTypechecker` for contributors Document bypassTypechecker` for contributors, and enable automatically where possible Nov 15, 2024
Copy link
Contributor

This issue is being marked as stale because there was no activity in the last 2 months

@github-actions github-actions bot added the Stale label Jan 15, 2025
@andyw8 andyw8 added pinned This issue or pull request is pinned and won't be marked as stale and removed Stale labels Jan 15, 2025
@andyw8 andyw8 self-assigned this Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pinned This issue or pull request is pinned and won't be marked as stale
Projects
None yet
Development

No branches or pull requests

1 participant