Skip to content

Commit 368c337

Browse files
chore: add README docs for using solargraph when installing gem from git (#118)
1 parent 4a43313 commit 368c337

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,13 @@ After Solargraph is installed, **you must populate its index** either via the pr
182182
bundle exec solargraph gems
183183
```
184184

185+
Note: if you had installed the gem either using a `git:` or `github:` URL, or had vendored the gem using bundler, you will need to set up your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to the gem's `lib` directory.
186+
187+
```yaml
188+
include:
189+
- 'vendor/bundle/ruby/*/gems/openai-*/lib/**/*.rb'
190+
```
191+
185192
Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
186193
187194
### Sorbet

0 commit comments

Comments
 (0)