Skip to content

Commit 48b892e

Browse files
chore: add README docs for using solargraph when installing gem from git (#242)
1 parent 060c286 commit 48b892e

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

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

151+
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.
152+
153+
```yaml
154+
include:
155+
- 'vendor/bundle/ruby/*/gems/orb-billing-*/lib/**/*.rb'
156+
```
157+
151158
Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
152159
153160
### Sorbet

0 commit comments

Comments
 (0)