Skip to content

Commit d90d3ae

Browse files
chore: add README docs for using solargraph when installing gem from git (#118)
1 parent f74dd0c commit d90d3ae

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
@@ -180,6 +180,13 @@ After Solargraph is installed, **you must populate its index** either via the pr
180180
bundle exec solargraph gems
181181
```
182182

183+
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.
184+
185+
```yaml
186+
include:
187+
- 'vendor/bundle/ruby/*/gems/openai-*/lib/**/*.rb'
188+
```
189+
183190
Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
184191
185192
### Sorbet

0 commit comments

Comments
 (0)