Remora.Plugins.Abstractions 4.0.7

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package Remora.Plugins.Abstractions --version 4.0.7                

                    
                

            
NuGet\Install-Package Remora.Plugins.Abstractions -Version 4.0.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Remora.Plugins.Abstractions" Version="4.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Remora.Plugins.Abstractions --version 4.0.7                

                    
                

            
#r "nuget: Remora.Plugins.Abstractions, 4.0.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Remora.Plugins.Abstractions as a Cake Addin
#addin nuget:?package=Remora.Plugins.Abstractions&version=4.0.7

// Install Remora.Plugins.Abstractions as a Cake Tool
#tool nuget:?package=Remora.Plugins.Abstractions&version=4.0.7

Remora.Plugins

Remora.Plugins is a simple plugin system for .NET, providing a dynamic pluggable framework for your applications. In short, class libraries can be written as standalone packages and loaded at runtime as integrated parts of your application, allowing loose coupling and easily swappable components. The plugin system is designed around Microsoft's dependency injection framework.

Usage

Creating a plugin is as simple as creating a class library project, and annotating the assembly with an attribute denoting the type used as a plugin descriptor. The descriptor acts as the entry point of the plugin, as well as an encapsulation point for information about it.

Generally, plugins should only reference Remora.Plugins.Abstractions, while the main application should reference and use Remora.Plugins.

[assembly: RemoraPlugin(typeof(MyPlugin))]

public sealed class MyPlugin : PluginDescriptor
{
    /// <inheritdoc />
    public override string Name => "My Plugin";

    /// <inheritdoc />
    public override string Description => "My plugin that does a thing.";

    /// <inheritdoc/>
    public override Result ConfigureServices(IServiceCollection serviceCollection)
    {
        serviceCollection
            .AddScoped<MyService>();

        return Result.FromSuccess();
    }

    /// <inheritdoc />
    public override async ValueTask<Result> InitializeAsync(IServiceProvider serviceProvider)
    {
        var myService = serviceProvider.GetRequiredService<MyService>();
        var doThing = await myService.DoTheThingAsync();
        if (!doThing.IsSuccess)
        {
            return doThing;
        }

        return Result.FromSuccess();
    }
}

Loading plugins in your application is equally simple. The example below is perhaps a little convoluted, but shows the flexibility of the system.

var pluginService = new PluginService();

var serviceCollection = new ServiceCollection()
    .AddSingleton(pluginService);

var pluginTree = pluginService.LoadPluginTree();
var configurePlugins = pluginTree.ConfigureServices(serviceCollection);
if (!configurePlugins.IsSuccess)
{
    // check configurePlugins.Error to figure out why
    return;
}

_services = serviceCollection.BuildServiceProvider();

var initializePlugins = await pluginTree.InitializeAsync(_services, ct);
if (!initializePlugins.IsSuccess)
{
    // check initializePlugins.Error to figure out why
    return;
}

var migratePlugins = await pluginTree.MigrateAsync(_services, ct);
if (!migratePlugins.IsSuccess)
{
    // check migratePlugins.Error to figure out why
    return;
}

Plugins should be designed in such a way that a registration or initialization failure does not corrupt the application.

Building

The library does not require anything out of the ordinary to compile.

cd $SOLUTION_DIR
dotnet build
dotnet pack -c Release

Downloading

Get it on NuGet.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Remora.Plugins.Abstractions:

Package Downloads
Remora.Plugins

The default implementation of Remora.Plugins.Abstractions.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.7 1,109 11/20/2023
4.0.6 1,084 11/20/2022
4.0.5 1,003 8/19/2022
4.0.4 970 6/8/2022
4.0.3 848 4/19/2022
4.0.2 826 2/13/2022
4.0.1 446 11/27/2021
4.0.0 495 11/19/2021
3.1.1 542 11/6/2021
3.1.0 576 3/28/2021
3.0.1 343 2/21/2021
3.0.0 555 2/7/2021
2.1.3 1,501 8/6/2020
2.1.3-beta1 470 8/6/2020
2.1.2 1,139 5/11/2020
2.1.2-beta1 340 8/6/2020
2.1.1 753 5/9/2020
2.1.0 822 1/6/2020
2.0.1 731 12/30/2019
2.0.0 752 12/30/2019
1.0.1 770 12/14/2019
1.0.0 730 12/14/2019

Upgrade Remora.Sdk.
           Upgrade nuget packages.