Document how addons can listen for file changes #1972
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Addons may want to listen for changes to files and do something about it.
ruby-lsp-rails
for example listens forstructure.sql
to restart the rails runner for updated column information, after Shopify/ruby-lsp-rails#341 is merged.ruby-lsp
itself wants to check for changes to the rubocop config in the server to resolve #1457rubyfmt
forruby-lsp-rubyfmt
appears to change behaviour depending on.gitignore
and.rubyfmtignore
.I noticed that some activation methods didn't yet take the global state in the docs here . I've updated these in a separate commit here.