Added Handler for Semantic Tokenization

src/PowerShellEditorServices/Services/DebugAdapter/Handlers/PsesSemanticTokens.cs → src/PowerShellEditorServices/Services/TextDocument/Handlers/PsesSemanticTokens.cs

@@ -3,22 +3,22 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using System;
+using System.Management.Automation.Language;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using Microsoft.PowerShell.EditorServices.Services;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
-using System.Management.Automation.Language;
+using Microsoft.PowerShell.EditorServices.Utility;
 using OmniSharp.Extensions.LanguageServer.Protocol;
 using OmniSharp.Extensions.LanguageServer.Protocol.Document.Proposals;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals;
-using System;
-using Microsoft.PowerShell.EditorServices.Utility;
 
 namespace Microsoft.PowerShell.EditorServices.Handlers
 {
-    //Disable warnings having to do with SemanticTokensHandler being labelled obsolete
+    //SemanticTokensHandler is labeled "Obsolete" because that is how Omnisharp marks proposed LSP features. Since we want this proposed feature, we disable this warning.
 #pragma warning disable 618
     internal class PsesSemanticTokens : SemanticTokensHandler
     {
@@ -27,8 +27,8 @@ internal class PsesSemanticTokens : SemanticTokensHandler
         static readonly SemanticTokensRegistrationOptions _registrationOptions = new SemanticTokensRegistrationOptions() {
             DocumentSelector = LspUtils.PowerShellDocumentSelector,
             Legend = new SemanticTokensLegend(),
-            DocumentProvider = new Supports<SemanticTokensDocumentProviderOptions>(true,
-                new SemanticTokensDocumentProviderOptions() {
+            DocumentProvider = new Supports<SemanticTokensDocumentProviderOptions>(isSupported: true,
+                new SemanticTokensDocumentProviderOptions {
                     Edits = true
                 }),
             RangeProvider = true
@@ -70,7 +70,8 @@ private static void PushToken(Token token, SemanticTokensBuilder builder)
             int line = token.Extent.StartLineNumber - 1;
             int index = token.Extent.StartColumnNumber - 1;
 
-            builder.Push(line, index, token.Text.Length, MapSemanticToken(token), Array.Empty<string>());
+            builder.Push(line: line, @char: index, length: token.Text.Length,
+                tokenType: MapSemanticToken(token), tokenModifiers: Array.Empty<string>());
         }
 
         private static SemanticTokenType MapSemanticToken(Token token)

test/PowerShellEditorServices.Test.E2E/LanguageServerProtocolMessageTests.cs

@@ -19,9 +19,12 @@
 using OmniSharp.Extensions.LanguageServer.Protocol.Document;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using OmniSharp.Extensions.LanguageServer.Protocol.Workspace;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals;
 using Xunit;
 using Xunit.Abstractions;
 using Range = OmniSharp.Extensions.LanguageServer.Protocol.Models.Range;
+using OmniSharp.Extensions.LanguageServer.Protocol.Document.Proposals;
+using Microsoft.PowerShell.EditorServices.Utility;
 
 namespace PowerShellEditorServices.Test.E2E
 {
@@ -1136,5 +1139,36 @@ await PsesLanguageClient
 
             Assert.Equal("Get-ChildItem", expandAliasResult.Text);
         }
+
+#pragma warning disable 618
+         [Fact]
+        public async Task CanSendSemanticTokenRequest()
+        {
+
+            //var tokens = semanticTokensBuilder.Commit().GetSemanticTokens();
+            string scriptPath = NewTestFile(@"
+function add {}
+");
+            var result =
+                await PsesLanguageClient
+                    .SendRequest<SemanticTokensParams>(
+                        "textDocument/semanticTokens",
+                        new SemanticTokensParams
+                        {
+                            TextDocument = new TextDocumentIdentifier
+                            {
+                                Uri = new Uri(scriptPath)
+                            }
+                        })
+                    .Returning<SemanticTokens>(CancellationToken.None);
+
+            scriptPath = null;
+            // Information about how this data is generated can be found at
+            // https://github.com/microsoft/vscode-extension-samples/blob/5ae1f7787122812dcc84e37427ca90af5ee09f14/semantic-tokens-sample/vscode.proposed.d.ts#L71
+            var arr = new int[35]{0,0,2,0,0,1,0,8,2,0,0,9,3,0,0,0,4,1,0,0,0,1,1,0,0,0,1,2,0,0,1,1,0,0,0};
+            Assert.Equal(result.Data.ToArray(), arr);
+        }
+
+#pragma warning restore 618
     }
 }