Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Shopify/vscode-shopify-ruby
An opinionated and auto-configured set of extensions for Ruby development
https://github.com/Shopify/vscode-shopify-ruby
Last synced: 3 months ago
JSON representation
An opinionated and auto-configured set of extensions for Ruby development
- Host: GitHub
- URL: https://github.com/Shopify/vscode-shopify-ruby
- Owner: Shopify
- License: mit
- Created: 2022-03-02T19:18:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T14:23:33.000Z (3 months ago)
- Last Synced: 2024-08-05T16:40:42.640Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.79 MB
- Stars: 174
- Watchers: 244
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# VS Code Shopify Ruby
This extension pack contains an opinionated collection of extensions for Ruby development in VS Code:
- [Ruby LSP](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)
- [VSCode rdbg Ruby Debugger](https://marketplace.visualstudio.com/items?itemName=koichisasada.vscode-rdbg)
- [Ruby Sorbet](https://marketplace.visualstudio.com/items?itemName=sorbet.sorbet-vscode-extension)
Note that the Sorbet extension will only be activated if your project is onboarded to the [Sorbet type checker](https://sorbet.org/). 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`](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-extensions-pack) in
the extensions tab and click install.
### 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](https://github.com/Shopify/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](https://github.com/Shopify/vscode-shopify-ruby/blob/main/CODE_OF_CONDUCT.md)
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](https://github.com/Shopify/vscode-shopify-ruby/blob/main/LICENSE.txt).