Fork me on GitHub

SpaceVim

A community-driven vim distribution


Home | About | Documentation | Development | Community | Sponsors


Blogs » Use Vim as a Ruby IDE

This is a general guide for using SpaceVim as a Ruby IDE, including layer configuration and usage. Each of the following sections will be covered:

Enable language layer

To add Ruby language support in SpaceVim, you need to enable the lang#ruby layer. Press SPC f v d to open SpaceVim configuration file, and add the following snippet:

[[layers]]
  name = "lang#ruby"

For more info, you can read the lang#ruby layer documentation.

Code completion

lang#ruby layer will load the Ruby plugin automatically, unless it’s overriden in your init.toml. The completion menu will be opened as you type.

rubycomplete

Syntax linting

The checkers layer is enabled by default. This layer provides asynchronous syntax linting via neomake. It will run rubocop asynchronously.

Install rubocop via gem:

gem install rubocop

rubylint

Jump to test file

SpaceVim use built-in plugin to manager the files in a project, you can add a .project_alt.json to the root of your project with the following content:

{
  "src/*.rb": {"alternate": "test/{}.rb"},
  "test/*.rb": {"alternate": "src/{}.rb"}
}

With this configuration, you can jump between the source code and test file via command :A

running code

To run current script, you can press SPC l r, and a split window will be openen, the output of the script will be shown in this window. It is running asynchronously, and will not block your Vim.

rubyrunner

Code formatting

The format layer is also enabled by default. With this layer you can use key binding SPC b f to format current buffer. Before using this feature, please install rufo:

gem install rufo

formatruby

REPL support

Start a irb inferior REPL process with SPC l s i. After the REPL process being started, you can send code to inferior process. All key bindings prefix with SPC l s, including sending line, sending selection or even send whole buffer.

rubyrepl

Hosted on GitHub, Help improve this page — Theme by mattgraham,