Display addons status in the control panel #2180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
force-pushed
the
implement-addon-status
branch
3 times, most recently
from
a03e3aa
to
969794f
Compare
st0012
added
enhancement
vinistock
reviewed
Jun 14, 2024
This will give users a quick overview of the addons that are enabled in
their workspace.
We plan to expand this feature to display more information about addons
in the future, such as:
- The version of the addon
- The gem name of the addon
- Addons that weren't activated due to errors
But some of these features will require changes to the addon API, so
we will plan them for a future release.
The feature is implemented on both the server and the extension:
- Server:
- The server now has an experimental field in the capabilities object,
which currently only has the `addon_detection` field.
- The server now supports a custom `rubyLsp/workspace/addons` request
that returns the list of addons that are enabled in the workspace.
At this iteration, each addon only has name and errored attributes.
- Extension:
- In the client.afterStart callback, the extension now sends a
`rubyLsp/workspace/addons` request to the server to fetch and store
the list of addons.
- A new `AddonsStatus` status item is added to display addon's status.
- If the server doesn't have the capability, the status will mention
that server 0.17.4 or later is required.
- If the server supports the capability but the workspace has no addons,
the status will mention that no addons are enabled.
- If the workspace has addons, the status will display the names of the
addons that are enabled.
st0012
force-pushed
the
implement-addon-status
branch
from
969794f
to
abece9e
Compare
vinistock
approved these changes
Jun 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This will give users a quick overview of the addons that are enabled in their workspace.
We plan to expand this feature to display more information about addons in the future, such as:
But some of these features will require changes to the addon API, so we will plan them for a future release.
Implementation
The feature is implemented on both the server and the extension:
addon_detectionfield.rubyLsp/workspace/addonsrequest that returns the list of addons that are enabled in the workspace. At this iteration, each addon only has name and errored attributes.rubyLsp/workspace/addonsrequest to the server to fetch and store the list of addons.AddonsStatusstatus item is added to display addon's status.(errored)will be added after its name.I plan to explore better UI in later iterations as simply having the names listed will already make addon development easier.
Automated Tests
Added some
Manual Tests