Merge pull request #736 from jupyter-lsp/improve-diagnostics

Add support for diagnostic tags from LSP 3.15

Author: krassowski

atest/05_Features/Diagnostics.robot

@@ -0,0 +1,13 @@
+*** Settings ***
+Suite Setup       Setup Suite For Screenshots    diagnostics
+Force Tags        feature:diagnostics
+Test Setup        Setup Notebook    Python    Diagnostic.ipynb
+Test Teardown     Clean Up After Working With File    Diagnostic.ipynb
+Resource          ../Keywords.robot
+
+# note: diagnostics are also tested in 01_Editor and 04_Interface/DiagnosticsPanel.robot
+
+*** Test Cases ***
+Diagnostics with deprecated tag have strike-through decoration
+    Wait Until Page Contains Element    css:.cm-lsp-diagnostic[title*="is deprecated"]    timeout=25s
+    Page Should Contain Element    css:.cm-lsp-diagnostic-tag-Deprecated

atest/examples/Diagnostic.ipynb

@@ -48,11 +48,25 @@
     "# Foo\n",
     "above, one `hint`"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%javascript\n",
+    "/**\n",
+    " * @deprecated\n",
+    " */\n",
+    "function oldFunc() {}\n",
+    "oldFunc"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },

packages/jupyterlab-lsp/src/connection.ts

@@ -19,6 +19,7 @@ import type * as rpc from 'vscode-jsonrpc';
 import type * as lsp from 'vscode-languageserver-protocol';
 import type { MessageConnection } from 'vscode-ws-jsonrpc';
 
+import { CompletionItemTag, DiagnosticTag } from './lsp';
 import { ILSPLogConsole } from './tokens';
 import { until_ready } from './utils';
 
@@ -392,6 +393,79 @@ export class LSPConnection extends LspWsConnection {
       );
   }
 
+  /**
+   * Initialization parameters to be sent to the language server.
+   * Subclasses can overload this when adding more features.
+   */
+  protected initializeParams(): lsp.InitializeParams {
+    return {
+      ...super.initializeParams(),
+      capabilities: {
+        textDocument: {
+          hover: {
+            dynamicRegistration: true,
+            contentFormat: ['markdown', 'plaintext']
+          },
+          synchronization: {
+            dynamicRegistration: true,
+            willSave: false,
+            didSave: true,
+            willSaveWaitUntil: false
+          },
+          completion: {
+            dynamicRegistration: true,
+            completionItem: {
+              snippetSupport: false,
+              commitCharactersSupport: true,
+              documentationFormat: ['markdown', 'plaintext'],
+              deprecatedSupport: true,
+              preselectSupport: false,
+              tagSupport: {
+                valueSet: [CompletionItemTag.Deprecated]
+              }
+            },
+            contextSupport: false
+          },
+          publishDiagnostics: {
+            tagSupport: {
+              valueSet: [DiagnosticTag.Deprecated, DiagnosticTag.Unnecessary]
+            }
+          },
+          signatureHelp: {
+            dynamicRegistration: true,
+            signatureInformation: {
+              documentationFormat: ['markdown', 'plaintext']
+            }
+          },
+          declaration: {
+            dynamicRegistration: true,
+            linkSupport: true
+          },
+          definition: {
+            dynamicRegistration: true,
+            linkSupport: true
+          },
+          typeDefinition: {
+            dynamicRegistration: true,
+            linkSupport: true
+          },
+          implementation: {
+            dynamicRegistration: true,
+            linkSupport: true
+          }
+        } as lsp.TextDocumentClientCapabilities,
+        workspace: {
+          didChangeConfiguration: {
+            dynamicRegistration: true
+          }
+        } as lsp.WorkspaceClientCapabilities
+      } as lsp.ClientCapabilities,
+      initializationOptions: null,
+      processId: null,
+      workspaceFolders: null
+    };
+  }
+
   sendOpenWhenReady(documentInfo: IDocumentInfo) {
     if (this.isReady) {
       this.sendOpen(documentInfo);

packages/jupyterlab-lsp/src/features/diagnostics/diagnostics.ts

@@ -12,7 +12,7 @@ import { LSPConnection } from '../../connection';
 import { PositionConverter } from '../../converter';
 import { CodeMirrorIntegration } from '../../editor_integration/codemirror';
 import { FeatureSettings } from '../../feature';
-import { DiagnosticSeverity } from '../../lsp';
+import { DiagnosticSeverity, DiagnosticTag } from '../../lsp';
 import { IEditorPosition, IVirtualPosition } from '../../positioning';
 import { DefaultMap, uris_equal } from '../../utils';
 import { CodeMirrorVirtualEditor } from '../../virtual/codemirror_editor';
@@ -546,12 +546,6 @@ export class DiagnosticsCM extends CodeMirrorIntegration {
           return;
         }
 
-        let highest_severity_code = diagnostics
-          .map(diagnostic => diagnostic.severity || this.defaultSeverity)
-          .sort()[0];
-
-        const severity = DiagnosticSeverity[highest_severity_code];
-
         let ce_editor = document.get_editor_at_virtual_line(start);
         let cm_editor =
           this.virtual_editor.ce_editor_to_cm_editor.get(ce_editor)!;
@@ -621,11 +615,31 @@ export class DiagnosticsCM extends CodeMirrorIntegration {
         markers_to_retain.add(diagnostic_hash);
 
         if (!this.marked_diagnostics.has(diagnostic_hash)) {
+          const highestSeverityCode = diagnostics
+            .map(diagnostic => diagnostic.severity || this.defaultSeverity)
+            .sort()[0];
+
+          const severity = DiagnosticSeverity[highestSeverityCode];
+
+          const classNames = [
+            'cm-lsp-diagnostic',
+            'cm-lsp-diagnostic-' + severity
+          ];
+
+          const tags: lsProtocol.DiagnosticTag[] = [];
+          for (let diagnostic of diagnostics) {
+            if (diagnostic.tags) {
+              tags.push(...diagnostic.tags);
+            }
+          }
+          for (const tag of new Set(tags)) {
+            classNames.push('cm-lsp-diagnostic-tag-' + DiagnosticTag[tag]);
+          }
           let options: CodeMirror.TextMarkerOptions = {
             title: diagnostics
               .map(d => d.message + (d.source ? ' (' + d.source + ')' : ''))
               .join('\n'),
-            className: 'cm-lsp-diagnostic cm-lsp-diagnostic-' + severity
+            className: classNames.join(' ')
           };
           let marker;
           try {

packages/jupyterlab-lsp/src/lsp.ts

@@ -5,6 +5,15 @@ export enum DiagnosticSeverity {
   Hint = 4
 }
 
+export enum DiagnosticTag {
+  Unnecessary = 1,
+  Deprecated = 2
+}
+
+export enum CompletionItemTag {
+  Deprecated = 1
+}
+
 export enum CompletionItemKind {
   Text = 1,
   Method = 2,

packages/jupyterlab-lsp/style/highlight.css

@@ -9,6 +9,21 @@
   text-decoration-skip-ink: none;
 }
 
+.cm-lsp-diagnostic-tag-Unused {
+  /*
+   * LSP: "Clients are allowed to render diagnostics with this tag faded out instead of having an error squiggle."
+   */
+  opacity: 0.85;
+  text-decoration: none !important;
+}
+
+.cm-lsp-diagnostic-tag-Deprecated {
+  /*
+   * LSP: "Clients are allowed to rendered diagnostics with this tag strike through."
+   */
+  text-decoration: line-through !important;
+}
+
 .cm-lsp-diagnostic-Error {
   /*
     "wavy" would be ideal, but there seems to be a bug in Chrome which makes it

packages/lsp-ws-connection/src/ws-connection.ts

@@ -1,7 +1,7 @@
 import * as events from 'events';
 
 import type * as protocol from 'vscode-languageserver-protocol';
-import { CompletionItemTag, LocationLink } from 'vscode-languageserver-types';
+import type { LocationLink } from 'vscode-languageserver-types';
 import { ConsoleLogger, MessageConnection, listen } from 'vscode-ws-jsonrpc';
 
 import {
@@ -145,66 +145,11 @@ export class LspWsConnection
 
   /**
    * Initialization parameters to be sent to the language server.
-   * Subclasses can overload this when adding more features.
+   * Subclasses should override this when adding more features.
    */
   protected initializeParams(): protocol.InitializeParams {
     return {
-      capabilities: {
-        textDocument: {
-          hover: {
-            dynamicRegistration: true,
-            contentFormat: ['markdown', 'plaintext']
-          },
-          synchronization: {
-            dynamicRegistration: true,
-            willSave: false,
-            didSave: true,
-            willSaveWaitUntil: false
-          },
-          completion: {
-            dynamicRegistration: true,
-            completionItem: {
-              snippetSupport: false,
-              commitCharactersSupport: true,
-              documentationFormat: ['markdown', 'plaintext'],
-              deprecatedSupport: true,
-              preselectSupport: false,
-              tagSupport: {
-                valueSet: [CompletionItemTag.Deprecated]
-              }
-            },
-            contextSupport: false
-          },
-          signatureHelp: {
-            dynamicRegistration: true,
-            signatureInformation: {
-              documentationFormat: ['markdown', 'plaintext']
-            }
-          },
-          declaration: {
-            dynamicRegistration: true,
-            linkSupport: true
-          },
-          definition: {
-            dynamicRegistration: true,
-            linkSupport: true
-          },
-          typeDefinition: {
-            dynamicRegistration: true,
-            linkSupport: true
-          },
-          implementation: {
-            dynamicRegistration: true,
-            linkSupport: true
-          }
-        } as protocol.ClientCapabilities,
-        workspace: {
-          didChangeConfiguration: {
-            dynamicRegistration: true
-          }
-        } as protocol.WorkspaceClientCapabilities
-      } as protocol.ClientCapabilities,
-      initializationOptions: null,
+      capabilities: {} as protocol.ClientCapabilities,
       processId: null,
       rootUri: this.rootUri,
       workspaceFolders: null