https://github.com/shopify/ruby-lsp

An opinionated language server for Ruby
https://github.com/shopify/ruby-lsp

lsp lsp-server ruby vscode-extension

Last synced: 1 day ago
JSON representation

An opinionated language server for Ruby

• Host: GitHub
• URL: https://github.com/shopify/ruby-lsp
• Owner: Shopify
• License: mit
• Created: 2022-02-25T19:13:56.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-30T02:36:53.000Z (12 days ago)
• Last Synced: 2025-01-02T15:00:26.962Z (8 days ago)
• Topics: lsp, lsp-server, ruby, vscode-extension
• Language: Ruby
• Homepage: https://shopify.github.io/ruby-lsp/
• Size: 49.9 MB
• Stars: 1,642
• Watchers: 251
• Forks: 172
• Open Issues: 146
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  



[![Build Status](https://github.com/Shopify/ruby-lsp/workflows/CI/badge.svg)](https://github.com/Shopify/ruby-lsp/actions/workflows/ci.yml)

[![Ruby LSP extension](https://img.shields.io/badge/VS%20Code-Ruby%20LSP-success?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)

[![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)

# 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://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q).

## 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).