Skip to content
This repository was archived by the owner on Jul 31, 2023. It is now read-only.

Commit 991abca

Browse files
authored
Merge pull request #327 from gurgeous/readme_gem_hints
add some readme hints about gem dependencies
2 parents 72ae6af + 2238f28 commit 991abca

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ It started as a personal project of [@rebornix](https://github.com/rebornix), ai
3030

3131
Press `F1`, type `ext install` then search for `ruby`.
3232

33+
### Gem Dependencies
34+
35+
Depending on your setup, you may need to manually install gem dependencies like
36+
`rubocop`, `ruby-debug-ide` or `solargraph`. This can be complicated because
37+
there are many different ways to use Ruby itself - system ruby, rbenv, chruby,
38+
rvm, bundler, etc. Your results may also vary depending on how you start VS Code
39+
and the environment variables present at that time.
40+
41+
The important thing is that if VS Code can't find `rubocop`, our extension can't
42+
either. One way to debug these problems is to investigate within VS Code's
43+
Integrated Terminal. (View > Integrated Terminal). Try `ruby -v`, `gem env
44+
gemdir`, `gem list | grep rubocop`, `which rubocop` and then `rubocop -v`. This
45+
might shed some light on why a gem dependency isn't working.
46+
3347
## Debugger
3448
### Install Ruby Dependencies
3549
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.

0 commit comments

Comments
 (0)