FractalDataWorks.Roslyn.Commands 0.4.0-preview.6

FractalDataWorks.Roslyn.Commands

Provides the command handler infrastructure for executing Roslyn commands against a workspace. This package contains the RoslynCommandHandler and TranslatorRegistry implementations.

Overview

This package implements the command execution pipeline defined in FractalDataWorks.Roslyn.Commands.Abstractions. It orchestrates command execution by:

1. Looking up the appropriate translator for a command type
2. Executing the translator against the current workspace solution
3. Applying mutations back to the workspace if needed

Installation

<PackageReference Include="FractalDataWorks.Roslyn.Commands" Version="1.0.0" />

Target Framework: net10.0

Usage

Service Registration

From ServiceCollectionExtensions.cs:18-29:

public static IServiceCollection AddRoslynCommandHandler(this IServiceCollection services)
{
    if (services is null)
    {
        throw new ArgumentNullException(nameof(services));
    }

    services.TryAddSingleton<ITranslatorRegistry, TranslatorRegistry>();
    services.TryAddScoped<IRoslynCommandHandler, RoslynCommandHandler>();

    return services;
}

Custom Translator Configuration

From ServiceCollectionExtensions.cs:37-61:

public static IServiceCollection AddRoslynCommandHandler(
    this IServiceCollection services,
    Action<ITranslatorRegistry> configureRegistry)
{
    if (services is null)
    {
        throw new ArgumentNullException(nameof(services));
    }

    if (configureRegistry is null)
    {
        throw new ArgumentNullException(nameof(configureRegistry));
    }

    services.AddSingleton<ITranslatorRegistry>(sp =>
    {
        var registry = new TranslatorRegistry();
        configureRegistry(registry);
        return registry;
    });

    services.TryAddScoped<IRoslynCommandHandler, RoslynCommandHandler>();

    return services;
}

Registering Translators

From ServiceCollectionExtensions.cs:69-81:

public static IServiceCollection AddTranslator<TTranslator>(this IServiceCollection services)
    where TTranslator : class, IRoslynCommandTranslator
{
    if (services is null)
    {
        throw new ArgumentNullException(nameof(services));
    }

    services.AddSingleton<IRoslynCommandTranslator, TTranslator>();
    services.AddSingleton<TTranslator>();

    return services;
}

API Reference

RoslynCommandHandler

From RoslynCommandHandler.cs:17-37:

public sealed class RoslynCommandHandler : IRoslynCommandHandler
{
    private readonly IRoslynWorkspace _workspace;
    private readonly ITranslatorRegistry _translators;
    private readonly ILogger<RoslynCommandHandler> _logger;

    public RoslynCommandHandler(
        IRoslynWorkspace workspace,
        ITranslatorRegistry translators,
        ILogger<RoslynCommandHandler>? logger = null)
    {
        _workspace = workspace ?? throw new ArgumentNullException(nameof(workspace));
        _translators = translators ?? throw new ArgumentNullException(nameof(translators));
        _logger = logger ?? NullLogger<RoslynCommandHandler>.Instance;
    }
}

TranslatorRegistry

From TranslatorRegistry.cs:11-13:

public sealed class TranslatorRegistry : ITranslatorRegistry
{
    private readonly ConcurrentDictionary<Type, IRoslynCommandTranslator> _translators = new();

Dependencies

Related Packages

• FractalDataWorks.Roslyn.Commands.Abstractions - Interfaces and base types
• FractalDataWorks.Workspace.Roslyn - Roslyn workspace management

License

Apache-2.0