Add addon example for zed configuration#3934
Add addon example for zed configuration#3934edwardloveall wants to merge 1 commit intoShopify:mainfrom
Conversation
jekyll/editors.markdown
Outdated
| Code, use the official [Ruby LSP extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp). | ||
|
|
||
| {: .note } | ||
|
|
There was a problem hiding this comment.
Can we not add these newline changes?
| "initialization_options": { | ||
| "addonSettings": { | ||
| "Ruby LSP Rails": { | ||
| "enablePendingMigrationsPrompt": false |
There was a problem hiding this comment.
Should these be added to Zed's documentation instead? I find it odd that users need to first visit Zed's doc to see how to setup ruby-lsp, but for addons they need to visit here instead.
There was a problem hiding this comment.
I see what you're saying, but it seems more sustainable to me for the vendor of the config to host that config's documentation. Also, there's a similar note in the Neovim config so I was mimicking that.
That said, I do understand that zed has ruby-lsp specific docs already. If you don't want these docs here then I can try to document over there. I still worry that ruby-lsp contributors are unlikely to think to update zed's docs if/when the ruby-lsp config changes in the future.
There was a problem hiding this comment.
I'm fine with documenting this here. But IMO Zed's doc should mention this too. Its doc not linking back to Ruby LSP's doc means that users might not even know they should also visit here to get this info.
There was a problem hiding this comment.
I'd encourage you to contribute their doc with either a link to ruby-lsp doc (like many other LSP's sections have), or have addon setting documented as well.
edwardloveall
force-pushed
the
el-zed-addon-example
branch
from
9a4dbd1 to
7c6193a
Compare
edwardloveall
force-pushed
the
el-zed-addon-example
branch
from
7c6193a to
3b23907
Compare
2 participants
Motivation
It took me a bit of experimentation to figure out how to configure
addonSettingsin zed given the mixed cases and lack of examples. So I added an example.Automated Tests
None. Text change only.
Manual Tests
I verified that this setting does take effect once the LSP is restarted. I rolled back a migration, restarted the server, restarted the LSP the alert showed up. Then I added the config, restarted the server, and saw no alert.