Ruby Language + Extension Protocol

Ruby Language + Extension Protocol

A new-class Language and Extension Protocol for Ruby. Enhance your editor with smart completion, rich diagnostics, real-time formatting, intuitive navigation, and modern Rails tooling — all powered by a robust Ruby protocol server.

Key Features

• Advanced semantic highlighting
• Symbol search & outline
• RuboCop errors and live diagnostics
• Format on save or type (RuboCop, Syntax Tree)
• Test runner and UI-integrated debugging
• Navigate to definitions & references
• Instant documentation on hover
• Completion and Fuzzy search for workspace symbols
• Rails generator UI runner

Full feature overview

Installation & Usage

• Install the Extension: Search for Shopify.ruby-lsp in your editor's extensions panel.
• Discover Commands: Look for commands prefixed with Ruby LSP in your command palette (CMD/CTRL + SHIFT + P).
• Configuration: Setup version managers, formatters, and debugging support in your settings. The server automatically detects your Ruby environment with auto mode, but supports advanced manual overrides.

Show Example Commands

Command	Description
Ruby LSP: Start	Start the server
Ruby LSP: Restart	Restart the server
Ruby LSP: Stop	Stop the server
Ruby LSP: Update language server gem	Upgrade to the latest server gem

Configuration & Customization

• Version Managers: Automatic or manual chruby, rbenv, rvm, asdf, mise, shadowenv.
• Formatters: Auto-detects rubocop or syntax_tree in your bundle, or set explicitly.
• Snippets & code templates: For blocks, classes, methods, tests, and more (full list in the repository).
• Multi-root support: Launches one server for every workspace, supporting heterogeneous Ruby setups.
• Debugging: Works with VS Code Debugger for tests, apps, and Rails servers (see docs for launch.json config).

Experimental: Copilot AI Integration

Ruby LSP ships with a Copilot Chat agent that leverages LLMs for guided design, Rails schema suggestions, and interactive model generation commands. Use @ruby /design in chat to ask for expert suggestions, iterate, and even auto-generate Rails models directly. AI feedback is iterative and may require refinements.

Questions or feedback? Join our community or open an issue on GitHub.

Resources

• GitHub Repository
• VS Code Marketplace
• Official Docs & FAQ

Tip: Enable Shopify.ruby-lsp as your default formatter for seamless on-save and on-type formatting.

Made with ❤️ for the Ruby community.