RemoveAllExceptXmlDocComments.cs

namespace CommentRemover;

using System.Diagnostics;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using EnvDTE;
using EnvDTE80;
using Microsoft.VisualStudio.Editor;
using Microsoft.VisualStudio.Extensibility;
using Microsoft.VisualStudio.Extensibility.Commands;
using Microsoft.VisualStudio.Extensibility.Shell;
using Microsoft.VisualStudio.Extensibility.VSSdkCompatibility;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Text.Tagging;
using Microsoft.VisualStudio.TextManager.Interop;

[VisualStudioContribution]
internal class RemoveAllExceptXmlDocComments : CommentRemoverCommand
{
    private const string CommandDescription = "%CommentRemover.RemoveAllExceptXmlDocComments.DisplayName%";

    public RemoveAllExceptXmlDocComments(
        TraceSource traceSource,
        AsyncServiceProviderInjection<DTE, DTE2> dte,
        MefInjection<IBufferTagAggregatorFactoryService> bufferTagAggregatorFactoryService,
        MefInjection<IVsEditorAdaptersFactoryService> editorAdaptersFactoryService,
        AsyncServiceProviderInjection<SVsTextManager, IVsTextManager> textManager)
        : base(traceSource, dte, bufferTagAggregatorFactoryService, editorAdaptersFactoryService, textManager)
    {
    }

    /// <inheritdoc />
    public override CommandConfiguration CommandConfiguration => new(CommandDescription)
    {
        Icon = new(ImageMoniker.KnownValues.Dictionary, IconSettings.IconAndText),
        EnabledWhen = CommandEnabledWhen,
    };

    public override async Task ExecuteCommandAsync(IClientContext context, CancellationToken cancellationToken)
    {
        if (!await this.Extensibility.Shell().ShowPromptAsync("All task comments, except for Xml Docs, will be removed from the current document. Are you sure?", PromptOptions.OKCancel, cancellationToken))
        {
            return;
        }

        using var reporter = await this.Extensibility.Shell().StartProgressReportingAsync("Removing comments", options: new(isWorkCancellable: false), cancellationToken);

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();

        // Not using context.GetActiveTextViewAsync here because VisualStudio.Extensibility doesn't support classification yet.
        var view = await this.GetCurrentTextViewAsync();
        var mappingSpans = await this.GetClassificationSpansAsync(view, "comment");
        if (!mappingSpans.Any())
        {
            return;
        }

        var dte = await this.Dte.GetServiceAsync();
        try
        {
            dte.UndoContext.Open(CommandDescription);

            DeleteFromBuffer(view, mappingSpans);
        }
#pragma warning disable CA1031 // Do not catch general exception types
        catch (Exception ex)
#pragma warning restore CA1031 // Do not catch general exception types
        {
            this.TraceSource.TraceInformation(ex.ToString());
        }
        finally
        {
            dte.UndoContext.Close();
        }
    }

    private static void DeleteFromBuffer(IWpfTextView view, IEnumerable<IMappingSpan> mappingSpans)
    {
        var affectedLines = new List<int>();

        RemoveCommentSpansFromBuffer(view, mappingSpans, affectedLines);
        RemoveAffectedEmptyLines(view, affectedLines);
    }

    private static void RemoveCommentSpansFromBuffer(IWpfTextView view, IEnumerable<IMappingSpan> mappingSpans, IList<int> affectedLines)
    {
        using var edit = view.TextBuffer.CreateEdit();
        foreach (var mappingSpan in mappingSpans)
        {
            var start = mappingSpan.Start.GetPoint(view.TextBuffer, PositionAffinity.Predecessor);
            var end = mappingSpan.End.GetPoint(view.TextBuffer, PositionAffinity.Successor);

            if (!start.HasValue || !end.HasValue)
            {
                continue;
            }

            var span = new Span(start.Value, end.Value - start.Value);
            var lines = view.TextBuffer.CurrentSnapshot.Lines.Where(l => l.Extent.IntersectsWith(span));
            bool skip = false;

            foreach (var line in lines)
            {
                if (IsXmlDocComment(line))
                {
                    skip = true;
                }
                else
                {
                    if (!affectedLines.Contains(line.LineNumber))
                    {
                        affectedLines.Add(line.LineNumber);
                    }
                }
            }

            if (skip)
            {
                continue;
            }

            var mappingText = view.TextBuffer.CurrentSnapshot.GetText(span.Start, span.Length);
            string empty = Regex.Replace(mappingText, "([\\S]+)", string.Empty);

            edit.Replace(span.Start, span.Length, empty);
        }

        edit.Apply();
    }

    private static void RemoveAffectedEmptyLines(IWpfTextView view, IList<int> affectedLines)
    {
        if (!affectedLines.Any())
        {
            return;
        }

        using var edit = view.TextBuffer.CreateEdit();
        foreach (var lineNumber in affectedLines)
        {
            var line = view.TextBuffer.CurrentSnapshot.GetLineFromLineNumber(lineNumber);

            if (IsLineEmpty(line))
            {
                // Strip next line if empty
                if (view.TextBuffer.CurrentSnapshot.LineCount > line.LineNumber + 1)
                {
                    var next = view.TextBuffer.CurrentSnapshot.GetLineFromLineNumber(lineNumber + 1);

                    if (IsLineEmpty(next))
                    {
                        edit.Delete(next.Start, next.LengthIncludingLineBreak);
                    }
                }

                edit.Delete(line.Start, line.LengthIncludingLineBreak);
            }
        }

        edit.Apply();
    }
}