[release/insiders] Adopt editor InlinePromptService for documentation comments

eng/Packages.props

@@ -5,7 +5,7 @@
     <_BasicReferenceAssembliesVersion>1.8.8</_BasicReferenceAssembliesVersion>
     <!-- CodeStyleAnalyzerVersion should we updated together with version of dotnet-format in dotnet-tools.json -->
     <CodeStyleAnalyzerVersion>4.8.0-3.final</CodeStyleAnalyzerVersion>
-    <VisualStudioEditorPackagesVersion>18.9.123</VisualStudioEditorPackagesVersion>
+    <VisualStudioEditorPackagesVersion>18.9.179</VisualStudioEditorPackagesVersion>
     <ILAsmPackageVersion>9.0.0-rc.2.24462.10</ILAsmPackageVersion>
     <ILDAsmPackageVersion>6.0.0-rtm.21518.12</ILDAsmPackageVersion>
     <MicrosoftILVerificationVersion>7.0.0-alpha.1.22060.1</MicrosoftILVerificationVersion>
@@ -83,7 +83,7 @@
     <PackageVersion Include="Microsoft.VisualStudio.InteractiveWindow" Version="4.0.0" />
     <PackageVersion Include="Microsoft.VisualStudio.VsInteractiveWindow" Version="4.0.0" />
     <PackageVersion Include="Microsoft.VisualStudio.Search" Version="17.14.39337" />
-    <PackageVersion Include="Microsoft.VisualStudio.Shell.Styles" Version="18.9.493" />
+    <PackageVersion Include="Microsoft.VisualStudio.Shell.Styles" Version="18.9.918" />
     <PackageVersion Include="Microsoft.VisualStudio.WinForms.Interfaces" Version="17.0.0-previews-4-31709-430" />
     <PackageVersion Include="Microsoft.VisualStudio.Workspace.VSIntegration" Version="17.9.29-preview-0001" />
     <PackageVersion Include="Microsoft.VisualStudio.Copilot.Roslyn.SemanticSearch" Version="18.0.634-alpha" />
@@ -99,33 +99,33 @@
       Subset of Microsoft.VisualStudio.Sdk meta-package (run `csi generate-vssdk-versions.csx` to update based on VSSDK meta-package).
       See https://github.com/dotnet/arcade/blob/main/Documentation/MirroringPackages.md if any of these packages fail to restore.
     -->
-    <PackageVersion Include="Microsoft.ServiceHub.Framework" Version="4.10.128" />
-    <PackageVersion Include="Microsoft.VisualStudio.Composition" Version="18.9.15" />
-    <PackageVersion Include="Microsoft.VisualStudio.Composition.Analyzers" Version="18.9.15" />
+    <PackageVersion Include="Microsoft.ServiceHub.Framework" Version="4.10.147" />
+    <PackageVersion Include="Microsoft.VisualStudio.Composition" Version="18.9.20" />
+    <PackageVersion Include="Microsoft.VisualStudio.Composition.Analyzers" Version="18.9.20" />
     <PackageVersion Include="Microsoft.VisualStudio.CoreUtility" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Editor" Version="$(VisualStudioEditorPackagesVersion)" />
-    <PackageVersion Include="Microsoft.VisualStudio.ImageCatalog" Version="18.9.438" />
-    <PackageVersion Include="Microsoft.VisualStudio.Imaging" Version="18.9.453" />
-    <PackageVersion Include="Microsoft.VisualStudio.Imaging.Interop.14.0.DesignTime" Version="18.9.438" />
+    <PackageVersion Include="Microsoft.VisualStudio.ImageCatalog" Version="18.9.915" />
+    <PackageVersion Include="Microsoft.VisualStudio.Imaging" Version="18.9.918" />
+    <PackageVersion Include="Microsoft.VisualStudio.Imaging.Interop.14.0.DesignTime" Version="18.9.911" />
     <PackageVersion Include="Microsoft.VisualStudio.Language" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Language.NavigateTo.Interfaces" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Language.StandardClassification" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.LanguageServer.Client" Version="18.9.6" />
     <PackageVersion Include="Microsoft.VisualStudio.RemoteControl" Version="16.3.52" />
-    <PackageVersion Include="Microsoft.VisualStudio.RpcContracts" Version="18.9.453" />
-    <PackageVersion Include="Microsoft.VisualStudio.Shell.15.0" Version="18.9.493" />
-    <PackageVersion Include="Microsoft.VisualStudio.Telemetry" Version="18.3.113" />
+    <PackageVersion Include="Microsoft.VisualStudio.RpcContracts" Version="18.9.918" />
+    <PackageVersion Include="Microsoft.VisualStudio.Shell.15.0" Version="18.9.918" />
+    <PackageVersion Include="Microsoft.VisualStudio.Telemetry" Version="18.3.124" />
     <PackageVersion Include="Microsoft.VisualStudio.Text.Data" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Text.Logic" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Text.UI" Version="$(VisualStudioEditorPackagesVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Text.UI.Wpf" Version="$(VisualStudioEditorPackagesVersion)" />
-    <PackageVersion Include="Microsoft.VisualStudio.Threading" Version="18.7.19" />
-    <PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.7.19" />
-    <PackageVersion Include="Microsoft.VisualStudio.Utilities" Version="18.9.453" />
+    <PackageVersion Include="Microsoft.VisualStudio.Threading" Version="18.7.23" />
+    <PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.7.23" />
+    <PackageVersion Include="Microsoft.VisualStudio.Utilities" Version="18.9.918" />
     <PackageVersion Include="Microsoft.VisualStudio.Utilities.Internal" Version="16.3.90" />
     <PackageVersion Include="Nerdbank.Streams" Version="2.13.16" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
-    <PackageVersion Include="StreamJsonRpc" Version="2.26.5" />
+    <PackageVersion Include="StreamJsonRpc" Version="2.26.10" />
     <PackageVersion Include="MessagePack" Version="2.5.302" />
 
     <!--
@@ -265,7 +265,7 @@
     <PackageVersion Include="Microsoft.VisualStudio.Diagnostics.Measurement" Version="17.9.36343-preview.3" />
     <PackageVersion Include="Microsoft.VisualStudio.Diagnostics.PerformanceProvider" Version="17.8.36726" />
     <PackageVersion Include="System.Management" Version="9.0.5" />
-    <PackageVersion Include="System.Drawing.Common" Version="10.0.3" />
+    <PackageVersion Include="System.Drawing.Common" Version="10.0.8" />
     <PackageVersion Include="NuGet.SolutionRestoreManager.Interop" Version="4.8.0" />
     <PackageVersion Include="Moq" Version="4.10.1" />
     <PackageVersion Include="System.CodeDom" Version="10.0.8" />

eng/Version.Details.props

@@ -11,32 +11,32 @@ This file should be imported by eng/Versions.props
     <MicrosoftDotNetXliffTasksPackageVersion>10.0.0-beta.26378.2</MicrosoftDotNetXliffTasksPackageVersion>
     <!-- dotnet-dotnet dependencies -->
     <MicrosoftBclAsyncInterfacesPackageVersion>10.0.8</MicrosoftBclAsyncInterfacesPackageVersion>
-    <MicrosoftExtensionsConfigurationPackageVersion>10.0.1</MicrosoftExtensionsConfigurationPackageVersion>
-    <MicrosoftExtensionsDependencyInjectionPackageVersion>10.0.1</MicrosoftExtensionsDependencyInjectionPackageVersion>
-    <MicrosoftExtensionsFileSystemGlobbingPackageVersion>10.0.1</MicrosoftExtensionsFileSystemGlobbingPackageVersion>
-    <MicrosoftExtensionsLoggingPackageVersion>10.0.1</MicrosoftExtensionsLoggingPackageVersion>
-    <MicrosoftExtensionsLoggingAbstractionsPackageVersion>10.0.1</MicrosoftExtensionsLoggingAbstractionsPackageVersion>
-    <MicrosoftExtensionsLoggingConsolePackageVersion>10.0.1</MicrosoftExtensionsLoggingConsolePackageVersion>
-    <MicrosoftExtensionsOptionsPackageVersion>10.0.1</MicrosoftExtensionsOptionsPackageVersion>
-    <MicrosoftExtensionsOptionsConfigurationExtensionPackageVersion>10.0.1</MicrosoftExtensionsOptionsConfigurationExtensionPackageVersion>
-    <MicrosoftExtensionsPrimitivesPackageVersion>10.0.1</MicrosoftExtensionsPrimitivesPackageVersion>
+    <MicrosoftExtensionsConfigurationPackageVersion>10.0.8</MicrosoftExtensionsConfigurationPackageVersion>
+    <MicrosoftExtensionsDependencyInjectionPackageVersion>10.0.8</MicrosoftExtensionsDependencyInjectionPackageVersion>
+    <MicrosoftExtensionsFileSystemGlobbingPackageVersion>10.0.8</MicrosoftExtensionsFileSystemGlobbingPackageVersion>
+    <MicrosoftExtensionsLoggingPackageVersion>10.0.8</MicrosoftExtensionsLoggingPackageVersion>
+    <MicrosoftExtensionsLoggingAbstractionsPackageVersion>10.0.8</MicrosoftExtensionsLoggingAbstractionsPackageVersion>
+    <MicrosoftExtensionsLoggingConsolePackageVersion>10.0.8</MicrosoftExtensionsLoggingConsolePackageVersion>
+    <MicrosoftExtensionsOptionsPackageVersion>10.0.8</MicrosoftExtensionsOptionsPackageVersion>
+    <MicrosoftExtensionsOptionsConfigurationExtensionPackageVersion>10.0.8</MicrosoftExtensionsOptionsConfigurationExtensionPackageVersion>
+    <MicrosoftExtensionsPrimitivesPackageVersion>10.0.8</MicrosoftExtensionsPrimitivesPackageVersion>
     <SystemCollectionsImmutablePackageVersion>10.0.8</SystemCollectionsImmutablePackageVersion>
     <SystemCommandLinePackageVersion>3.0.0-preview.6.26324.102</SystemCommandLinePackageVersion>
     <SystemComponentModelCompositionPackageVersion>10.0.8</SystemComponentModelCompositionPackageVersion>
     <SystemCompositionPackageVersion>10.0.8</SystemCompositionPackageVersion>
     <SystemConfigurationConfigurationManagerPackageVersion>10.0.8</SystemConfigurationConfigurationManagerPackageVersion>
     <SystemDiagnosticsDiagnosticSourcePackageVersion>10.0.8</SystemDiagnosticsDiagnosticSourcePackageVersion>
     <SystemDiagnosticsEventLogPackageVersion>10.0.8</SystemDiagnosticsEventLogPackageVersion>
-    <SystemIOHashingPackageVersion>10.0.1</SystemIOHashingPackageVersion>
+    <SystemIOHashingPackageVersion>10.0.8</SystemIOHashingPackageVersion>
     <SystemIOPipelinesPackageVersion>10.0.8</SystemIOPipelinesPackageVersion>
     <SystemReflectionMetadataPackageVersion>10.0.8</SystemReflectionMetadataPackageVersion>
     <SystemResourcesExtensionsPackageVersion>10.0.8</SystemResourcesExtensionsPackageVersion>
     <SystemSecurityCryptographyProtectedDataPackageVersion>10.0.8</SystemSecurityCryptographyProtectedDataPackageVersion>
-    <SystemSecurityPermissionsPackageVersion>10.0.1</SystemSecurityPermissionsPackageVersion>
+    <SystemSecurityPermissionsPackageVersion>10.0.8</SystemSecurityPermissionsPackageVersion>
     <SystemTextEncodingsWebPackageVersion>10.0.8</SystemTextEncodingsWebPackageVersion>
     <SystemTextJsonPackageVersion>10.0.8</SystemTextJsonPackageVersion>
     <SystemThreadingTasksDataflowPackageVersion>10.0.8</SystemThreadingTasksDataflowPackageVersion>
-    <SystemWindowsExtensionsPackageVersion>10.0.1</SystemWindowsExtensionsPackageVersion>
+    <SystemWindowsExtensionsPackageVersion>10.0.8</SystemWindowsExtensionsPackageVersion>
     <!-- dotnet-roslyn dependencies -->
     <MicrosoftCodeAnalysisPackageVersion>5.10.0-1.26365.3</MicrosoftCodeAnalysisPackageVersion>
     <MicrosoftCodeAnalysisAnalyzersPackageVersion>5.10.0-1.26365.3</MicrosoftCodeAnalysisAnalyzersPackageVersion>

eng/Version.Details.xml

@@ -16,39 +16,39 @@
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Configuration" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Configuration" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.DependencyInjection" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.DependencyInjection" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.FileSystemGlobbing" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.FileSystemGlobbing" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Logging" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Logging" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Logging.Abstractions" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Logging.Abstractions" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Logging.Console" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Logging.Console" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Options.ConfigurationExtension" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Options.ConfigurationExtension" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Options" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Options" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Extensions.Primitives" Version="10.0.1">
+    <Dependency Name="Microsoft.Extensions.Primitives" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
@@ -64,7 +64,7 @@
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="System.IO.Hashing" Version="10.0.1">
+    <Dependency Name="System.IO.Hashing" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
@@ -105,11 +105,11 @@
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="System.Security.Permissions" Version="10.0.1">
+    <Dependency Name="System.Security.Permissions" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>
-    <Dependency Name="System.Windows.Extensions" Version="10.0.1">
+    <Dependency Name="System.Windows.Extensions" Version="10.0.8">
       <Uri>https://github.com/dotnet/dotnet</Uri>
       <Sha>fad253f51b461736dfd3cd9c15977bb7493becef</Sha>
     </Dependency>

src/EditorFeatures/CSharpTest/DocumentationComments/CopilotGenerateDocumentationApplyEditsTests.cs

@@ -0,0 +1,81 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Immutable;
+using System.Linq;
+using Microsoft.CodeAnalysis.DocumentationComments;
+using Microsoft.CodeAnalysis.Test.Utilities;
+using Microsoft.CodeAnalysis.Text;
+using Roslyn.Test.Utilities;
+using Xunit;
+
+namespace Microsoft.CodeAnalysis.Editor.CSharp.UnitTests.DocumentationComments;
+
+[UseExportProvider]
+[Trait(Traits.Feature, Traits.Features.DocumentationComments)]
+public sealed class CopilotGenerateDocumentationApplyEditsTests
+{
+    [WpfFact]
+    public void ApplyEdits_TranslatesSpansToCurrentSnapshotAndInsertsText()
+    {
+        const string code = """
+            class C
+            {
+                /// <summary></summary>
+                void M() { }
+            }
+            """;
+        using var workspace = EditorTestWorkspace.CreateCSharp(code);
+        var buffer = workspace.Documents.Single().GetTextBuffer();
+
+        // Capture the snapshot the edit spans are relative to, as the InlinePrompt accept path does when the
+        // chip is shown.
+        var snapshot = buffer.CurrentSnapshot;
+        var insertionPoint = snapshot.GetText().IndexOf("<summary>", StringComparison.Ordinal) + "<summary>".Length;
+
+        var edits = ImmutableArray.Create(
+            new DocumentationCommentEdit(new TextSpan(insertionPoint, 0), "A short summary."));
+
+        // Mutate the buffer AFTER capturing the snapshot so ApplyEdits must translate the edit span across
+        // versions before applying it.
+        buffer.Insert(0, "// prefix\r\n");
+
+        CopilotGenerateDocumentationCommentManager.ApplyEdits(buffer, snapshot, edits);
+
+        var result = buffer.CurrentSnapshot.GetText();
+        Assert.StartsWith("// prefix", result);
+        Assert.Contains("<summary>A short summary.</summary>", result);
+    }
+
+    [WpfFact]
+    public void ApplyEdits_AppliesMultipleEditsInOneTransaction()
+    {
+        const string code = """
+            class C
+            {
+                /// <summary></summary>
+                /// <returns></returns>
+                int M() => 0;
+            }
+            """;
+        using var workspace = EditorTestWorkspace.CreateCSharp(code);
+        var buffer = workspace.Documents.Single().GetTextBuffer();
+
+        var snapshot = buffer.CurrentSnapshot;
+        var text = snapshot.GetText();
+        var summaryPoint = text.IndexOf("<summary>", StringComparison.Ordinal) + "<summary>".Length;
+        var returnsPoint = text.IndexOf("<returns>", StringComparison.Ordinal) + "<returns>".Length;
+
+        var edits = ImmutableArray.Create(
+            new DocumentationCommentEdit(new TextSpan(summaryPoint, 0), "Returns zero."),
+            new DocumentationCommentEdit(new TextSpan(returnsPoint, 0), "always zero"));
+
+        CopilotGenerateDocumentationCommentManager.ApplyEdits(buffer, snapshot, edits);
+
+        var result = buffer.CurrentSnapshot.GetText();
+        Assert.Contains("<summary>Returns zero.</summary>", result);
+        Assert.Contains("<returns>always zero</returns>", result);
+    }
+}