Add option for format on paste (dotnet#11039)

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/AutoInsert/OnAutoInsertEndpoint.cs

@@ -143,7 +143,7 @@ public void ApplyCapabilities(VSInternalServerCapabilities serverCapabilities, V
             // Therefore we are just going to no-op if the user has turned off on type formatting. Maybe one day we can make this
             // smarter, but at least the user can always turn the setting back on, type their "///", and turn it back off, without
             // having to restart VS. Not the worst compromise (hopefully!)
-            if (!_optionsMonitor.CurrentValue.FormatOnType)
+            if (!_optionsMonitor.CurrentValue.Formatting.IsOnTypeEnabled())
             {
                 Logger.LogInformation($"Formatting on type disabled, so auto insert is a no-op for C#.");
                 return SpecializedTasks.Null<IDelegatedParams>();

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/DefaultRazorConfigurationService.cs

@@ -96,10 +96,10 @@ internal RazorLSPOptions BuildOptions(JsonObject[] result)
         }
         else
         {
-            ExtractVSCodeOptions(result, out var enableFormatting, out var autoClosingTags, out var commitElementsWithSpace, out var codeBlockBraceOnNextLine);
+            ExtractVSCodeOptions(result, out var formatting, out var autoClosingTags, out var commitElementsWithSpace, out var codeBlockBraceOnNextLine);
             return RazorLSPOptions.Default with
             {
-                EnableFormatting = enableFormatting,
+                Formatting = formatting,
                 AutoClosingTags = autoClosingTags,
                 CommitElementsWithSpace = commitElementsWithSpace,
                 CodeBlockBraceOnNextLine = codeBlockBraceOnNextLine
@@ -109,15 +109,15 @@ internal RazorLSPOptions BuildOptions(JsonObject[] result)
 
     private void ExtractVSCodeOptions(
         JsonObject[] result,
-        out bool enableFormatting,
+        out FormattingFlags formatting,
         out bool autoClosingTags,
         out bool commitElementsWithSpace,
         out bool codeBlockBraceOnNextLine)
     {
         var razor = result[0];
         var html = result[1];
 
-        enableFormatting = RazorLSPOptions.Default.EnableFormatting;
+        formatting = RazorLSPOptions.Default.Formatting;
         autoClosingTags = RazorLSPOptions.Default.AutoClosingTags;
         codeBlockBraceOnNextLine = RazorLSPOptions.Default.CodeBlockBraceOnNextLine;
         // Deliberately not using the "default" here because we want a different default for VS Code, as
@@ -130,7 +130,15 @@ private void ExtractVSCodeOptions(
             if (parsedFormat.TryGetPropertyValue("enable", out var parsedEnableFormatting) &&
                 parsedEnableFormatting is not null)
             {
-                enableFormatting = GetObjectOrDefault(parsedEnableFormatting, enableFormatting);
+                var formattingEnabled = GetObjectOrDefault(parsedEnableFormatting, formatting.IsEnabled());
+                if (formattingEnabled)
+                {
+                    formatting |= FormattingFlags.Enabled;
+                }
+                else
+                {
+                    formatting = FormattingFlags.Disabled;
+                }
             }
 
             if (parsedFormat.TryGetPropertyValue("codeBlockBraceOnNextLine", out var parsedCodeBlockBraceOnNextLine) &&

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/DocumentFormattingEndpoint.cs

@@ -37,7 +37,7 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(DocumentFormattingParams
 
     public async Task<TextEdit[]?> HandleRequestAsync(DocumentFormattingParams request, RazorRequestContext requestContext, CancellationToken cancellationToken)
     {
-        if (!_optionsMonitor.CurrentValue.EnableFormatting)
+        if (!_optionsMonitor.CurrentValue.Formatting.IsEnabled())
         {
             return null;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/DocumentOnTypeFormattingEndpoint.cs

@@ -49,13 +49,13 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(DocumentOnTypeFormatting
     {
         _logger.LogInformation($"Starting OnTypeFormatting request for {request.TextDocument.Uri}.");
 
-        if (!_optionsMonitor.CurrentValue.EnableFormatting)
+        if (!_optionsMonitor.CurrentValue.Formatting.IsEnabled())
         {
             _logger.LogInformation($"Formatting option disabled.");
             return null;
         }
 
-        if (!_optionsMonitor.CurrentValue.FormatOnType)
+        if (!_optionsMonitor.CurrentValue.Formatting.IsOnTypeEnabled())
         {
             _logger.LogInformation($"Formatting on type disabled.");
             return null;

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/DocumentRangeFormattingEndpoint.cs

@@ -37,7 +37,7 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(DocumentRangeFormattingP
 
     public async Task<TextEdit[]?> HandleRequestAsync(DocumentRangeFormattingParams request, RazorRequestContext requestContext, CancellationToken cancellationToken)
     {
-        if (!_optionsMonitor.CurrentValue.EnableFormatting)
+        if (!_optionsMonitor.CurrentValue.Formatting.IsEnabled())
         {
             return null;
         }
@@ -54,6 +54,16 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(DocumentRangeFormattingP
             return null;
         }
 
+        if (request.Options.OtherOptions is not null &&
+            request.Options.OtherOptions.TryGetValue("fromPaste", out var fromPasteObj) &&
+            fromPasteObj is bool fromPaste)
+        {
+            if (fromPaste && !_optionsMonitor.CurrentValue.Formatting.IsOnPasteEnabled())
+            {
+                return null;
+            }
+        }
+
         var options = RazorFormattingOptions.From(request.Options, _optionsMonitor.CurrentValue.CodeBlockBraceOnNextLine);
 
         var htmlChanges = await _htmlFormatter.GetDocumentFormattingEditsAsync(documentContext.Snapshot, documentContext.Uri, request.Options, cancellationToken).ConfigureAwait(false);

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Hosting/FormattingFlagExtensions.cs

@@ -0,0 +1,16 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+namespace Microsoft.AspNetCore.Razor.LanguageServer.Hosting;
+
+internal static class FormattingFlagExtensions
+{
+    public static bool IsEnabled(this FormattingFlags flags)
+        => flags.IsFlagSet(FormattingFlags.Enabled);
+
+    public static bool IsOnTypeEnabled(this FormattingFlags flags)
+        => flags.IsEnabled() && flags.IsFlagSet(FormattingFlags.OnType);
+
+    public static bool IsOnPasteEnabled(this FormattingFlags flags)
+        => flags.IsEnabled() && flags.IsFlagSet(FormattingFlags.OnPaste);
+}

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Hosting/FormattingFlags.cs

@@ -0,0 +1,16 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+using System;
+
+namespace Microsoft.AspNetCore.Razor.LanguageServer.Hosting;
+
+[Flags]
+internal enum FormattingFlags
+{
+    Disabled = 0,
+    Enabled  = 1,
+    OnPaste  = 1 << 1,
+    OnType   = 1 << 2,
+    All      = Enabled | OnPaste | OnType
+};

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Hosting/RazorLSPOptions.cs

@@ -1,30 +1,29 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
+using System;
 using Microsoft.CodeAnalysis.Razor.Settings;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer.Hosting;
 
 internal record RazorLSPOptions(
-    bool EnableFormatting,
+    FormattingFlags Formatting,
     bool AutoClosingTags,
     bool InsertSpaces,
     int TabSize,
     bool AutoShowCompletion,
     bool AutoListParams,
-    bool FormatOnType,
     bool AutoInsertAttributeQuotes,
     bool ColorBackground,
     bool CodeBlockBraceOnNextLine,
     bool CommitElementsWithSpace)
 {
-    public readonly static RazorLSPOptions Default = new(EnableFormatting: true,
+    public readonly static RazorLSPOptions Default = new(Formatting: FormattingFlags.All,
                                                          AutoClosingTags: true,
                                                          AutoListParams: true,
                                                          InsertSpaces: true,
                                                          TabSize: 4,
                                                          AutoShowCompletion: true,
-                                                         FormatOnType: true,
                                                          AutoInsertAttributeQuotes: true,
                                                          ColorBackground: false,
                                                          CodeBlockBraceOnNextLine: false,
@@ -35,15 +34,30 @@ internal record RazorLSPOptions(
     /// not defined in client settings.
     /// </summary>
     internal static RazorLSPOptions From(ClientSettings settings)
-        => new(Default.EnableFormatting,
+        => new(GetFormattingFlags(settings),
               settings.AdvancedSettings.AutoClosingTags,
               !settings.ClientSpaceSettings.IndentWithTabs,
               settings.ClientSpaceSettings.IndentSize,
               settings.ClientCompletionSettings.AutoShowCompletion,
               settings.ClientCompletionSettings.AutoListParams,
-              settings.AdvancedSettings.FormatOnType,
               settings.AdvancedSettings.AutoInsertAttributeQuotes,
               settings.AdvancedSettings.ColorBackground,
               settings.AdvancedSettings.CodeBlockBraceOnNextLine,
               settings.AdvancedSettings.CommitElementsWithSpace);
+
+    private static FormattingFlags GetFormattingFlags(ClientSettings settings)
+    {
+        var flags = FormattingFlags.Enabled;
+        if (settings.AdvancedSettings.FormatOnPaste)
+        {
+            flags |= FormattingFlags.OnPaste;
+        }
+
+        if (settings.AdvancedSettings.FormatOnType)
+        {
+            flags |= FormattingFlags.OnType;
+        }
+
+        return flags;
+    }
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Settings/ClientSettings.cs

@@ -32,7 +32,7 @@ internal sealed record ClientSpaceSettings(bool IndentWithTabs, int IndentSize)
     public int IndentSize { get; } = IndentSize >= 0 ? IndentSize : throw new ArgumentOutOfRangeException(nameof(IndentSize));
 }
 
-internal sealed record ClientAdvancedSettings(bool FormatOnType, bool AutoClosingTags, bool AutoInsertAttributeQuotes, bool ColorBackground, bool CodeBlockBraceOnNextLine, bool CommitElementsWithSpace, SnippetSetting SnippetSetting, LogLevel LogLevel)
+internal sealed record ClientAdvancedSettings(bool FormatOnType, bool AutoClosingTags, bool AutoInsertAttributeQuotes, bool ColorBackground, bool CodeBlockBraceOnNextLine, bool CommitElementsWithSpace, SnippetSetting SnippetSetting, LogLevel LogLevel, bool FormatOnPaste)
 {
-    public static readonly ClientAdvancedSettings Default = new(FormatOnType: true, AutoClosingTags: true, AutoInsertAttributeQuotes: true, ColorBackground: false, CodeBlockBraceOnNextLine: false, CommitElementsWithSpace: true, SnippetSetting.All, LogLevel.Warning);
+    public static readonly ClientAdvancedSettings Default = new(FormatOnType: true, AutoClosingTags: true, AutoInsertAttributeQuotes: true, ColorBackground: false, CodeBlockBraceOnNextLine: false, CommitElementsWithSpace: true, SnippetSetting.All, LogLevel.Warning, FormatOnPaste: true);
 }

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/Cohost/CohostRangeFormattingEndpoint.cs

@@ -70,6 +70,14 @@ public ImmutableArray<Registration> GetRegistrations(VSInternalClientCapabilitie
 
     private async Task<TextEdit[]?> HandleRequestAsync(DocumentRangeFormattingParams request, TextDocument razorDocument, CancellationToken cancellationToken)
     {
+        if (request.Options.OtherOptions is not null && request.Options.OtherOptions.TryGetValue("fromPaste", out var fromPasteObj) && fromPasteObj is bool fromPaste)
+        {
+            if (fromPaste && !_clientSettingsManager.GetClientSettings().AdvancedSettings.FormatOnPaste)
+            {
+                return null;
+            }
+        }
+
         _logger.LogDebug($"Getting Html formatting changes for {razorDocument.FilePath}");
         var htmlResult = await TryGetHtmlFormattingEditsAsync(request, razorDocument, cancellationToken).ConfigureAwait(false);
 

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/Options/OptionsStorage.cs

@@ -77,6 +77,12 @@ public LogLevel LogLevel
         set => SetInt(SettingsNames.LogLevel.LegacyName, (int)value);
     }
 
+    public bool FormatOnPaste
+    {
+        get => GetBool(SettingsNames.FormatOnPaste.LegacyName, defaultValue: true);
+        set => SetBool(SettingsNames.FormatOnPaste.LegacyName, value);
+    }
+
     [ImportingConstructor]
     public OptionsStorage(
         SVsServiceProvider synchronousServiceProvider,
@@ -107,7 +113,7 @@ public async Task OnChangedAsync(Action<ClientAdvancedSettings> changed)
 
     private EventHandler<ClientAdvancedSettingsChangedEventArgs>? _changed;
 
-    public ClientAdvancedSettings GetAdvancedSettings() => new(FormatOnType, AutoClosingTags, AutoInsertAttributeQuotes, ColorBackground, CodeBlockBraceOnNextLine, CommitElementsWithSpace, Snippets, LogLevel);
+    public ClientAdvancedSettings GetAdvancedSettings() => new(FormatOnType, AutoClosingTags, AutoInsertAttributeQuotes, ColorBackground, CodeBlockBraceOnNextLine, CommitElementsWithSpace, Snippets, LogLevel, FormatOnPaste);
 
     public bool GetBool(string name, bool defaultValue)
     {

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/Options/SettingsNames.cs

@@ -18,6 +18,7 @@ public record Setting(string LegacyName, string UnifiedName);
     public static readonly Setting CommitElementsWithSpace = new("CommitElementsWithSpace", UnifiedCollection + ".commitCharactersWithSpace");
     public static readonly Setting Snippets = new("Snippets", UnifiedCollection + ".snippets");
     public static readonly Setting LogLevel = new("LogLevel", UnifiedCollection + ".logLevel");
+    public static readonly Setting FormatOnPaste = new("FormatOnPaste", UnifiedCollection + ".formatOnPaste");
 
     public static readonly Setting[] AllSettings =
     [
@@ -29,5 +30,6 @@ public record Setting(string LegacyName, string UnifiedName);
         CommitElementsWithSpace,
         Snippets,
         LogLevel,
+        FormatOnPaste,
     ];
 }

src/Razor/src/Microsoft.VisualStudio.RazorExtension/Options/AdvancedOptionPage.cs

@@ -25,6 +25,7 @@ internal class AdvancedOptionPage : DialogPage
     private bool? _commitElementsWithSpace;
     private SnippetSetting? _snippets;
     private LogLevel? _logLevel;
+    private bool? _formatOnPaste;
 
     public AdvancedOptionPage()
     {
@@ -91,6 +92,15 @@ public bool CodeBlockBraceOnNextLine
         set => _codeBlockBraceOnNextLine = value;
     }
 
+    [LocCategory(nameof(VSPackage.Formatting))]
+    [LocDescription(nameof(VSPackage.Setting_FormattingOnPasteDescription))]
+    [LocDisplayName(nameof(VSPackage.Setting_FormattingOnPasteDisplayName))]
+    public bool FormatOnPaste
+    {
+        get => _formatOnPaste ?? true;
+        set => _formatOnPaste = value;
+    }
+
     [LocCategory(nameof(VSPackage.Completion))]
     [LocDescription(nameof(VSPackage.Setting_SnippetsDescription))]
     [LocDisplayName(nameof(VSPackage.Setting_SnippetsDisplayName))]