plugin: add showDeprecated support

The commit adds support for the `showDeprecated` monaco editor option which is contributed by language-servers to display deprecated strike-throughs in code which is deprecated. Signed-off-by: vince-fugnitto <[email protected]>
eclipse-theia · Jul 9, 2021 · 346d103 · 346d103
1 parent 8e9ce81
commit 346d103
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 2 deletions.
diff --git a/packages/monaco/src/browser/protocol-to-monaco-converter.ts b/packages/monaco/src/browser/protocol-to-monaco-converter.ts
@@ -131,7 +131,8 @@ export class ProtocolToMonacoConverter {
             startColumn: diagnostic.range.start.character + 1,
             endLineNumber: diagnostic.range.end.line + 1,
             endColumn: diagnostic.range.end.character + 1,
-            relatedInformation: this.asRelatedInformations(diagnostic.relatedInformation)
+            relatedInformation: this.asRelatedInformations(diagnostic.relatedInformation),
+            tags: diagnostic.tags
         };
     }
 

diff --git a/packages/plugin-ext/src/common/plugin-api-rpc-model.ts b/packages/plugin-ext/src/common/plugin-api-rpc-model.ts
@@ -219,6 +219,7 @@ export enum MarkerSeverity {
 
 export enum MarkerTag {
     Unnecessary = 1,
+    Deprecated = 2,
 }
 
 export interface ParameterInformation {

diff --git a/packages/plugin-ext/src/main/browser/languages-main.ts b/packages/plugin-ext/src/main/browser/languages-main.ts
@@ -57,6 +57,7 @@ import { ObjectIdentifier } from '../../common/object-identifier';
 import { mixin } from '../../common/types';
 import { relative } from '../../common/paths-util';
 import { decodeSemanticTokensDto } from '../../common/semantic-tokens-dto';
+import { DiagnosticTag } from '@theia/core/shared/vscode-languageserver-protocol';
 
 @injectable()
 export class LanguagesMainImpl implements LanguagesMain, Disposable {
@@ -919,6 +920,10 @@ function reviveMarker(marker: MarkerData): vst.Diagnostic {
         monacoMarker.relatedInformation = marker.relatedInformation.map(reviveRelated);
     }
 
+    if (marker.tags) {
+        monacoMarker.tags = marker.tags.map(reviveTag);
+    }
+
     return monacoMarker;
 }
 
@@ -955,6 +960,15 @@ function reviveRelated(related: RelatedInformation): vst.DiagnosticRelatedInform
     };
 }
 
+function reviveTag(tag: DiagnosticTag): vst.DiagnosticTag {
+    let diagnosticTag: vst.DiagnosticTag;
+    switch (tag) {
+        case 1: diagnosticTag = DiagnosticTag.Unnecessary;
+        case 2: diagnosticTag = DiagnosticTag.Deprecated;
+    }
+    return diagnosticTag;
+}
+
 function reviveRegExp(regExp?: SerializedRegExp): RegExp | undefined {
     if (typeof regExp === 'undefined' || regExp === null) {
         return undefined;

diff --git a/packages/plugin-ext/src/plugin/languages/diagnostics.ts b/packages/plugin-ext/src/plugin/languages/diagnostics.ts
@@ -223,7 +223,8 @@ export class DiagnosticCollection implements theia.DiagnosticCollection {
                                         startLineNumber: lastMarker.startLineNumber,
                                         startColumn: lastMarker.startColumn,
                                         endLineNumber: lastMarker.endLineNumber,
-                                        endColumn: lastMarker.endColumn
+                                        endColumn: lastMarker.endColumn,
+                                        tags: lastMarker.tags,
                                     });
                                     markers.push([uri.toString(), uriMarkers]);
                                     continue nextUri;

diff --git a/packages/plugin-ext/src/plugin/type-converters.ts b/packages/plugin-ext/src/plugin/type-converters.ts
@@ -377,6 +377,7 @@ function convertTags(tags: types.DiagnosticTag[] | undefined): types.MarkerTag[]
     for (const tag of tags) {
         switch (tag) {
             case types.DiagnosticTag.Unnecessary: markerTags.push(types.MarkerTag.Unnecessary);
+            case types.DiagnosticTag.Deprecated: markerTags.push(types.MarkerTag.Deprecated);
         }
     }
     return markerTags;

diff --git a/packages/plugin-ext/src/plugin/types-impl.ts b/packages/plugin-ext/src/plugin/types-impl.ts
@@ -944,6 +944,7 @@ export class Location {
 
 export enum DiagnosticTag {
     Unnecessary = 1,
+    Deprecated = 2,
 }
 
 export enum CompletionItemTag {
@@ -975,6 +976,7 @@ export enum MarkerSeverity {
 
 export enum MarkerTag {
     Unnecessary = 1,
+    Deprecated = 2,
 }
 
 export class ParameterInformation {

diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts
@@ -7332,6 +7332,12 @@ declare module '@theia/plugin' {
          * instead of fading it out.
          */
         Unnecessary = 1,
+        /**
+         * Deprecated or obsolete code.
+         *
+         * Diagnostics with this tag are rendered with a strike through.
+         */
+        Deprecated = 2,
     }
 
     /**