SpaceVim

A community-driven vim distribution


主页 | 关于我们 | 使用文档 | 开发指南 | 用户社区 | 赞助


Blogs » 使用 Vim 搭建 Ruby 开发环境

SpaceVim 是一个模块化的 Vim IDE,针对 Ruby 这一语言的支持主要依靠 lang#ruby 模块以及与之相关的其它模块。 的这篇文章主要介绍如何使用 SpaceVim 搭建 Ruby 的开发环境,侧重介绍跟 Ruby 开发相关使用技巧。 在阅读这篇文章之前,可以先阅读《使用 Vim 搭建基础的开发环境》,对语言相关以外的功能有一个大致的了解。

安装模块

SpaceVim 初次安装时默认并未启用相关语言模块。首先需要启用 lang#ruby 模块,通过快捷键 SPC f v d 打开配置文件,添加如下片断:

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

启用 lang#ruby 模块后,在打开 Ruby 文件时,就可以使用语言专属快捷键,这些快捷键都是以 SPC l 为前缀的。

代码自动补全

autocomplete 模块为 SpaceVim 提供了自动补全功能,目前针对 Ruby 而言,比较好的补全方案是配合使用 lsp 模块:

[[layers]]
  name = "lsp"

lsp 模块默认使用 ["solargraph", "stdio"] 作为 Ruby 的语言服务器后台命令,首先需要安装 solargraph:

gem install solargraph

在配置文件中添加如下内容即可为 ruby 启用语言服务器:

[[layers]]
  name = "lsp"
  filetypes = [
    "ruby"
  ]
  [layers.override_cmd]
    ruby = ["solargraph",  "stdio"]

语法检查

checkers 模块为 SpaceVim 提供了语法检查的功能,该模块默认已经载入。该模块默认使用 neomake 这一异步语法检查工具。对于 Ruby 的支持,是通过异步调用 rubocop 命令来完成的。

使用 gem 安装 rubocop 命令:

gem install rubocop

rubylint

工程文件跳转

SpaceVim 自带工程管理插件,可以识别项目根目录,自动跳转 alternate 文件。需要在项目根目录添加工程文件 .project_alt.json

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

通过以上的配置,就可以使用命令 :A 在源文件和测试文件之间进行跳转。

快速运行

在编辑 Ruby 文件时,可以快速运行当前文件,这个功能有点类似于 vscode 的 code runner 插件,默认的快捷键是 SPC l r 。按下后, 会在屏幕下方打开一个插件窗口,运行的结果会被展示在窗口内。于此同时,光标并不会跳到该插件窗口,避免影响编辑。在这里需要说明下, 这一功能是根据当前 buffer 内容调用 Ruby 命令。因此,在执行这个快捷键之前,不一定要保存该文件。

rubyrunner

代码格式化

Ruby 代码格式化,主要依赖 format 模块,同时需要安装相关的后台命令 rufo,默认快捷键为 SPC b f

[[layers]]
  name = "format"

使用 gem 安装 rufo:

gem install rufo

formatruby

交互式编程

在编辑 Ruby 文件时,可通过快捷键 SPC l s i 启动 irb 交互窗口, 之后使用快捷键将代码发送至解释器。默认快捷键都以 SPC l s 为前缀。

rubyrepl

网站源码位于 Github, 帮助改进本页面 — 网站主题: mattgraham,