1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
<p align="center">
<img alt="Ruby LSP logo" width="200" src="vscode/icon.png" />
</p>
[](https://github.com/Shopify/ruby-lsp/actions/workflows/ci.yml)
[](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)
[](https://shopify.github.io/ruby-lsp/invite)
# Ruby LSP
The Ruby LSP is an implementation of the [language server protocol](https://microsoft.github.io/language-server-protocol/)
for Ruby, used to improve rich features in editors. It is a part of a wider goal to provide a state-of-the-art
experience to Ruby developers using modern standards for cross-editor features, documentation and debugging.
Want to discuss Ruby developer experience? Consider joining the public
[Ruby DX Slack workspace](https://shopify.github.io/ruby-lsp/invite).
## Getting Started
For VS Code users, you can start by installing the [Ruby LSP extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp) from the VS Code marketplace.
For other editors, please refer to the [EDITORS](https://shopify.github.io/ruby-lsp/editors.html) guide.
To learn more about Ruby LSP, please refer to the official [documentation](https://shopify.github.io/ruby-lsp) for [supported features](https://shopify.github.io/ruby-lsp#features).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp. 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.md) code of conduct.
If you wish to contribute, see [Contributing](https://shopify.github.io/ruby-lsp/contributing.html) for development instructions and check out our
[Design and roadmap](https://shopify.github.io/ruby-lsp/design-and-roadmap.html) for a list of tasks to get started.
## License
The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
|
