You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,9 +134,23 @@ orb.customers.create(
134
134
135
135
## LSP Support
136
136
137
-
### Sorbet
137
+
### Solargraph
138
+
139
+
This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
140
+
141
+
```ruby
142
+
gem "solargraph", group::development
143
+
```
144
+
145
+
After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
146
+
147
+
```sh
148
+
bundle exec solargraph gems
149
+
```
138
150
139
-
**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
151
+
Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
152
+
153
+
### Sorbet
140
154
141
155
This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
170
+
171
+
### Ruby LSP
172
+
173
+
The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
0 commit comments