Introduce LspPlugin API (#2739)

Author: rchl

boot.py

@@ -2,7 +2,8 @@
 
 from .plugin.api import AbstractPlugin
 from .plugin.api import g_plugins
-from .plugin.api import register_plugin
+from .plugin.api import LspPlugin
+from .plugin.api import register_plugin_impl
 from .plugin.code_actions import LspCodeActionsCommand
 from .plugin.code_actions import LspRefactorCommand
 from .plugin.code_actions import LspSourceActionCommand
@@ -180,15 +181,16 @@ def _get_final_subclasses(derived: list[type], results: list[type]) -> None:
 
 
 def _register_all_plugins() -> None:
-    plugin_classes: list[type[AbstractPlugin]] = []
+    plugin_classes: list[type[AbstractPlugin | LspPlugin]] = []
     _get_final_subclasses(AbstractPlugin.__subclasses__(), plugin_classes)
+    _get_final_subclasses(LspPlugin.__subclasses__(), plugin_classes)
     for plugin_class in plugin_classes:
         try:
-            if not plugin_class.name():
+            if issubclass(plugin_class, AbstractPlugin) and not plugin_class.name():
                 continue
         except NotImplementedError:
             continue
-        register_plugin(plugin_class, notify_listener=False)
+        register_plugin_impl(plugin_class, notify_listener=False)
 
 
 def _unregister_all_plugins() -> None:

docs/mkdocs.yml

@@ -61,6 +61,7 @@ nav:
   - Keyboard Shortcuts: keyboard_shortcuts.md
   - Client Configuration: client_configuration.md
   - Troubleshooting: troubleshooting.md
+  - Migration to LspPlugin: migrating_to_lsp_plugin.md
 
 extra:
   social:

docs/src/client_configuration.md

@@ -34,6 +34,7 @@ Below is an example configuration for the [Phpactor](https://phpactor.readthedoc
 | initialization_options | options to send to the server at startup |
 | priority_selector | Used to prioritize a certain language server when choosing which one to query on views with multiple servers active. Certain LSP actions have to pick which server to query and this setting can be used to decide which one to pick based on the current scopes at the cursor location. For example when having both HTML and PHP servers running on a PHP file, this can be used to give priority to the HTML one in HTML blocks and to PHP one otherwise. That would be done by setting "priority_selector" to `text.html` for HTML server and `source.php` to PHP server.
 | diagnostics_mode | Set to `"workspace"` (default is `"all_files"`) to ignore diagnostics for files that are not within the project (window) folders. If project has no folders then this option has no effect and diagnostics are shown for all files. |
+| markdown_language_map | A mapping of markdown language identifiers to aliases and Sublime Text syntaxes, used for syntax-highlighting fenced code blocks in popups. Each key is a fenced-code-block language tag (e.g. `"js"`). Each value is a two-element array: the first element is an array of additional aliases, and the second is an array of Sublime Text syntaxes associated with that language (e.g. `["MyPackage/MySyntaxLanguage"]`) or `scope:BASE_SCOPE` selectors (e.g. `["scope:source.js"]`). See [mdpopups `sublime_user_lang_map`](https://facelessuser.github.io/sublime-markdown-popups/settings/#mdpopupssublime_user_lang_map) for the full format description. |
 | tcp_port | see instructions below |
 | experimental_capabilities | Turn on experimental capabilities of a language server. This is a dictionary and differs per language server |
 | disabled_capabilities | Disables specific capabilities of a language server. This is a dictionary with key being a capability key and being `true`. Refer to the `ServerCapabilities` structure in [LSP capabilities](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize) to find capabilities that you might want to disable. Note that the value should be `true` rather than `false` for capabilites that you want to disable. For example: `"signatureHelpProvider": true` |