CONTRIBUTING¶ ↑

Bug reports and pull requests are welcome on GitHub at github.com/Shopify/ruby-lsp-rails. 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.

Developing on Ruby LSP¶ ↑

For general information about developing, refer to the to the documentation for Ruby LSP itself.

Manually testing a change¶ ↑

The repo includes a dummy Rails app in test/dummy. If you’re developing a feature, you can add new code to it for testing.

To test with a real Rails application, you can add a Gemfile entry for ruby-lsp-rails and point it to your local checkout:

gem "ruby-lsp-rails", path: "../ruby-lsp-rails"

Or to a branch in your fork:

gem "ruby-lsp-rails", github: "USERNAME/ruby-lsp-rails", branch: "your_branch"

Running the test suite¶ ↑

To set up the database for the dummy Rails app, and run the full test suite:

bundle exec rake

Tests are written as ActiveSupport::TestCase tests, so an individual test can be run with:

bin/rails test test/my_test.rb