kwerle/ruby_language_server

镜像概述

ruby_language_server是一个用Ruby编写的Ruby语言服务器，实现了https://microsoft.github.io/language-server-protocol/%EF%BC%8C%E6%97%A8%E5%9C%A8%E4%B8%BARuby%E5%BC%80%E5%8F%91%E6%8F%90%E4%BE%9B%E4%BB%A3%E7%A0%81%E6%99%BA%E8%83%BD%E6%94%AF%E6%8C%81%EF%BC%8C%E9%80%9A%E8%BF%87STDIO%E6%8E%A5%E5%8F%A3%E4%B8%8E%E7%BC%96%E8%BE%91%E5%99%A8%E8%BF%9B%E8%A1%8C%E4%BA%A4%E4%BA%92%EF%BC%8C%E5%8F%AF%E6%97%A5%E5%B8%B8%E4%BD%BF%E7%94%A8%EF%BC%8C%E6%AC%A2%E8%BF%8E%E8%B4%A1%E7%8C%AE%E3%80%82

核心功能与特性

• 定义跳转（Definitions）：支持代码中符号定义的定位与跳转
• 代码补全（Completions）：提供Ruby代码的自动补全建议
• 代码检查（Lint）：集成https://github.com/bbatsov/rubocop%E8%BF%9B%E8%A1%8C%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E4%B8%8E%E8%AF%AD%E6%B3%95%E6%A3%80%E6%9F%A5
• 更多功能详见https://github.com/kwerle/ruby_language_server/blob/master/FAQ_ROADMAP.md

适用场景与编辑器集成

适用于需要LSP支持的Ruby开发环境，已开发多个编辑器集成插件：

• VSCode：https://github.com/kwerle/vscode_ruby_language_server
• Atom：https://github.com/kwerle/ide-ruby
• Theia：https://github.com/kwerle/theia_ruby_language_server

使用方法

启动语言服务器

运行ruby_language_server命令启动程序，通过LSP的STDIO接口等待活动，与编辑器进行交互。

Docker部署示例

通过Docker运行语言服务器（需挂载项目目录以访问代码文件）：

bash
docker run --rm -i -v $(pwd):/workspace ruby_language_server ruby_language_server

编辑器集成配置（以Atom为例）

1. 安装ide-ruby插件
2. 打开设置 > 插件 > ide-ruby > 镜像名称，设置为local_ruby_language_server（本地开发时）
3. 使用快捷键CMD-ALT-CTRL-L（L字母）重新加载窗口
4. 使用CMD-ALT-I打开调试信息面板

开发相关

开发环境设置

1. 克隆仓库，推荐使用https://datasift.github.io/gitflow/%E5%B7%A5%E4%BD%9C%E6%B5%81
2. 查看项目https://github.com/kwerle/ruby_language_server/blob/master/Makefile%EF%BC%8C%E5%BB%BA%E8%AE%AE%EF%BC%9A
   • 在一个窗口运行make guard（自动运行测试）
   • 在另一个窗口运行make continuous_development
3. 编写测试，guard会自动执行测试；修改代码后通过编辑器重载窗口进行验证

类似项目

• https://github.com/mtsmfm/language_server-ruby
• https://github.com/castwide/solargraph

作者与贡献者

作者

• Kurt Werle

贡献者

• Sebastian Delmont
• https://github.com/mattn
• 期待您的贡献，在此添加您的名字！