Ruby Lsp Reek

Adds Reek as a linter for Ruby LSP

Installation

Add this line to your application's Gemfile:

gem 'ruby-lsp-reek'

And then execute:

$ bundle

Requires Ruby 3.0 or newer.

Note: Using globally installed linters in Ruby LSP is not supported, they must be in your Gemfile or gemspec.

Usage

Add reek to the list of linters in your Ruby LSP configuration.

Example: VS Code

In settings.json:

"rubyLsp.linters": [ "rubocop", "reek" ]

After that, open the VS code command palette and select the option Developer: Reload Window.

Example: LazyVim:

Update your nvim-lspconfig as follows:

  {
    "neovim/nvim-lspconfig",
    opts = {
      servers = {
        ruby_lsp = {
          init_options = {
            linters = { "rubocop", "reek" },
          },
        },
      },
    },
  },

See the Ruby LSP Editor docs for more information on how to configure other editors.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake test to run the tests, and bundle exec rake code_analysis to run standardrb and reek over the codebase. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in lib/ruby_lsp/reek/version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org. Pushing the tag triggers the release workflow, which creates the matching GitHub release.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the ruby-lsp-reek project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.