Added latest spec changes, showDocument and onTypeRename (#431)

david-driscoll · web-flow · commit 508e3aca94a6 · 2020-11-14T17:38:16.000-05:00
* Added latest spec changes, showDocument and onTypeRename
diff --git a/.azure-pipelines.yml b/.azure-pipelines.yml
@@ -75,8 +75,9 @@ jobs:
       - template: support/install-dotnet.yml@rsg
         parameters:
           DotNetSdk:
-            - '2.x'
-            - '3.x'
+            - '2.1.x'
+            - '3.1.x'
+            - '5.0.x'
 
       - task: DotNetCoreCLI@2
         displayName: 'dotnet tool restore'
diff --git a/.build/.build.csproj b/.build/.build.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>net5.0</TargetFramework>
         <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
         <RootNamespace></RootNamespace>
         <IsPackable>False</IsPackable>
diff --git a/.build/Solution.cs b/.build/Solution.cs
@@ -67,6 +67,9 @@ public static RocketSurgeonGitHubActionsConfiguration Middleware(RocketSurgeonGi
                 new SetupDotNetStep("Use .NET Core 3.1 SDK") {
                     DotNetVersion = "3.1.x"
                 },
+                new SetupDotNetStep("Use .NET Core 5.0 SDK") {
+                    DotNetVersion = "5.0.x"
+                },
             }
         );
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -52,6 +52,10 @@ jobs:
         uses: actions/setup-dotnet@v1.7.2
         with:
           dotnet-version: '3.1.x'
+      - name: 🔨 Use .NET Core 5.0 SDK
+        uses: actions/setup-dotnet@v1.7.2
+        with:
+          dotnet-version: '5.0.x'
       - name: 🎁 dotnet tool restore
         run: |
           dotnet tool restore
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,11 +1,12 @@
 {
     "coverage-gutters.lcovname": "*.info",
     "coverage-gutters.showGutterCoverage": true,
+    "omnisharp.enableLspDriver": true,
     "cSpell.words": [
         "Unregisterations",
         "Unregistration",
         "Unregistrations",
         "deresult",
         "reciever"
     ]
-}
+}
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -2,16 +2,16 @@
 <Project>
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Rocket.Surgery.MSBuild.CI" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Rocket.Surgery.MSBuild.Metadata" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Rocket.Surgery.MSBuild.SourceLink" Version="1.0.0" PrivateAssets="All" />
+    <PackageReference Include="Rocket.Surgery.MSBuild.CI" Version="1.1.0" PrivateAssets="All" />
+    <PackageReference Include="Rocket.Surgery.MSBuild.Metadata" Version="1.1.0" PrivateAssets="All" />
+    <PackageReference Include="Rocket.Surgery.MSBuild.SourceLink" Version="1.1.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="All" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Update="GitVersion.Tool" Version="5.5.0" />
+    <PackageReference Update="GitVersion.Tool" Version="5.5.1" />
     <PackageReference Update="JetBrains.ReSharper.CommandLineTools" Version="2020.2.4" />
     <PackageReference Update="ReportGenerator" Version="4.8.0" />
-    <PackageReference Update="Rocket.Surgery.Nuke" Version="0.14.0-beta.10" />
+    <PackageReference Update="Rocket.Surgery.Nuke" Version="0.14.2" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Update="Microsoft.Extensions.Logging" Version="2.0.0" />
diff --git a/LSP.sln b/LSP.sln
@@ -14,7 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{2F323ED5-E
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{AE4D7807-6F78-428C-A0D9-914BA583A104}"
-	ProjectSection(SolutionItems) = preProject
+	ProjectSection(SolutionItems) = prePrlaoject
 		.appveyor.yml = .appveyor.yml
 		.editorconfig = .editorconfig
 		.gitattributes = .gitattributes
diff --git a/language-server-protocol.sha.txt b/language-server-protocol.sha.txt
@@ -1,4 +1,4 @@
 -- This is the last commit we caught up with https://github.com/Microsoft/language-server-protocol/commits/gh-pages
-lastSha: 558f1e114a3dc53da7c3686a657ebef070275d63
+lastSha: 0e116448e3b3f4ce0b983768c045dba0a41b6a72
 
-https://github.com/Microsoft/language-server-protocol/compare/558f1e114a3dc53da7c3686a657ebef070275d63..gh-pages
+https://github.com/Microsoft/language-server-protocol/compare/0e116448e3b3f4ce0b983768c045dba0a41b6a72..gh-pages
diff --git a/sample/SampleServer/Program.cs b/sample/SampleServer/Program.cs
@@ -30,7 +30,7 @@ private static async Task MainAsync(string[] args)
 
             Log.Logger.Information("This only goes file...");
 
-            IObserver<WorkDoneProgressReport> workDone = null;
+            IObserver<WorkDoneProgressReport> workDone = null!;
 
             var server = await LanguageServer.From(
                 options =>
diff --git a/sample/SampleServer/SemanticTokensHandler.cs b/sample/SampleServer/SemanticTokensHandler.cs
@@ -30,15 +30,15 @@ public SemanticTokensHandler(ILogger<SemanticTokensHandler> logger) : base(
         ) =>
             _logger = logger;
 
-        public override async Task<SemanticTokens> Handle(
+        public override async Task<SemanticTokens?> Handle(
             SemanticTokensParams request, CancellationToken cancellationToken
         )
         {
             var result = await base.Handle(request, cancellationToken);
             return result;
         }
 
-        public override async Task<SemanticTokens> Handle(
+        public override async Task<SemanticTokens?> Handle(
             SemanticTokensRangeParams request, CancellationToken cancellationToken
         )
         {
@@ -66,7 +66,7 @@ CancellationToken cancellationToken
             var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(identifier), cancellationToken);
             await Task.Yield();
 
-            foreach (var (line, text) in content.Split('\n').Select((text, line) => ( line, text )))
+            foreach (var (line, text) in content.Split('\n').Select((text, line) => (line, text)))
             {
                 var parts = text.TrimEnd().Split(';', ' ', '.', '"', '(', ')');
                 var index = 0;
diff --git a/sample/SampleServer/TextDocumentHandler.cs b/sample/SampleServer/TextDocumentHandler.cs
@@ -164,7 +164,7 @@ public MyWorkspaceSymbolsHandler(IServerWorkDoneManager serverWorkDoneManager, I
         {
             _serverWorkDoneManager = serverWorkDoneManager;
             _progressManager = progressManager;
-            this._logger = logger;
+            _logger = logger;
         }
 
         public override async Task<Container<SymbolInformation>> Handle(
diff --git a/src/Dap.Client/Configuration/ChainedConfigurationProvider.cs b/src/Dap.Client/Configuration/ChainedConfigurationProvider.cs
@@ -87,7 +87,7 @@ public void Dispose()
         {
             if (_shouldDisposeConfig)
             {
-                (_config as IDisposable)?.Dispose();
+                ( _config as IDisposable )?.Dispose();
             }
         }
     }
diff --git a/src/Protocol/Client/Capabilities/ClientCapabilities.cs b/src/Protocol/Client/Capabilities/ClientCapabilities.cs
@@ -24,9 +24,48 @@ public class ClientCapabilities : CapabilitiesBase
         [Optional]
         public WindowClientCapabilities? Window { get; set; }
 
+        /// <summary>
+        /// General client capabilities.
+        /// </summary>
+        [Optional]
+        public GeneralClientCapabilities? General { get; set; }
+
         /// <summary>
         /// Experimental client capabilities.
         /// </summary>
         public IDictionary<string, JToken> Experimental { get; set; } = new Dictionary<string, JToken>();
     }
+
+    /// <summary>
+    /// General client capabilities.
+    /// </summary>
+    public class GeneralClientCapabilities
+    {
+        /// <summary>
+        /// Client capabilities specific to regular expressions.
+        ///
+        /// @since 3.16.0 - proposed state
+        /// </summary>
+        [Optional]
+        public RegularExpressionsClientCapabilities? RegularExpressions { get; set; }
+    }
+
+    /// <summary>
+    /// Client capabilities specific to regular expressions.
+    ///
+    /// @since 3.16.0 - proposed state
+    /// </summary>
+    public class RegularExpressionsClientCapabilities
+    {
+        /// <summary>
+        /// The engine's name.
+        /// </summary>
+        public string Engine { get; set; } = null!;
+
+        /// <summary>
+        /// The engine's version.
+        /// </summary>
+        [Optional]
+        public string? Version { get; set; }
+    }
 }
diff --git a/src/Protocol/Client/Capabilities/CompletionItemCapabilityOptions.cs b/src/Protocol/Client/Capabilities/CompletionItemCapabilityOptions.cs
@@ -93,7 +93,7 @@ public class CompletionItemCapabilityOptions
 
     public class CompletionItemInsertTextModeSupportCapabilityOptions
     {
-        public Container<InsertTextMode> ValueSet { get; set; }
+        public Container<InsertTextMode> ValueSet { get; set; } = null!;
     }
 
 }
diff --git a/src/Protocol/Client/Capabilities/OnTypeRenameClientCapabilities.cs b/src/Protocol/Client/Capabilities/OnTypeRenameClientCapabilities.cs
@@ -0,0 +1,10 @@
+using OmniSharp.Extensions.LanguageServer.Protocol.Document;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities
+{
+    [CapabilityKey(nameof(ClientCapabilities.TextDocument), nameof(TextDocumentClientCapabilities.OnTypeRename))]
+    public class OnTypeRenameClientCapabilities : DynamicCapability, ConnectedCapability<IOnTypeRenameHandler>
+    {
+
+    }
+}
diff --git a/src/Protocol/Client/Capabilities/ShowDocumentClientCapabilities.cs b/src/Protocol/Client/Capabilities/ShowDocumentClientCapabilities.cs
@@ -0,0 +1,21 @@
+using System;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities
+{
+    /// <summary>
+    /// Capabilities specific to the showDocument request
+    ///
+    /// @since 3.16.0 - proposed state
+    /// </summary>
+    [Obsolete(Constants.Proposal)]
+    [CapabilityKey(nameof(ClientCapabilities.Window), nameof(WindowClientCapabilities.ShowDocument))]
+    public class ShowDocumentClientCapabilities
+    {
+        /// <summary>
+        /// Capabilities specific to the `MessageActionItem` type.
+        /// </summary>
+        [Optional]
+        public bool Support { get; set; }
+    }
+}
diff --git a/src/Protocol/Client/Capabilities/TextDocumentClientCapabilities.cs b/src/Protocol/Client/Capabilities/TextDocumentClientCapabilities.cs
@@ -116,6 +116,13 @@ public class TextDocumentClientCapabilities : CapabilitiesBase
         /// </summary>
         public Supports<SelectionRangeCapability?> SelectionRange { get; set; }
 
+        /// <summary>
+        /// Capabilities specific to the `textDocument/onTypeRename` request.
+        ///
+        /// Since 3.16.0
+        /// </summary>
+        public Supports<OnTypeRenameClientCapabilities?> OnTypeRename { get; set; }
+
         /// <summary>
         /// Capabilities specific to `textDocument/publishDiagnostics`.
         /// </summary>
diff --git a/src/Protocol/Client/Capabilities/WindowClientCapabilities.cs b/src/Protocol/Client/Capabilities/WindowClientCapabilities.cs
@@ -16,5 +16,12 @@ public class WindowClientCapabilities : CapabilitiesBase
         /// @since 3.16.0 - proposed state
          /// </summary>
         public Supports<ShowMessageRequestClientCapabilities> ShowMessage { get; set; }
+
+        /// <summary>
+        /// Client capabilities for the show document request.
+        ///
+        /// @since 3.16.0 - proposed state
+        /// </summary>
+        public Supports<ShowDocumentClientCapabilities> ShowDocument { get; set; }
     }
 }
diff --git a/src/Protocol/Document/IOnTypeRenameHandler.cs b/src/Protocol/Document/IOnTypeRenameHandler.cs
@@ -0,0 +1,31 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using OmniSharp.Extensions.JsonRpc;
+using OmniSharp.Extensions.JsonRpc.Generation;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Document
+{
+    [Parallel]
+    [Obsolete(Constants.Proposal)]
+    [Method(TextDocumentNames.OnTypeRename, Direction.ClientToServer)]
+    [GenerateHandlerMethods]
+    [GenerateRequestMethods(typeof(ITextDocumentLanguageClient), typeof(ILanguageClient))]
+    public interface IOnTypeRenameHandler : IJsonRpcRequestHandler<OnTypeRenameParams, OnTypeRenameRanges?>, IRegistration<OnTypeRenameRegistrationOptions>, ICapability<OnTypeRenameClientCapabilities>
+    {
+    }
+
+    public abstract class OnTypeRenameHandler : IOnTypeRenameHandler
+    {
+        private readonly OnTypeRenameRegistrationOptions _options;
+        public OnTypeRenameHandler(OnTypeRenameRegistrationOptions registrationOptions) => _options = registrationOptions;
+
+        public OnTypeRenameRegistrationOptions GetRegistrationOptions() => _options;
+        public abstract Task<OnTypeRenameRanges?> Handle(OnTypeRenameParams request, CancellationToken cancellationToken);
+        public virtual void SetCapability(OnTypeRenameClientCapabilities capability) => Capability = capability;
+        protected OnTypeRenameClientCapabilities Capability { get; private set; } = null!;
+    }
+}
diff --git a/src/Protocol/Models/ApplyWorkspaceEditResponse.cs b/src/Protocol/Models/ApplyWorkspaceEditResponse.cs
@@ -17,5 +17,14 @@ public class ApplyWorkspaceEditResponse
         /// </summary>
         [Optional]
         public string? FailureReason { get; set; }
+
+        /// <summary>
+        /// Depending on the client's failure handling strategy `failedChange`
+        /// might contain the index of the change that failed. This property is
+        /// only available if the client signals a `failureHandlingStrategy`
+        /// in its client capabilities.
+        /// </summary>
+        [Optional]
+        public int? FailedChange { get; set; }
     }
 }
diff --git a/src/Protocol/Models/DidSaveTextDocumentParams.cs b/src/Protocol/Models/DidSaveTextDocumentParams.cs
@@ -10,11 +10,14 @@ public class DidSaveTextDocumentParams : ITextDocumentIdentifierParams, IRequest
         /// <summary>
         /// The document that was saved.
         /// </summary>
+        /// <remarks>
+        /// TODO: Change to RequiredVersionedTextDocumentIdentifier (or in the future will be VersionedTextDocumentIdentifier)
+        /// </remarks>
         public TextDocumentIdentifier TextDocument { get; set; } = null!;
 
         /// <summary>
         /// Optional the content when saved. Depends on the includeText value
-        /// when the save notifcation was requested.
+        /// when the save notification was requested.
         /// </summary>
         [Optional]
         public string? Text { get; set; }
diff --git a/src/Protocol/Models/FoldingRangeRegistrationOptions.cs b/src/Protocol/Models/FoldingRangeRegistrationOptions.cs
@@ -13,7 +13,11 @@ class FoldingRangeRegistrationOptionsConverter : RegistrationOptionsConverterBas
             public FoldingRangeRegistrationOptionsConverter() : base(nameof(ServerCapabilities.FoldingRangeProvider))
             {
             }
-            public override StaticOptions Convert(FoldingRangeRegistrationOptions source) => new StaticOptions { WorkDoneProgress = source.WorkDoneProgress };
+
+            public override StaticOptions Convert(FoldingRangeRegistrationOptions source) => new StaticOptions {
+                WorkDoneProgress = source.WorkDoneProgress,
+                DocumentSelector = source.DocumentSelector
+            };
         }
     }
 }
diff --git a/src/Protocol/Models/InsertReplaceEdit.cs b/src/Protocol/Models/InsertReplaceEdit.cs
@@ -13,17 +13,17 @@ public class InsertReplaceEdit
         /// <summary>
         /// The string to be inserted.
         /// </summary>
-        public string NewText { get; set; }
+        public string NewText { get; set; } = null!;
 
         /// <summary>
         /// The range if the insert is requested
         /// </summary>
-        public Range Insert { get; set; }
+        public Range Insert { get; set; } = null!;
 
         /// <summary>
         /// The range if the replace is requested.
         /// </summary>
-        public Range Replace { get; set; }
+        public Range Replace { get; set; } = null!;
 
         private string DebuggerDisplay => $"{Insert} / {Replace} {( string.IsNullOrWhiteSpace(NewText) ? string.Empty : NewText.Length > 30 ? NewText.Substring(0, 30) : NewText )}";
 
diff --git a/src/Protocol/Models/OnTypeRenameParams.cs b/src/Protocol/Models/OnTypeRenameParams.cs
@@ -0,0 +1,11 @@
+using MediatR;
+using OmniSharp.Extensions.JsonRpc;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
+{
+    [Parallel]
+    [Method(TextDocumentNames.OnTypeRename, Direction.ClientToServer)]
+    public class OnTypeRenameParams : WorkDoneTextDocumentPositionParams, IRequest<OnTypeRenameRanges>
+    {
+    }
+}
diff --git a/src/Protocol/Models/OnTypeRenameRanges.cs b/src/Protocol/Models/OnTypeRenameRanges.cs
@@ -0,0 +1,21 @@
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
+{
+    public class OnTypeRenameRanges
+    {
+        /// <summary>
+        /// A list of ranges that can be renamed together. The ranges must have
+        /// identical length and contain identical text content. The ranges cannot overlap.
+        /// </summary>
+        public Container<Range> Ranges { get; set; } = null!;
+
+        /// <summary>
+        /// An optional word pattern (regular expression) that describes valid contents for
+        /// the given ranges. If no pattern is provided, the client configuration's word
+        /// pattern will be used.
+        /// </summary>
+        [Optional]
+        public string? WordPattern { get; set; }
+    }
+}
diff --git a/src/Protocol/Models/OnTypeRenameRegistrationOptions.cs b/src/Protocol/Models/OnTypeRenameRegistrationOptions.cs
diff --git a/src/Protocol/Models/OptionalVersionedTextDocumentIdentifier.cs b/src/Protocol/Models/OptionalVersionedTextDocumentIdentifier.cs
diff --git a/src/Protocol/Models/Proposals/CallHierarchyRegistrationOptions.cs b/src/Protocol/Models/Proposals/CallHierarchyRegistrationOptions.cs
diff --git a/src/Protocol/Models/ShowDocumentParams.cs b/src/Protocol/Models/ShowDocumentParams.cs
diff --git a/src/Protocol/Models/ShowDocumentResult.cs b/src/Protocol/Models/ShowDocumentResult.cs
diff --git a/src/Protocol/Models/TypeDefinitionRegistrationOptions.cs b/src/Protocol/Models/TypeDefinitionRegistrationOptions.cs
diff --git a/src/Protocol/Models/VersionedTextDocumentIdentifier.cs b/src/Protocol/Models/VersionedTextDocumentIdentifier.cs
diff --git a/src/Protocol/Protocol.csproj b/src/Protocol/Protocol.csproj
diff --git a/src/Protocol/Server/Capabilities/ServerCapabilities.cs b/src/Protocol/Server/Capabilities/ServerCapabilities.cs
diff --git a/src/Protocol/TextDocumentNames.cs b/src/Protocol/TextDocumentNames.cs
diff --git a/src/Protocol/Window/IShowDocumentRequestHandler.cs b/src/Protocol/Window/IShowDocumentRequestHandler.cs
diff --git a/src/Protocol/WindowNames.cs b/src/Protocol/WindowNames.cs

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@ public static RocketSurgeonGitHubActionsConfiguration Middleware(RocketSurgeonGi`
`67`	`67`	`new SetupDotNetStep("Use .NET Core 3.1 SDK") {`
`68`	`68`	`DotNetVersion = "3.1.x"`
`69`	`69`	`},`
	`70`	`+ new SetupDotNetStep("Use .NET Core 5.0 SDK") {`
	`71`	`+ DotNetVersion = "5.0.x"`
	`72`	`+ },`
`70`	`73`	`}`
`71`	`74`	`);`
`72`	`75`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,12 @@`
`1`	`1`	`{`
`2`	`2`	`"coverage-gutters.lcovname": "*.info",`
`3`	`3`	`"coverage-gutters.showGutterCoverage": true,`
	`4`	`+ "omnisharp.enableLspDriver": true,`
`4`	`5`	`"cSpell.words": [`
`5`	`6`	`"Unregisterations",`
`6`	`7`	`"Unregistration",`
`7`	`8`	`"Unregistrations",`
`8`	`9`	`"deresult",`
`9`	`10`	`"reciever"`
`10`	`11`	`]`
`11`		`-}`
	`12`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -30,15 +30,15 @@ public SemanticTokensHandler(ILogger<SemanticTokensHandler> logger) : base(`
`30`	`30`	`) =>`
`31`	`31`	`_logger = logger;`
`32`	`32`
`33`		`- public override async Task<SemanticTokens> Handle(`
	`33`	`+ public override async Task<SemanticTokens?> Handle(`
`34`	`34`	`SemanticTokensParams request, CancellationToken cancellationToken`
`35`	`35`	`)`
`36`	`36`	`{`
`37`	`37`	`var result = await base.Handle(request, cancellationToken);`
`38`	`38`	`return result;`
`39`	`39`	`}`
`40`	`40`
`41`		`- public override async Task<SemanticTokens> Handle(`
	`41`	`+ public override async Task<SemanticTokens?> Handle(`
`42`	`42`	`SemanticTokensRangeParams request, CancellationToken cancellationToken`
`43`	`43`	`)`
`44`	`44`	`{`
`@@ -66,7 +66,7 @@ CancellationToken cancellationToken`
`66`	`66`	`var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(identifier), cancellationToken);`
`67`	`67`	`await Task.Yield();`
`68`	`68`
`69`		`- foreach (var (line, text) in content.Split('\n').Select((text, line) => ( line, text )))`
	`69`	`+ foreach (var (line, text) in content.Split('\n').Select((text, line) => (line, text)))`
`70`	`70`	`{`
`71`	`71`	`var parts = text.TrimEnd().Split(';', ' ', '.', '"', '(', ')');`
`72`	`72`	`var index = 0;`