Server logs to panel

Commands/Default.sublime-commands

@@ -60,9 +60,12 @@
         "args": {}
     },
     {
-        "caption": "LSP: Show Diagnostics",
-        "command": "lsp_show_diagnostics_panel",
-        "args": {}
+        "caption": "LSP: Toggle Panel: Language Servers",
+        "command": "lsp_toggle_server_panel",
+    },
+    {
+        "caption": "LSP: Toggle Panel: Diagnostics",
+        "command": "lsp_show_diagnostics_panel"
     },
     {
         "caption": "LSP: Clear Diagnostics",

Keymaps/Default (Linux).sublime-keymap

@@ -13,7 +13,10 @@
     { "keys": ["ctrl+."], "command": "lsp_code_actions", "context": [{"key": "setting.lsp_active"}]},
 
     // Show/Hide Diagnostics Panel
-    { "keys": ["ctrl+alt+m"], "command": "lsp_show_diagnostics_panel", "context": [{"key": "setting.lsp_active"}]},
+    { "keys": ["ctrl+alt+m"], "command": "lsp_toggle_panel", "args": {"panel_type": "diagnostics"}, "context": [{"key": "setting.lsp_active"}]},
+
+    // Show/Hide Language Server Logs Panel
+    // { "keys": ["UNBOUND"], "command": "lsp_toggle_panel", "args": {"panel_type": "language servers"}, "context": [{"key": "setting.lsp_active"}]},
 
     // Trigger Signature Help
     { "keys": ["ctrl+alt+space"], "command": "noop", "context": [{ "key": "lsp.signature_help", "operator": "equal", "operand": 0}] },

Keymaps/Default (OSX).sublime-keymap

@@ -13,7 +13,10 @@
     { "keys": ["super+."], "command": "lsp_code_actions", "context": [{"key": "setting.lsp_active"}]},
 
     // Show/Hide Diagnostics Panel
-    { "keys": ["super+alt+m"], "command": "lsp_show_diagnostics_panel", "context": [{"key": "setting.lsp_active"}]},
+    { "keys": ["super+alt+m"], "command": "lsp_toggle_panel", "args": {"panel_type": "diagnostics"}, "context": [{"key": "setting.lsp_active"}]},
+
+    // Show/Hide Language Server Logs Panel
+    // { "keys": ["UNBOUND"], "command": "lsp_toggle_panel", "args": {"panel_type": "language servers"}, "context": [{"key": "setting.lsp_active"}]},
 
     // Trigger Signature Help
     { "keys": ["super+alt+space"], "command": "noop", "context": [{ "key": "lsp.signature_help", "operator": "equal", "operand": 0}] },

Keymaps/Default (Windows).sublime-keymap

@@ -13,7 +13,10 @@
     { "keys": ["ctrl+."], "command": "lsp_code_actions", "context": [{"key": "setting.lsp_active"}]},
 
     // Show/Hide Diagnostics Panel
-    { "keys": ["ctrl+alt+m"], "command": "lsp_show_diagnostics_panel", "context": [{"key": "setting.lsp_active"}]},
+    { "keys": ["ctrl+alt+m"], "command": "lsp_toggle_panel", "args": {"panel_type": "diagnostics"}, "context": [{"key": "setting.lsp_active"}]},
+
+    // Show/Hide Language Server Logs Panel
+    // { "keys": ["UNBOUND"], "command": "lsp_toggle_panel", "args": {"panel_type": "language servers"}, "context": [{"key": "setting.lsp_active"}]},
 
     // Trigger Signature Help
     { "keys": ["ctrl+alt+space"], "command": "noop", "context": [{ "key": "lsp.signature_help", "operator": "equal", "operand": 0}] },

LSP.sublime-settings

@@ -82,13 +82,21 @@
   // Show verbose debug messages in the sublime console.
   "log_debug": false,
 
-  // Show notifications from language servers in the console.
+  // Show messages from language servers in the Language Servers output panel.
+  // This output panel can be toggled from the command palette with the
+  // command "LSP: Toggle Panel: Language Servers".
   "log_server": true,
 
-  // Show language server stderr output in the console.
+  // Show language server stderr output in the Language Servers output panel.
+  // This output panel can be toggled from the command palette with the
+  // command "LSP: Toggle Panel: Language Servers".
   "log_stderr": false,
 
-  // Show full JSON-RPC responses in the console
+  // Show full JSON-RPC requests/responses/notifications in the Language Servers
+  // output panel. Note that if the payload is very large, SublimeText will not
+  // highlight the log line.
+  // This output panel can be toggled from the command palette with the
+  // command "LSP: Toggle Panel: Language Servers".
   "log_payloads": false,
 
   // User clients configuration can be used to

Syntaxes/ServerLog.sublime-syntax

@@ -0,0 +1,92 @@
+%YAML 1.2
+---
+# [Subl]: https://www.sublimetext.com/docs/3/syntax.html
+# [LSP]: https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md
+hidden: true
+scope: output.lsp.log
+
+variables:
+  method: '[[:alpha:]][[:alnum:]/]*'
+  servername: '[[:alnum:]_-]+'
+
+contexts:
+  main:
+    - match: ^({{servername}})(:)
+      captures:
+        1: variable.function.lsp
+        2: punctuation.separator.lsp
+      push:
+        - meta_scope: meta.block.lsp
+        - match: $
+          pop: true
+    - match: '^::'
+      scope: punctuation.accessor.lsp
+      push:
+      - - meta_scope: meta.group.lsp
+        - match: $
+          pop: true
+        # responses
+      - - match: \d+
+          scope: constant.numeric.integer.decimal.lsp
+          set:
+            - match: ':'
+              scope: punctuation.separator.lsp
+              set: maybe-payload
+            - match: ''
+              pop: true
+        # notifications or requests
+        - match: (?=\w)
+          set:
+            # requests
+          - - match: \(
+              scope: punctuation.section.parens.begin.lsp
+              set:
+                - match: \d+
+                  scope: constant.numeric.integer.decimal.lsp
+                  set:
+                    - match: \)
+                      scope: punctuation.section.parens.end.lsp
+                      set:
+                        - match: ':'
+                          scope: punctuation.separator.lsp
+                          set: maybe-payload
+                        - match: ''
+                          pop: true
+            # notifications
+            - match: ':'
+              scope: punctuation.separator.lsp
+              set: maybe-payload
+            - match: ''
+              pop: true
+          - - match: '{{method}}'
+              scope: keyword.control.lsp
+              pop: true
+        # language server name
+      - - match: \S+
+          scope: variable.function.lsp
+          pop: true
+        # arrows
+      - - match: -->
+          scope: storage.modifier.lsp
+          pop: true
+        - match: <--
+          scope: storage.modifier.lsp
+          pop: true
+        - match: ==>
+          scope: storage.modifier.lsp
+          pop: true
+        - match: unhandled
+          scope: invalid.deprecated.lsp
+          pop: true
+
+  maybe-payload:
+    - match: \s*(?=\S)
+      set:
+        - match: $
+          pop: true
+        - include: scope:source.python#constants  # e.g. shutdown request
+        - include: scope:source.python#lists
+        - include: scope:source.python#dictionaries-and-sets
+    - match: ''
+      pop: true
+...

boot.py

@@ -4,6 +4,7 @@
 from .plugin.core.panels import *
 from .plugin.core.registry import LspRestartClientCommand
 from .plugin.core.documents import *
+from .plugin.panels import *
 from .plugin.edit import *
 from .plugin.completion import *
 from .plugin.diagnostics import *

dependencies.json

@@ -10,4 +10,4 @@
             "pyyaml"
         ]
     }
-}
+}

plugin/core/clients.py

@@ -42,7 +42,8 @@ def start_window_config(window: sublime.Window,
                         config: ClientConfig,
                         on_pre_initialize: 'Callable[[Session], None]',
                         on_post_initialize: 'Callable[[Session], None]',
-                        on_post_exit: 'Callable[[str], None]') -> 'Optional[Session]':
+                        on_post_exit: 'Callable[[str], None]',
+                        on_stderr_log: 'Optional[Callable[[str], None]]') -> 'Optional[Session]':
     args, env = get_window_env(window, config)
     config.binary_args = args
     return create_session(config=config,
@@ -51,7 +52,8 @@ def start_window_config(window: sublime.Window,
                           settings=settings,
                           on_pre_initialize=on_pre_initialize,
                           on_post_initialize=on_post_initialize,
-                          on_post_exit=lambda config_name: on_session_ended(window, config_name, on_post_exit))
+                          on_post_exit=lambda config_name: on_session_ended(window, config_name, on_post_exit),
+                          on_stderr_log=on_stderr_log)
 
 
 def on_session_ended(window: sublime.Window, config_name: str, on_post_exit_handler: 'Callable[[str], None]') -> None:

plugin/core/logging.py

@@ -8,7 +8,6 @@
 
 log_debug = False
 log_exceptions = True
-log_server = True
 
 
 def set_debug_logging(logging_enabled: bool) -> None:
@@ -21,11 +20,6 @@ def set_exception_logging(logging_enabled: bool) -> None:
     log_exceptions = logging_enabled
 
 
-def set_server_logging(logging_enabled: bool) -> None:
-    global log_server
-    log_server = logging_enabled
-
-
 def debug(*args: 'Any') -> None:
     """Print args to the console if the "debug" setting is True."""
     if log_debug:
@@ -39,11 +33,6 @@ def exception_log(message: str, ex: Exception) -> None:
         print(''.join(traceback.format_exception(ex.__class__, ex, ex_traceback)))
 
 
-def server_log(server_name: str, *args: 'Any') -> None:
-    if log_server:
-        printf(*args, prefix=server_name)
-
-
 def printf(*args: 'Any', prefix: str = 'LSP') -> None:
     """Print args to the console, prefixed by the plugin name."""
     print(prefix + ":", *args)

plugin/core/main.py

@@ -1,13 +1,13 @@
 import sublime
 
-from .settings import settings, load_settings, unload_settings
-from .logging import set_debug_logging, set_server_logging
-from .registry import windows, load_handlers, unload_sessions
-from .panels import destroy_output_panels
+from .logging import set_debug_logging, set_exception_logging
+from .panels import destroy_output_panels, ensure_panel, PanelName
 from .popups import popups
+from .registry import windows, load_handlers, unload_sessions
+from .settings import settings, load_settings, unload_settings
+from ..color import remove_color_boxes
 from ..diagnostics import DiagnosticsPresenter
 from ..highlights import remove_highlights
-from ..color import remove_color_boxes
 
 try:
     from typing import Any, List, Dict, Tuple, Callable, Optional, Set
@@ -16,12 +16,18 @@
     pass
 
 
+def ensure_server_panel(window: sublime.Window) -> 'Optional[sublime.View]':
+    return ensure_panel(window, PanelName.LanguageServers, "", "", "Packages/LSP/Syntaxes/ServerLog.sublime-syntax")
+
+
 def startup() -> None:
     load_settings()
-    set_debug_logging(settings.log_debug)
-    set_server_logging(settings.log_server)
     popups.load_css()
+    set_debug_logging(settings.log_debug)
+    set_exception_logging(True)
     windows.set_diagnostics_ui(DiagnosticsPresenter)
+    windows.set_server_panel_factory(ensure_server_panel)
+    windows.set_settings_factory(settings)
     load_handlers()
     sublime.status_message("LSP initialized")
     start_active_window()

plugin/core/panels.py

@@ -1,30 +1,50 @@
+from contextlib import contextmanager
 import sublime
 import sublime_plugin
 
 try:
-    from typing import Optional, Any
-    assert Optional, Any
+    from typing import Optional, Any, List, Generator
+    assert Optional and Any and List and Generator
 except ImportError:
     pass
 
 
+# about 80 chars per line implies maintaining a buffer of about 40kb per window
+SERVER_PANEL_MAX_LINES = 500
+
+
 OUTPUT_PANEL_SETTINGS = {
     "auto_indent": False,
     "draw_indent_guides": False,
     "draw_white_space": "None",
+    "fold_buttons": True,
     "gutter": True,
-    'is_widget': True,
+    "is_widget": True,
     "line_numbers": False,
+    "lsp_active": True,
     "margin": 3,
     "match_brackets": False,
+    "rulers": [],
     "scroll_past_end": False,
     "tab_size": 4,
     "translate_tabs_to_spaces": False,
-    "word_wrap": False,
-    "fold_buttons": True
+    "word_wrap": False
 }
 
 
+class PanelName:
+    Diagnostics = "diagnostics"
+    References = "references"
+    LanguageServers = "language servers"
+
+
+@contextmanager
+def mutable(view: sublime.View) -> 'Generator':
+    view.set_read_only(False)
+    yield
+    view.set_read_only(True)
+
+
 def create_output_panel(window: sublime.Window, name: str) -> 'Optional[sublime.View]':
     panel = window.create_output_panel(name)
     settings = panel.settings()
@@ -34,8 +54,12 @@ def create_output_panel(window: sublime.Window, name: str) -> 'Optional[sublime.
 
 
 def destroy_output_panels(window: sublime.Window) -> None:
-    for panel_name in ["references", "diagnostics"]:
-        window.destroy_output_panel(panel_name)
+    for field in filter(lambda a: not a.startswith('__'), PanelName.__dict__.keys()):
+        panel_name = getattr(PanelName, field)
+        panel = window.find_output_panel(panel_name)
+        if panel and panel.is_valid():
+            panel.settings().set("syntax", "Packages/Text/Plain text.tmLanguage")
+            window.destroy_output_panel(panel_name)
 
 
 def create_panel(window: sublime.Window, name: str, result_file_regex: str, result_line_regex: str,
@@ -50,6 +74,8 @@ def create_panel(window: sublime.Window, name: str, result_file_regex: str, resu
     # settings, so that it'll be picked up as a result buffer
     # see: Packages/Default/exec.py#L228-L230
     panel = window.create_output_panel(name)
+    # All our panels are read-only
+    panel.set_read_only(True)
     return panel
 
 
@@ -64,9 +90,8 @@ class LspClearPanelCommand(sublime_plugin.TextCommand):
     """
 
     def run(self, edit: sublime.Edit) -> None:
-        self.view.set_read_only(False)
-        self.view.erase(edit, sublime.Region(0, self.view.size()))
-        self.view.set_read_only(True)
+        with mutable(self.view):
+            self.view.erase(edit, sublime.Region(0, self.view.size()))
 
 
 class LspUpdatePanelCommand(sublime_plugin.TextCommand):
@@ -78,8 +103,26 @@ def run(self, edit: sublime.Edit, characters: 'Optional[str]' = "") -> None:
         # Clear folds
         self.view.unfold(sublime.Region(0, self.view.size()))
 
-        self.view.replace(edit, sublime.Region(0, self.view.size()), characters or "")
+        with mutable(self.view):
+            self.view.replace(edit, sublime.Region(0, self.view.size()), characters or "")
 
         # Clear the selection
         selection = self.view.sel()
         selection.clear()
+
+
+class LspUpdateServerPanelCommand(sublime_plugin.TextCommand):
+    def run(self, edit: sublime.Edit, prefix: str, message: str) -> None:
+        with mutable(self.view):
+            self.view.insert(edit, self.view.size(), "{}: {}\n".format(prefix, message))
+            total_lines, _ = self.view.rowcol(self.view.size())
+            point = 0  # Starting from point 0 in the panel ...
+            regions = []  # type: List[sublime.Region]
+            for _ in range(0, max(0, total_lines - SERVER_PANEL_MAX_LINES)):
+                # ... collect all regions that span an entire line ...
+                region = self.view.full_line(point)
+                regions.append(region)
+                point = region.b
+            for region in reversed(regions):
+                # ... and erase them in reverse order
+                self.view.erase(edit, region)