SpaceVim/docs/_posts/2019-02-18-use-vim-as-a-ruby-ide.md

---
title: "Use Vim as a Ruby IDE"
categories: [tutorials, blog]
image: https://img.spacevim.org/53355518-20202080-3964-11e9-92f3-476060f2761e.png
description: "A general guide for using SpaceVim as Ruby IDE, including layer configuration, requiems installation and usage."
type: article
comments: true
commentsID: "Use Vim as a Ruby IDE"
language: Ruby
---

# [Blogs](../blog/) >> 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:


<!-- vim-markdown-toc GFM -->

- [Enable language layer](#enable-language-layer)
- [Code completion](#code-completion)
  - [Solargraph](#solargraph)
- [Syntax linting](#syntax-linting)
- [Jump to test file](#jump-to-test-file)
- [running code](#running-code)
- [Code formatting](#code-formatting)
- [REPL support](#repl-support)

<!-- vim-markdown-toc -->

### 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:

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

For more info, you can read the [lang#ruby](../layers/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](https://img.spacevim.org/53355518-20202080-3964-11e9-92f3-476060f2761e.png)

#### Solargraph

If you want to use solargraph for a more advance code completion, you can do it through [coc]("https://github.com/neoclide/coc.nvim"). For use `coc`
like your autocompletion engine, you must set the next variable:

```
[options]
autocomplete_method = "coc"
```

Be sure to have solargraph installed:

```
gem install solargraph
```

Then install [coc-solargraph](https://github.com/neoclide/coc-solargraph) extension for `coc` to support solargraph with the next command:

```
:CocInstall coc-solargraph
```


### Syntax linting

The checkers layer is enabled by default. This layer provides asynchronous syntax linting via [neomake](https://github.com/neomake/neomake).
It will run rubocop asynchronously.

Install rubocop via gem:

```sh
gem install rubocop
```

![rubylint](https://img.spacevim.org/53347011-32459300-3953-11e9-9ca2-3e07f832db5a.png)

### 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:

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

For a Rails project with Minitest use this:

```json
{
  "app/*.rb": {"alternate": "test/{}_test.rb"},
  "test/*_test.rb": {"alternate": "app/{}.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](https://img.spacevim.org/53300165-6b600380-387e-11e9-852f-f8766300ece1.gif)

### 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:

```sh
gem install rufo
```

![formatruby](https://img.spacevim.org/53301042-3c02c400-3889-11e9-9918-430ad6a7f08f.gif)

### 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](https://img.spacevim.org/53347455-1098db80-3954-11e9-87c3-13a027ec88f6.gif)