From 2238f284e86f058b64e9033437c51ad336e0f223 Mon Sep 17 00:00:00 2001 From: Adam Doppelt Date: Tue, 10 Apr 2018 09:21:10 -0700 Subject: [PATCH] add some readme hints about gem dependencies --- readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/readme.md b/readme.md index e708b2b32..827c801a8 100644 --- a/readme.md +++ b/readme.md @@ -30,6 +30,20 @@ It started as a personal project of [@rebornix](https://github.com/rebornix), ai Press `F1`, type `ext install` then search for `ruby`. +### Gem Dependencies + +Depending on your setup, you may need to manually install gem dependencies like +`rubocop`, `ruby-debug-ide` or `solargraph`. This can be complicated because +there are many different ways to use Ruby itself - system ruby, rbenv, chruby, +rvm, bundler, etc. Your results may also vary depending on how you start VS Code +and the environment variables present at that time. + +The important thing is that if VS Code can't find `rubocop`, our extension can't +either. One way to debug these problems is to investigate within VS Code's +Integrated Terminal. (View > Integrated Terminal). Try `ruby -v`, `gem env +gemdir`, `gem list | grep rubocop`, `which rubocop` and then `rubocop -v`. This +might shed some light on why a gem dependency isn't working. + ## Debugger ### Install Ruby Dependencies In this extension, we implement [ruby debug ide protocol](http://debug-commons.rubyforge.org/protocol-spec.html) to allow VS Code to communicate with ruby debug, it requires `ruby-debug-ide` to be installed on your machine. This is also how RubyMine/NetBeans does by default.