Ruby::Lsp::Ree

Ree addon for Ruby LSP

How to use it:

  1. Install Ruby LSP for your editor link
  2. Add ree gem into the Gemfile and run bundle install. Ruby LSP will detect the addon and run it.

If everything was installed successfully, you should see Ree in the list of Ruby LSP addons.
(In VS Code click {} brackets in the bottom right corner)

Formatter

To use ree_formatter, add the following line into your settings.json file (e.g. .vscode/settings.json)

"rubyLsp.formatter": "ree_formatter"

To use diagnostics, add the following line into your settings.json file (e.g. .vscode/settings.json)

"rubyLsp.linters": ["ree_formatter"]

To switch off/on formatter features, use Ruby LSP addon settings:

"rubyLsp.addonSettings": {
    "Ree Addon": {
      "formatter": {
        "MissingErrorLocalesFormatter": false
      }
    }
  }

available formatters: SortLinksFormatter, MissingErrorDefinitionsFormatter, MissingErrorContractsFormatter, MissingErrorLocalesFormatter, UnusedLinksFormatter, MissingImportsFormatter, ImportPackagesFormatter, SyncDaoColumnsFormatter

Functions

  • autocomplete for Ree objects
  • autocomplete for constants
  • adds links to the links section on autocomplete
  • sort links on document save or format (with ree_formatter enabled)
  • missing error locales detection
  • Go To Definition for Ree objects
  • hover information for Ree objects and error locales
  • Ree templates support
  • add missing import links on save