Refactor Roles Support #495
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
alcarney
force-pushed
the
roles-refactor
branch
3 times, most recently
from
06dd928
to
5793222
Compare
alcarney
force-pushed
the
roles-refactor
branch
from
5793222
to
b796aa4
Compare
Following on from the work on ``DirectiveLanguageFeatures`` a similar refactoring has been performed for roles. `RoleLanguageFeatures` are now responsible for all the 'smarts' behind LSP features with the `Roles` language feature providing the framework within which they operate. Features can currently implement the following methods - ``complete_targets`` called when generating role target completion items - ``find_target_definitions`` used to implement goto definition for role targets - ``get_implementation`` used to get the implementation of a role given its name - ``index_roles`` used to tell the language server which roles exist - ``resolve_target_link`` used to implement document links for role targets - ``suggest_roles`` called when generating role completion suggestions The existing "provider" approach has been deprecated along with a number of methods on the base lanaguage servers all of which will be removed in the ``v1.0`` release
This replaces the `get_roles()` method on the base `RstLanguageServer` and is responsible for providing support for the roles that come with vanilla docutils
This ports the existing Sphinx domain and intersphinx roles support to dedicated language features. Additionally, the language server will generate completions for both the short (`:func:`) and long (`:py:func:`) names of roles in the primary and standard Sphinx domains.
alcarney
force-pushed
the
roles-refactor
branch
from
b796aa4
to
5867065
Compare
This was referenced Nov 28, 2022
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.
Similar to #444 and #453, this introduces
RoleLanguageFeaturesas the preferred method of extending role support moving forward. The following methods are currently supportedcomplete_targetscalled when generating role target completion itemsfind_target_definitionsused to implement goto definition for role targetsget_implementationused to get the implementation of a role given its nameindex_rolesused to tell the language server which roles existresolve_target_linkused to implement document links for role targetssuggest_rolescalled when generating role completion suggestionsThis should allow for features like #464 to be implemented
As a result the following methods/protocols have been deprecated and will be removed in
v1.0TargetDefinitionTargetCompletionTargetLinkRoles.add_target_definition_provider()Roles.add_target_link_provider()Roles.add_target_completion_provider()RstLanguageServer.get_roles()SphinxLanguageServer.get_domain()SphinxLanguageServer.get_domains()SphinxLanguageServer.get_roles()SphinxLanguageServer.get_role_target_types()SphinxLanguageServer.get_role_targets()SphinxLanguageServer.get_intersphinx_targets()SphinxLanguageServer.has_intersphinx_targets()SphinxLanguageServer.get_intersphinx_projects()Closes #416