Merge branch 'main' into refactor-custom-actions

* main:
  fix "Error rewriting command" warning triggered on startup (#2277)
  Take font style of sighelp active parameter from color scheme (#2279)
  Add argument "include_declaration" to "lsp_symbol_references" (#2275)
  fix crash on checking excluded folders with missing project data (#2276)
  Fix tagged diagnostics flickering on document changes (#2274)
  Cut 1.24.0
  use class for diagnostic info instead of hardcoding color (#2257)
  Fix package storage path in a docstring description (#2256)
  Use regular font style in sighelp popup if already highlighted by color scheme (#2259)
  update note about custom color scheme rule used for diagnostics (#2254)

Author: rchl

Default.sublime-keymap

@@ -63,7 +63,7 @@
     {
         "keys": ["shift+f12"],
         "command": "lsp_symbol_references",
-        "args": {"side_by_side": false, "force_group": true, "fallback": false, "group": -1},
+        "args": {"side_by_side": false, "force_group": true, "fallback": false, "group": -1, "include_declaration": false},
         "context": [{"key": "lsp.session_with_capability", "operand": "referencesProvider"}]
     },
     // Find References (side-by-side)

VERSION

@@ -1 +1 @@
-1.23.0
+1.24.0

boot.py

@@ -25,7 +25,6 @@
 from .plugin.core.registry import LspNextDiagnosticCommand
 from .plugin.core.registry import LspOpenLocationCommand
 from .plugin.core.registry import LspPrevDiagnosticCommand
-from .plugin.core.registry import LspRecheckSessionsCommand
 from .plugin.core.registry import LspRestartServerCommand
 from .plugin.core.registry import windows
 from .plugin.core.sessions import AbstractPlugin

docs/src/customization.md

@@ -37,7 +37,7 @@ If you want to bind some action to a mouse, open `Preferences / Browser Packages
 | Linux    | `/User/Default (Linux).sublime-mousemap` |
 | Mac      | `/User/Default (OSX).sublime-mousemap` |
 
-Here is an example mouse binding that triggers LSP's "go to symbol definition" command on pressing the <kbd>ctrl</kbd>+<kbd>left click</kbd>:
+Here is an example of a mouse binding that triggers LSP's "go to symbol definition" command on pressing the <kbd>ctrl</kbd>+<kbd>left click</kbd>:
 
 ```js
 [
@@ -68,23 +68,23 @@ See the [mdpopups documentation](http://facelessuser.github.io/sublime-markdown-
 
 ## Inlay Hints
 
-The style for inlay hints is defined in a [`inlay_hints.css`](https://github.com/sublimelsp/LSP/blob/main/inlay_hints.css) file in the root directory of the LSP package.
+The styles for inlay hints are defined in the [`inlay_hints.css`](https://github.com/sublimelsp/LSP/blob/main/inlay_hints.css) file in the root directory of the LSP package.
 If you would like to adjust the inlay hints style, you can create an [override](https://www.sublimetext.com/docs/packages.html#overriding-files-from-a-zipped-package) for this file (a restart of Sublime Text is required to apply the changes).
-But be aware that by doing this, you might miss out future changes in this file, in case of updates in a new release of the LSP package.
-So consider to use a package like [OverrideAudit](https://packagecontrol.io/packages/OverrideAudit) in order to get a notification when that happens.
+But be aware that by doing this, you might miss out on future changes in this file, in case of updates in a new release of the LSP package.
+So consider using a package like [OverrideAudit](https://packagecontrol.io/packages/OverrideAudit) to get a notification when that happens.
 
 ## Color scheme customizations
 
 Some features use TextMate scopes to control the colors (underline, background or text color) of styled regions in a document or popup.
 Colors can be customized by adding a rule for these scopes into your color scheme.
 There is an example in the [official ST documentation](https://www.sublimetext.com/docs/color_schemes.html#customization) which explains how to do that.
 
-The following tables give an overview about the scope names used by LSP.
+The following tables give an overview of the scope names used by LSP.
 
 ### Semantic Highlighting
 
 !!! info "This feature is only available if the server has the *semanticTokensProvider* capability."
-    Language servers which support semantic highlighting are for example *clangd* and *rust-analyzer*.
+    Language servers that support semantic highlighting are for example *clangd* and *rust-analyzer*.
 
 In order to support semantic highlighting, the color scheme requires a special rule with a background color set for semantic tokens, which is (marginally) different from the original background.
 LSP automatically adds such a rule to the built-in color schemes from Sublime Text.
@@ -101,7 +101,7 @@ If you use a custom color scheme, select `UI: Customize Color Scheme` from the C
 }
 ```
 
-Furthermore it is possible to adjust the colors for semantic tokens by applying a foreground color to the individual token types:
+Furthermore, it is possible to adjust the colors for semantic tokens by applying a foreground color to the individual token types:
 
 | scope | [Semantic Token Type](https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#semanticTokenTypes) |
 | ----- | ------------------ |
@@ -130,10 +130,10 @@ Furthermore it is possible to adjust the colors for semantic tokens by applying
 
 By default, LSP will assign scopes based on the [scope naming guideline](https://www.sublimetext.com/docs/scope_naming.html) to each of these token types, but if you define color scheme rules for the scopes specified above, the latter will take precedence.
 
-Language servers can also add their own custom token types, which are not defined in the protocol.
-A "LSP-*" helper package (or user) can provide a "semantic_tokens" mapping in the server configuration for such additional token types, or to override the scopes used for the predefined tokens from the table above.
-Keys of this mapping should be the token types and values should be the corresponding scopes.
-Semantic tokens with exactly one [token modifier](https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#semanticTokenModifiers) can be addressed by apending the modifier after a dot.
+Language servers can also add their custom token types, which are not defined in the protocol.
+An "LSP-\*" helper package (or user) can provide a `semantic_tokens` mapping in the server configuration for such additional token types, or to override the scopes used for the predefined tokens from the table above.
+The keys of this mapping should be the token types and values should be the corresponding scopes.
+Semantic tokens with exactly one [token modifier](https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#semanticTokenModifiers) can be addressed by appending the modifier after a dot.
 
 ```json
 {
@@ -146,10 +146,10 @@ Semantic tokens with exactly one [token modifier](https://microsoft.github.io/la
 ```
 
 The color for custom token types can also be adjusted via a color scheme rule for the scope `meta.semantic-token.<token-type>`, where `<token-type>` is the name of the custom token type, but with all letters lowercased (similar to the listed scopes in the table above).
-To target tokens with one modifier, use the scope `meta.semantic-token.<token-type>.<token-modifier>` (all lowercased).
+To target tokens with one modifier, use the scope `meta.semantic-token.<token-type>.<token-modifier>` (all lowercase).
 Currently, semantic tokens with more than one modifier cannot be styled reliably.
 
-If neither a scope for a custom token type is defined, nor a color scheme rule for this token type exists, then it will only be highlighted via the regular syntax highlighting.
+If neither a scope for a custom token type is defined, nor a color scheme rule for this token type exists, then it will only be highlighted via regular syntax highlighting.
 
 ### Document Highlights
 
@@ -194,7 +194,7 @@ Diagnostics will also optionally include the following scopes:
 | `markup.unnecessary.lsp` | Unnecessary         | Unused or unnecessary code  |
 | `markup.deprecated.lsp`  | Deprecated          | Deprecated or obsolete code |
 
-Those scopes can be used to, for example, gray-out the text color of unused code, if the server supports that.
+Those scopes can be used to, for example, gray out the text color of unused code, if the server supports that.
 
 For example, to add a custom rule for `Mariana` color scheme, select `UI: Customize Color Scheme` from the Command Palette and add the following rule:
 
@@ -204,13 +204,13 @@ For example, to add a custom rule for `Mariana` color scheme, select `UI: Custom
         {
             "scope": "markup.unnecessary.lsp",
             "foreground": "color(rgb(255, 255, 255) alpha(0.4))",
-            "background": "color(var(blue3) alpha(0.9))"
+            "background": "#00000101"
         }
     ]
 }
 ```
 
-The color scheme rule only works if the "background" color is different from the global background of the scheme. So for other color schemes, ideally pick a background color that is as close as possible, but marginally different from the original background.
+The color scheme rule only works if the "background" color is (marginally) different from the original color scheme background.
 
 ### Signature Help
 
@@ -220,6 +220,10 @@ The color scheme rule only works if the "background" color is different from the
 | `variable.parameter.sighelp.lsp` | Function argument in the signature help popup |
 | `variable.parameter.sighelp.active.lsp` | Function argument which is currently highlighted in the signature help popup |
 
+!!! note
+    If there is no special rule for the active parameter in the color scheme, it will be rendered with bold and underlined font style.
+    But if the color scheme defines a different `"foreground"` color for the active parameter, the style follows the `"font_style"` property from the color scheme rule.
+
 ### Annotations
 
 | scope | description |

docs/src/keyboard_shortcuts.md

@@ -9,7 +9,7 @@ Refer to the [Customization section](customization.md#keyboard-shortcuts-key-bin
 | ------- | -------- | ------- |
 | Auto Complete | <kbd>ctrl</kbd> <kbd>space</kbd> (also on macOS) | `auto_complete`
 | Expand Selection | unbound | `lsp_expand_selection`
-| Find References | <kbd>shift</kbd> <kbd>f12</kbd> | `lsp_symbol_references`
+| Find References | <kbd>shift</kbd> <kbd>f12</kbd> | `lsp_symbol_references` (supports optional args: `{"include_declaration": true/false}`)
 | Follow Link | unbound | `lsp_open_link`
 | Format File | unbound | `lsp_format_document`
 | Format Selection | unbound | `lsp_format_document_range`

messages.json

@@ -21,6 +21,7 @@
     "1.21.0": "messages/1.21.0.txt",
     "1.22.0": "messages/1.22.0.txt",
     "1.23.0": "messages/1.23.0.txt",
+    "1.24.0": "messages/1.24.0.txt",
     "1.3.0": "messages/1.3.0.txt",
     "1.3.1": "messages/1.3.1.txt",
     "1.4.0": "messages/1.4.0.txt",

messages/1.24.0.txt

@@ -1,4 +1,4 @@
-=> 1.23.0
+=> 1.24.0
 
 ⚠️ To ensure that everything works properly after LSP package is updated, it's strongly recommended to restart
 Sublime Text once it finishes updating all packages. ⚠️
@@ -7,3 +7,27 @@ Sublime Text once it finishes updating all packages. ⚠️
 
 - Diagnostics for files that are not within the project folders are no longer ignored.
   You can set `"diagnostics_mode": "workspace"` in server-specific configuration to enable old behavior.
+
+# New features
+
+- Add support for pull diagnostics (#2221) (jwortmann)
+- Add "outline" as an option for "document_highlight_style" (#2234) (Terminal)
+- add "show_multiline_document_highlights" setting (#2247) (Tito)
+
+# Fixes
+
+- Fix handling of folder_exclude_patterns in projects (#2237) (Rafał Chłodnicki)
+- html-escape diagnostic-related strings (#2228) (Rafał Chłodnicki)
+- Fix exception for null response id (#2233) (jwortmann)
+- Fix some features might not work with dynamical registration (#2222) (jwortmann)
+
+# Improvements
+
+- use class for diagnostic info instead of hardcoding color (#2257) (Rafał Chłodnicki)
+- Use regular font style in sighelp popup if already highlighted by color scheme (#2259) (jwortmann)
+- Add support and mode for workspace pull diagnostics (#2225) (jwortmann)
+- don't send params for requests/notifications that don't expect them (#2240) (Rafał Chłodnicki)
+- optimize creation of code actions annotation region (#2239) (Rafał Chłodnicki)
+- Allow style overrides for inlay_hints.css (#2232) (jwortmann)
+- Improve label detail support in completions (#2212) (ryuukk)
+- Update clojure-lsp docs (#2226) (Raffael Stein)

plugin/core/configurations.py

@@ -4,8 +4,11 @@
 from .types import ClientConfig
 from .typing import Generator, List, Optional, Set, Dict, Deque
 from .workspace import enable_in_project, disable_in_project
+from abc import ABCMeta
+from abc import abstractmethod
 from collections import deque
 from datetime import datetime, timedelta
+from weakref import WeakSet
 import sublime
 import urllib.parse
 
@@ -14,14 +17,25 @@
 RETRY_COUNT_TIMEDELTA = timedelta(minutes=3)
 
 
+class WindowConfigChangeListener(metaclass=ABCMeta):
+
+    @abstractmethod
+    def on_configs_changed(self, config_name: Optional[str] = None) -> None:
+        raise NotImplementedError()
+
+
 class WindowConfigManager(object):
     def __init__(self, window: sublime.Window, global_configs: Dict[str, ClientConfig]) -> None:
         self._window = window
         self._global_configs = global_configs
         self._disabled_for_session = set()  # type: Set[str]
         self._crashes = {}  # type: Dict[str, Deque[datetime]]
         self.all = {}  # type: Dict[str, ClientConfig]
-        self.update()
+        self._change_listeners = WeakSet()  # type: WeakSet[WindowConfigChangeListener]
+        self._reload_configs()
+
+    def add_change_listener(self, listener: WindowConfigChangeListener) -> None:
+        self._change_listeners.add(listener)
 
     def get_configs(self) -> List[ClientConfig]:
         return sorted(self.all.values(), key=lambda config: config.name)
@@ -44,7 +58,7 @@ def match_view(self, view: sublime.View, include_disabled: bool = False) -> Gene
         except (IndexError, RuntimeError):
             pass
 
-    def update(self, updated_config_name: Optional[str] = None) -> None:
+    def _reload_configs(self, updated_config_name: Optional[str] = None) -> None:
         project_settings = (self._window.project_data() or {}).get("settings", {}).get("LSP", {})
         if updated_config_name is None:
             self.all.clear()
@@ -67,7 +81,11 @@ def update(self, updated_config_name: Optional[str] = None) -> None:
                 self.all[name] = ClientConfig.from_dict(name, c)
             except Exception as ex:
                 exception_log("failed to load project-only configuration {}".format(name), ex)
-        self._window.run_command("lsp_recheck_sessions", {'config_name': updated_config_name})
+
+    def update(self, updated_config_name: Optional[str] = None) -> None:
+        self._reload_configs(updated_config_name)
+        for listener in self._change_listeners:
+            listener.on_configs_changed(updated_config_name)
 
     def enable_config(self, config_name: str) -> None:
         if not self._reenable_disabled_for_session(config_name):
@@ -76,7 +94,7 @@ def enable_config(self, config_name: str) -> None:
 
     def disable_config(self, config_name: str, only_for_session: bool = False) -> None:
         if only_for_session:
-            self._disable_for_session(config_name)
+            self._disabled_for_session.add(config_name)
         else:
             disable_in_project(self._window, config_name)
         self.update(config_name)
@@ -97,9 +115,6 @@ def record_crash(self, config_name: str, exit_code: int, exception: Optional[Exc
             config_name, crash_count, RETRY_MAX_COUNT, RETRY_COUNT_TIMEDELTA.total_seconds(), exit_code, exception))
         return crash_count < RETRY_MAX_COUNT
 
-    def _disable_for_session(self, config_name: str) -> None:
-        self._disabled_for_session.add(config_name)
-
     def _reenable_disabled_for_session(self, config_name: str) -> bool:
         try:
             self._disabled_for_session.remove(config_name)

plugin/core/registry.py

@@ -276,17 +276,6 @@ def run_async() -> None:
         sublime.set_timeout_async(run_async)
 
 
-class LspRecheckSessionsCommand(sublime_plugin.WindowCommand):
-    def run(self, config_name: Optional[str] = None) -> None:
-
-        def run_async() -> None:
-            wm = windows.lookup(self.window)
-            if wm:
-                wm.restart_sessions_async(config_name)
-
-        sublime.set_timeout_async(run_async)
-
-
 def navigate_diagnostics(view: sublime.View, point: Optional[int], forward: bool = True) -> None:
     try:
         uri = uri_from_view(view)