Feature Add ReactiveUI modules and builder extensions for Splat (#1372)

ChrisPulman · web-flow · commit 9967f1872026 · 2025-08-16T00:12:19.000+01:00
* Add DI modules and builder extensions for Splat

Introduces IReactiveUIModule interface and implementation modules for Autofac, DryIoc, Exceptionless, Microsoft.Extensions.DependencyInjection, Ninject, and SimpleInjector. Adds SplatBuilderExtensions for applying modules to the Splat dependency resolver, enabling AOT-compatible service registration.

* Change Namespace

* IReactiveUIModule =&gt; IModule
diff --git a/src/Splat.Autofac/Builder/AutofacSplatModule.cs b/src/Splat.Autofac/Builder/AutofacSplatModule.cs
@@ -0,0 +1,30 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Autofac;
+using Splat.Autofac;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the Autofac dependency resolver.
+/// </summary>
+/// <remarks>
+/// Initializes a new instance of the <see cref="AutofacSplatModule"/> class.
+/// </remarks>
+/// <param name="builder">The Autofac container builder.</param>
+public sealed class AutofacSplatModule(ContainerBuilder builder) : IModule
+{
+    private readonly ContainerBuilder _builder = builder ?? throw new ArgumentNullException(nameof(builder));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver)
+    {
+        var autofacResolver = _builder.UseAutofacDependencyResolver();
+
+        // Also register the resolver instance for later retrieval if the container is built after
+        _builder.RegisterInstance(autofacResolver);
+    }
+}
diff --git a/src/Splat.DryIoc/Builder/DryIocSplatModule.cs b/src/Splat.DryIoc/Builder/DryIocSplatModule.cs
@@ -0,0 +1,24 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using DryIoc;
+using Splat.DryIoc;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the DryIoc dependency resolver.
+/// </summary>
+/// <remarks>
+/// Initializes a new instance of the <see cref="DryIocSplatModule"/> class.
+/// </remarks>
+/// <param name="container">The DryIoc container.</param>
+public sealed class DryIocSplatModule(IContainer container) : IModule
+{
+    private readonly IContainer _container = container ?? throw new ArgumentNullException(nameof(container));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver) => _container.UseDryIocDependencyResolver();
+}
diff --git a/src/Splat.Exceptionless/Builder/ExceptionlessSplatModule.cs b/src/Splat.Exceptionless/Builder/ExceptionlessSplatModule.cs
@@ -0,0 +1,25 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Exceptionless;
+using Splat;
+using Splat.Exceptionless;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the Exceptionless dependency resolver.
+/// </summary>
+/// <remarks>
+/// Initializes a new instance of the <see cref="ExceptionlessSplatModule"/> class.
+/// </remarks>
+/// <param name="exceptionlessClient">The Exceptionless container.</param>
+public sealed class ExceptionlessSplatModule(ExceptionlessClient exceptionlessClient) : IModule
+{
+    private readonly ExceptionlessClient _container = exceptionlessClient ?? throw new ArgumentNullException(nameof(exceptionlessClient));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver) => resolver.UseExceptionlessWithWrappingFullLogger(_container);
+}
diff --git a/src/Splat.Microsoft.Extensions.DependencyInjection/Builder/MicrosoftDependencyResolverModule.cs b/src/Splat.Microsoft.Extensions.DependencyInjection/Builder/MicrosoftDependencyResolverModule.cs
@@ -0,0 +1,21 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Microsoft.Extensions.DependencyInjection;
+using Splat.Microsoft.Extensions.DependencyInjection;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the Microsoft dependency resolver.
+/// </summary>
+/// <seealso cref="IModule" />
+public sealed class MicrosoftDependencyResolverModule(IServiceCollection serviceCollection) : IModule
+{
+    private readonly IServiceCollection _container = serviceCollection ?? throw new ArgumentNullException(nameof(serviceCollection));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver) => _container.UseMicrosoftDependencyResolver();
+}
diff --git a/src/Splat.Ninject/Builder/NinjectSplatModule.cs b/src/Splat.Ninject/Builder/NinjectSplatModule.cs
@@ -0,0 +1,24 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Ninject;
+using Splat.Ninject;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the Ninject dependency resolver.
+/// </summary>
+/// <remarks>
+/// Initializes a new instance of the <see cref="NinjectSplatModule"/> class.
+/// </remarks>
+/// <param name="kernel">The Ninject container.</param>
+public sealed class NinjectSplatModule(IKernel kernel) : IModule
+{
+    private readonly IKernel _container = kernel ?? throw new ArgumentNullException(nameof(kernel));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver) => _container.UseNinjectDependencyResolver();
+}
diff --git a/src/Splat.SimpleInjector/Builder/SimpleInjectorSplatModule.cs b/src/Splat.SimpleInjector/Builder/SimpleInjectorSplatModule.cs
@@ -0,0 +1,26 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using SimpleInjector;
+using Splat.SimpleInjector;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Splat module for configuring the SimpleInjector dependency resolver.
+/// </summary>
+/// <seealso cref="IModule" />
+/// <remarks>
+/// Initializes a new instance of the <see cref="SimpleInjectorSplatModule" /> class.
+/// </remarks>
+/// <param name="container">The SimpleInjector container.</param>
+/// <param name="initializer">The SimpleInjector Initializer.</param>
+public sealed class SimpleInjectorSplatModule(Container container, SimpleInjectorInitializer initializer) : IModule
+{
+    private readonly Container _container = container ?? throw new ArgumentNullException(nameof(container));
+
+    /// <inheritdoc />
+    public void Configure(IMutableDependencyResolver resolver) => _container.UseSimpleInjectorDependencyResolver(initializer);
+}
diff --git a/src/Splat.Tests/API/ApiApprovalTests.SplatProject.DotNet8_0.verified.txt b/src/Splat.Tests/API/ApiApprovalTests.SplatProject.DotNet8_0.verified.txt
@@ -773,6 +773,17 @@ namespace Splat.ApplicationPerformanceMonitoring
         void OnViewNavigation(string name);
     }
 }
+namespace Splat.Builder
+{
+    public interface IModule
+    {
+        void Configure(Splat.IMutableDependencyResolver resolver);
+    }
+    public static class SplatBuilderExtensions
+    {
+        public static void Apply(this Splat.Builder.IModule module) { }
+    }
+}
 namespace Splat.ModeDetection
 {
     public sealed class Mode : Splat.IModeDetector
diff --git a/src/Splat.Tests/API/ApiApprovalTests.SplatProject.DotNet9_0.verified.txt b/src/Splat.Tests/API/ApiApprovalTests.SplatProject.DotNet9_0.verified.txt
@@ -773,6 +773,17 @@ namespace Splat.ApplicationPerformanceMonitoring
         void OnViewNavigation(string name);
     }
 }
+namespace Splat.Builder
+{
+    public interface IModule
+    {
+        void Configure(Splat.IMutableDependencyResolver resolver);
+    }
+    public static class SplatBuilderExtensions
+    {
+        public static void Apply(this Splat.Builder.IModule module) { }
+    }
+}
 namespace Splat.ModeDetection
 {
     public sealed class Mode : Splat.IModeDetector
diff --git a/src/Splat/Builder/IModule.cs b/src/Splat/Builder/IModule.cs
@@ -0,0 +1,21 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Splat;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Defines a contract for ReactiveUI modules that can configure dependency injection.
+/// This provides an AOT-compatible way to register services.
+/// </summary>
+public interface IModule
+{
+    /// <summary>
+    /// Configures the dependency resolver with the module's services.
+    /// </summary>
+    /// <param name="resolver">The dependency resolver to configure.</param>
+    void Configure(IMutableDependencyResolver resolver);
+}
diff --git a/src/Splat/Builder/SplatBuilderExtensions.cs b/src/Splat/Builder/SplatBuilderExtensions.cs
@@ -0,0 +1,28 @@
+// Copyright (c) 2025 ReactiveUI. All rights reserved.
+// Licensed to ReactiveUI under one or more agreements.
+// ReactiveUI licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using System;
+
+namespace Splat.Builder;
+
+/// <summary>
+/// Common extension helpers for registering Splat modules.
+/// </summary>
+public static class SplatBuilderExtensions
+{
+    /// <summary>
+    /// Runs the provided configuration action imediately against the current Splat Locator.
+    /// </summary>
+    /// <param name="module">The module to configure.</param>
+    public static void Apply(this IModule module)
+    {
+        if (module is null)
+        {
+            throw new ArgumentNullException(nameof(module));
+        }
+
+        module.Configure(Locator.CurrentMutable);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -773,6 +773,17 @@ namespace Splat.ApplicationPerformanceMonitoring`
`773`	`773`	`void OnViewNavigation(string name);`
`774`	`774`	`}`
`775`	`775`	`}`
	`776`	`+namespace Splat.Builder`
	`777`	`+{`
	`778`	`+ public interface IModule`
	`779`	`+ {`
	`780`	`+ void Configure(Splat.IMutableDependencyResolver resolver);`
	`781`	`+ }`
	`782`	`+ public static class SplatBuilderExtensions`
	`783`	`+ {`
	`784`	`+ public static void Apply(this Splat.Builder.IModule module) { }`
	`785`	`+ }`
	`786`	`+}`
`776`	`787`	`namespace Splat.ModeDetection`
`777`	`788`	`{`
`778`	`789`	`public sealed class Mode : Splat.IModeDetector`