Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:30:04 +08:00
Code Issues Projects Releases Wiki Activity
cf5bb3a9ea
SpaceVim/docs/layers/lang/ruby.md
Joseph DelCioppio 23e48dc47e Improve Ruby language layer to accept custom REPL 
Taking a cue from the Lua language layer, update the Ruby language layer
to support specify a custom REPL. This command expects a valid path to
an executable, so a file path would be required if the executable is not
on your $PATH.
2018-09-21 23:11:51 -04:00

2.1 KiB
Raw Blame History

title description
SpaceVim lang#ruby layer This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file.

Available Layers >> lang#ruby

Description

This layer is for ruby development.

Install

Layer

To use this configuration layer, update custom configuration file with:

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

Syntax checking && Code formatting

To enable syntax checking and code formatting in spacevim, you need to install rubocop.

gem install rubocop

Key bindings

Inferior REPL process

Start a irb inferior REPL process with SPC l s i. You may change the REPL command by layer option repl_command. For example, if you want to use pry, load this layer via:

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

however, if the executable is not on your $PATH, then you need to specify a complete file path.

[[layers]]
    name = "lang#ruby"
    repl_command = "/NOT/IN/YOUR/PATH/rubocop"

Send code to inferior process commands:

Key Binding Description
SPC l s b send buffer and keep code buffer focused
SPC l s l send line and keep code buffer focused
SPC l s s send selection text and keep code buffer focused

RuboCop

Key Binding Description
SPC l c f Runs RuboCop on the currently visited file

Running current script

To running a ruby script, you can press SPC l r to run current file without loss focus, and the result will be shown in a runner buffer.