Ruby

info

You can enable the extra with the :LazyExtras command. Plugins marked as optional will only be configured if they are installed.

Alternatively, you can add it to your lazy.nvim imports

lua/config/lazy.lua

require("lazy").setup({
  spec = {
    { "LazyVim/LazyVim", import = "lazyvim.plugins" },
    { import = "lazyvim.plugins.extras.lang.ruby" },
    { import = "plugins" },
  },
})

Options

Additional options for this extra can be configured in your lua/config/options.lua file:

lua/config/options.lua

-- LSP Server to use for Ruby.
-- Set to "solargraph" to use solargraph instead of ruby_lsp.
vim.g.lazyvim_ruby_lsp = "ruby_lsp"
vim.g.lazyvim_ruby_formatter = "rubocop"

Below you can find a list of included plugins and their default settings.

caution

You don't need to copy the default settings to your config. They are only shown here for reference.

nvim-treesitter

Options

opts = { ensure_installed = { "ruby" } }

Full Spec

{
  "nvim-treesitter/nvim-treesitter",
  opts = { ensure_installed = { "ruby" } },
}

nvim-lspconfig

Options

opts = {
  ---@type lspconfig.options
  servers = {
    ruby_lsp = {
      enabled = lsp == "ruby_lsp",
    },
    solargraph = {
      enabled = lsp == "solargraph",
    },
    rubocop = {
      -- If Solargraph and Rubocop are both enabled as an LSP,
      -- diagnostics will be duplicated because Solargraph
      -- already calls Rubocop if it is installed
      enabled = formatter == "rubocop" and lsp ~= "solargraph",
    },
    standardrb = {
      enabled = formatter == "standardrb",
    },
  },
}

Full Spec

{
  "neovim/nvim-lspconfig",
  ---@class PluginLspOpts
  opts = {
    ---@type lspconfig.options
    servers = {
      ruby_lsp = {
        enabled = lsp == "ruby_lsp",
      },
      solargraph = {
        enabled = lsp == "solargraph",
      },
      rubocop = {
        -- If Solargraph and Rubocop are both enabled as an LSP,
        -- diagnostics will be duplicated because Solargraph
        -- already calls Rubocop if it is installed
        enabled = formatter == "rubocop" and lsp ~= "solargraph",
      },
      standardrb = {
        enabled = formatter == "standardrb",
      },
    },
  },
}

mason.nvim

Options

opts = { ensure_installed = { "erb-formatter", "erb-lint" } }

Full Spec

{
  "williamboman/mason.nvim",
  opts = { ensure_installed = { "erb-formatter", "erb-lint" } },
}

nvim-dap-ruby

Options

opts = {}

Full Spec

{
  "suketa/nvim-dap-ruby",
  config = function()
    require("dap-ruby").setup()
  end,
}

neotest-rspec

Options

opts = nil

Full Spec

{
  "olimorris/neotest-rspec",
}

nvim-dap (optional)

Options

opts = nil

Full Spec

{
  "mfussenegger/nvim-dap",
  optional = true,
  dependencies = {
    "suketa/nvim-dap-ruby",
    config = function()
      require("dap-ruby").setup()
    end,
  },
}

conform.nvim (optional)

Options

opts = {
  formatters_by_ft = {
    ruby = { formatter },
    eruby = { "erb_format" },
  },
}

Full Spec

{
  "stevearc/conform.nvim",
  optional = true,
  opts = {
    formatters_by_ft = {
      ruby = { formatter },
      eruby = { "erb_format" },
    },
  },
}

neotest (optional)

Options

opts = {
  adapters = {
    ["neotest-rspec"] = {
      -- NOTE: By default neotest-rspec uses the system wide rspec gem instead of the one through bundler
      -- rspec_cmd = function()
      --   return vim.tbl_flatten({
      --     "bundle",
      --     "exec",
      --     "rspec",
      --   })
      -- end,
    },
  },
}

Full Spec

{
  "nvim-neotest/neotest",
  optional = true,
  dependencies = {
    "olimorris/neotest-rspec",
  },
  opts = {
    adapters = {
      ["neotest-rspec"] = {
        -- NOTE: By default neotest-rspec uses the system wide rspec gem instead of the one through bundler
        -- rspec_cmd = function()
        --   return vim.tbl_flatten({
        --     "bundle",
        --     "exec",
        --     "rspec",
        --   })
        -- end,
      },
    },
  },
}