1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 03:00:06 +08:00
SpaceVim/docs/layers/lang/ruby.md

82 lines
2.2 KiB
Markdown
Raw Normal View History

2017-08-31 06:11:34 +08:00
---
title: "SpaceVim lang#ruby layer"
2019-02-03 20:51:01 +08:00
description: "This layer is for Ruby development, provide autocompletion, syntax checking, code format for Ruby file."
2017-08-31 06:11:34 +08:00
---
2018-06-23 14:37:41 +08:00
# [Available Layers](../../) >> lang#ruby
2017-08-31 06:11:34 +08:00
<!-- vim-markdown-toc GFM -->
2017-12-12 09:59:27 +08:00
- [Description](#description)
2018-06-23 14:37:41 +08:00
- [Install](#install)
2017-12-12 15:05:41 +08:00
- [Layer](#layer)
- [Syntax checking && Code formatting](#syntax-checking--code-formatting)
2017-12-12 09:59:27 +08:00
- [Key bindings](#key-bindings)
2017-12-12 15:05:41 +08:00
- [Inferior REPL process](#inferior-repl-process)
- [RuboCop](#rubocop)
- [Running current script](#running-current-script)
2017-08-31 06:11:34 +08:00
<!-- vim-markdown-toc -->
## Description
2019-02-03 20:51:01 +08:00
This layer is for Ruby development.
2017-08-31 06:11:34 +08:00
2018-06-23 14:37:41 +08:00
## Install
2017-12-12 15:05:41 +08:00
### Layer
2017-08-31 06:11:34 +08:00
2018-06-23 14:37:41 +08:00
To use this configuration layer, update custom configuration file with:
```toml
[[layers]]
name = "lang#ruby"
```
2017-08-31 06:11:34 +08:00
2017-12-12 15:05:41 +08:00
### Syntax checking && Code formatting
2018-05-12 01:35:58 +08:00
To enable syntax checking and code formatting in spacevim, you need to install [rubocop](https://github.com/bbatsov/rubocop).
2017-12-12 15:05:41 +08:00
```sh
gem install rubocop
```
2017-08-31 06:11:34 +08:00
## Key bindings
2017-12-12 15:05:41 +08:00
### 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:
2017-12-12 15:05:41 +08:00
```toml
[[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.
```toml
[[layers]]
name = "lang#ruby"
repl_command = "/NOT/IN/YOUR/PATH/rubocop"
```
2017-12-12 15:05:41 +08:00
Send code to inferior process commands:
2019-02-03 20:51:01 +08:00
| Key Bindings | Descriptions |
| ------------ | ------------------------------------------------ |
| `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 |
2017-12-12 15:05:41 +08:00
### RuboCop
2019-02-03 20:51:01 +08:00
| Key Bindings | Descriptions |
| ------------ | ------------------------------------------ |
| `SPC l c f` | Runs RuboCop on the currently visited file |
2017-12-12 15:05:41 +08:00
### Running current script
2019-02-03 20:51:01 +08:00
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.