RunLinterOnCurrentFileCommand.cs

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

namespace MarkdownLinter;

using System;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft;
using Microsoft.VisualStudio.Extensibility;
using Microsoft.VisualStudio.Extensibility.Commands;
using Microsoft.VisualStudio.ProjectSystem.Query;

/// <summary>
/// A command to execute linter on the current file selected in Solution Explorer.
/// </summary>
/// <remarks>
/// This command utilizes <see cref="CommandConfiguration.EnabledWhen"/> to describe when command state is enabled.
/// </remarks>
[VisualStudioContribution]
internal class RunLinterOnCurrentFileCommand : Command
{
    private readonly TraceSource logger;

#pragma warning disable CA2213 // This is an extension scoped service.
    private readonly MarkdownDiagnosticsService diagnosticsProvider;
#pragma warning restore CA2213

    /// <summary>
    /// Initializes a new instance of the <see cref="RunLinterOnCurrentFileCommand"/> class.
    /// </summary>
    /// <param name="traceSource">Logger instance that can be used to log extension actions.</param>
    /// <param name="diagnosticsProvider">Local diagnostics provider service instance.</param>
    public RunLinterOnCurrentFileCommand(TraceSource traceSource, MarkdownDiagnosticsService diagnosticsProvider)
    {
        this.logger = Requires.NotNull(traceSource, nameof(traceSource));
        this.diagnosticsProvider = Requires.NotNull(diagnosticsProvider, nameof(diagnosticsProvider));

        this.logger.TraceEvent(TraceEventType.Information, 0, $"Initializing {nameof(RunLinterOnCurrentFileCommand)} instance.");
    }

    /// <inheritdoc />
    public override CommandConfiguration CommandConfiguration => new("%MarkdownLinter.RunLinterOnCurrentFileCommand.DisplayName%")
    {
        Placements = new[] { CommandPlacement.KnownPlacements.ToolsMenu },
        Icon = new(ImageMoniker.Custom("MarkdownIcon"), IconSettings.IconAndText),
        EnabledWhen = ActivationConstraint.ClientContext(ClientContextKey.Shell.ActiveSelectionFileName, ".+"),
    };

    /// <inheritdoc />
    public override async Task ExecuteCommandAsync(IClientContext context, CancellationToken cancellationToken)
    {
        cancellationToken.ThrowIfCancellationRequested();
        try
        {
            // Get the selected item URIs from IDE context that represents the state when command was executed.
            var selectedItemPaths = new Uri[] { await context.GetSelectedPathAsync(cancellationToken) };

            // Enumerate through each selection and run linter on each selected item.
            foreach (var selectedItem in selectedItemPaths.Where(p => p.IsFile))
            {
                await this.diagnosticsProvider.ProcessFileAsync(selectedItem, cancellationToken);
            }
        }
        catch (InvalidOperationException ex)
        {
            this.logger.TraceEvent(TraceEventType.Error, 0, ex.ToString());
        }
    }
}