Skip to content

Commit 574fdf4

Browse files
chore: document LSP support in read me (#225)
1 parent f2a6cec commit 574fdf4

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,23 @@ orb.customers.create(
134134

135135
## LSP Support
136136

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+
```
138150

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
140154

141155
This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
142156

@@ -152,6 +166,12 @@ params = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.
152166
orb.customers.create(**params)
153167
```
154168

169+
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.
174+
155175
## Advanced
156176

157177
### Making custom/undocumented requests

0 commit comments

Comments
 (0)