VS Code Shopify Ruby

This extension pack contains an opinionated collection of pre-configured extensions for Ruby development in VS Code:

• Ruby LSP
• VSCode rdbg Ruby Debugger
• Ruby Sorbet

Note that the Sorbet extension will only be activated if your project is onboarded to the Sorbet type checker. Also, the Ruby LSP extension includes a debugger for common debugging use-cases. You may need to use the Ruby Debugger extension for certain scenarios.

Note

This extension does not implement any Ruby related features. It's just a pack containing other extensions, which are the ones that deliver the features. If you encounter Sorbet related issues, please report them in https://github.com/sorbet/sorbet If you are using RDBG to debug and encounter issues, please report them in https://github.com/ruby/vscode-rdbg For other Ruby development issues, please report them in https://github.com/Shopify/vscode-ruby-lsp

Usage

Search for Shopify.ruby-extensions-pack in the extensions tab and click install.

When activated, this extension will prompt you about overriding your existing configuration to use the recommended defaults. You may want to backup your settings.json file before trying this extension out.

The recommended settings and their respective values can be found in the extension configuration file.

Commands

The commands offered to help manage the recommended settings are:

"Ruby extension pack: Force apply defaults" -> Apply all defaults
"Ruby extension pack: Clear cache and recommended settings" -> Clear all cached choices and remove the recommended settings

Themes

Included in this extension is the Spinel dark theme, which is made specifically for Ruby using all of the semantic highlighting information provided by the Ruby LSP.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/vscode-shopify-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Executing tests

1. Open VS Code on this repo
2. Make sure dependencies are installed (yarn install)
3. On VS Code's run and debug tab, select the Extension tests task
4. Click the run button or press F5 to run tests. Output is displayed in the debug console

Testing the extension locally

1. Open VS Code on this repo
2. Make sure dependencies are installed (yarn install)
3. On VS Code's run and debug tab, select the Extension task
4. This will open a second VS Code window where the development version of the extension is running. Use it to verify that the extension is working as expected
5. If needed, the cache and recommended settings can be cleared by running the Ruby extension pack: Clear cache and recommended settings command. This will make the extension prompt overrides again

Debugging

To debug the extension, add breakpoints using the VS Code interface and either run the tests or the extension in development mode.

License

The extension is available as open source under the terms of the MIT License.