Ruby Sorbet for VS Code

Features

This extension provides language-aware IDE features for Ruby projects that use Sorbet. It includes features like the following:

• Diagnostics (errors) that update as you type
• Hover tooltips, to show types and documentation
• Go to Definition/Find All References support
• Autocompletion
• Code Actions for refactoring
• Quick Fixes for errors

For a full list of features, see the "Editor Features" section of the Sorbet docs.

Documentation

This extension only works in projects that have adopted Sorbet. For instructions, see here:

• https://sorbet.org/docs/adopting

The docs for the Sorbet extension for VS Code live here:

• https://sorbet.org/docs/vscode

The Sorbet extension for VS Code is powered by the language server protocol (LSP). Sorbet's support for LSP is documented here:

• https://sorbet.org/docs/lsp

Developing on this Extension

See docs/lsp-dev-guide.md for information on how to get started with LSP and VS Code extension development.

Sorbet Extension API

Starting from version 0.3.41, Sorbet exports a public API. You can access it using VS Code's getExtension API. To ensure backward and forward compatibility, all properties are nullable.

• status: Represents the Sorbet status, or undefined if the state is unknown.
• onStatusChanged: An event triggered whenever the status changes.

Available Status Values

The following are string values:

• disabled: Indicates that the Sorbet Language Server has been disabled.
• error: Indicates that the Sorbet Language Server encountered an error. This status does not correlate to code typing errors.
• running: Indicates that the Sorbet Language Server is running.
• start: Indicates that the Sorbet Language Server is starting. This status may repeat in case of an error.