reactiveui / splat.di.sourcegenerator Goto Github PK

License: MIT License

C# 100.00%

splat.di.sourcegenerator's Introduction

What is ReactiveUI?

ReactiveUI is a composable, cross-platform model-view-viewmodel framework for all .NET platforms that is inspired by functional reactive programming, which is a paradigm that allows you to abstract mutable state away from your user interfaces and express the idea around a feature in one readable place and improve the testability of your application.

🔨 Get Started 🛍 Install Packages 🎞 Watch Videos 🎓 View Samples 🎤 Discuss ReactiveUI

Book

There has been an excellent book written by our Alumni maintainer Kent Boogart.

NuGet Packages

Install the following packages to start building your own ReactiveUI app. Note: some of the platform-specific packages are required. This means your app won't perform as expected until you install the packages properly. See the Installation docs page for more info.

Platform	ReactiveUI Package	NuGet
.NET Standard	ReactiveUI
	ReactiveUI.Fody
Unit Testing	ReactiveUI.Testing
WPF	ReactiveUI.WPF
UWP	ReactiveUI.Uwp
WinUI	ReactiveUI.WinUI
MAUI	ReactiveUI.Maui
Windows Forms	ReactiveUI.WinForms
Xamarin.Forms	ReactiveUI.XamForms
Xamarin.Essentials	ReactiveUI
AndroidX (Xamarin)	ReactiveUI.AndroidX
Xamarin.Android	ReactiveUI.AndroidSupport
Xamarin.iOS	ReactiveUI
Xamarin.Mac	ReactiveUI
Tizen	ReactiveUI
Blazor	ReactiveUI.Blazor
Platform Uno	ReactiveUI.Uno
Platform Uno	ReactiveUI.Uno.WinUI
Avalonia	Avalonia.ReactiveUI
Any	ReactiveUI.Validation

Sponsorship

The core team members, ReactiveUI contributors and contributors in the ecosystem do this open-source work in their free time. If you use ReactiveUI, a serious task, and you'd like us to invest more time on it, please donate. This project increases your income/productivity too. It makes development and applications faster and it reduces the required bandwidth.

Become a sponsor.

This is how we use the donations:

Allow the core team to work on ReactiveUI
Thank contributors if they invested a large amount of time in contributing
Support projects in the ecosystem

Support

If you have a question, please see if any discussions in our GitHub issues or Stack Overflow have already answered it.

If you want to discuss something or just need help, here is our Slack room, where there are always individuals looking to help out!

Please do not open GitHub issues for support requests.

Contribute

ReactiveUI is developed under an OSI-approved open source license, making it freely usable and distributable, even for commercial use.

If you want to submit pull requests please first open a GitHub issue to discuss. We are first time PR contributors friendly.

See Contribution Guidelines for further information how to contribute changes.

Core Team

Glenn Watson Melbourne, Australia	Rodney Littles II Texas, USA	Artyom Gorchakov Moscow, Russia
Colt Bauman South Korea	Chris Pulman United Kingdom

Alumni Core Team

The following have been core team members in the past.

Geoffrey Huntley Sydney, Australia	Kent Boogaart Brisbane, Australia	Olly Levett London, United Kingdom
Anaïs Betts San Francisco, USA	Brendan Forster Melbourne, Australia	Claire Novotny New York, USA

.NET Foundation

ReactiveUI is part of the .NET Foundation. Other projects that are associated with the foundation include the Microsoft .NET Compiler Platform ("Roslyn") as well as the Microsoft ASP.NET family of projects, Microsoft .NET Core & Xamarin Forms.

splat.di.sourcegenerator's People

Contributors

Stargazers

Watchers

Forkers

isabella232 lszczygielek-forks lszczygielek fredatgithub seanpm2001

splat.di.sourcegenerator's Issues

SplatRegistrations.Register bypasses conditional

I'm using this code to register a ViewModel for runtime and design-time.

Opening the designer or running the code gives this error:

 ViewModelLocator.cs(50, 13): [SPLATDI006] MainViewModel has been registered in multiple places

MainViewModelDesign shows some section that is hidden in the standard ViewModel. If I run the app as-is, the hidden section is shown. If I comment the line registering MainViewModelDesign, then the section is hidden. I've set a breakpoint and confirm that the 2nd registration isn't executed.

My guess is that there's a problem in the way SplatRegistrations.Register injects IL that bypasses the condition.

public static class ViewModelLocator
{
    static ViewModelLocator()
    {
        var container = Locator.CurrentMutable;
            
        if (!Design.IsDesignMode)
        {
            SplatRegistrations.Register<MainViewModel>();
        }
        else
        {
            SplatRegistrations.Register<MainViewModel, MainViewModelDesign>();
        }

        SplatRegistrations.SetupIOC();
    }

    public static MainViewModel Main => Locator.Current.GetService<MainViewModel>()!;

    public static void Cleanup()
    {
    }
}

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

chore(deps): update dependency roslynator.analyzers to v4.12.1
chore(deps): update xunit-dotnet monorepo (xunit, xunit.runner.visualstudio)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions

.github/workflows/ci-build.yml

.github/workflows/lock.yml

dessant/lock-threads v5

.github/workflows/release.yml

nuget

src/Directory.Build.props

Roslynator.Analyzers 4.12.0

stylecop.analyzers 1.2.0-beta.556

Nerdbank.GitVersioning 3.6.133

Microsoft.SourceLink.GitHub 8.0.0

src/Splat.DependencyInjection.SourceGenerator.Tests/Splat.DependencyInjection.SourceGenerator.Tests.csproj

Verify.Xunit 22.11.3

ReactiveMarbles.SourceGenerator.TestNuGetHelper 1.3.1

Verify.SourceGenerators 2.1.0

coverlet.msbuild 6.0.2

xunit.runner.visualstudio 2.5.7

xunit 2.7.0

Microsoft.NET.Test.Sdk 17.9.0

Microsoft.CodeAnalysis 4.8.0

src/Splat.DependencyInjection.SourceGenerator/Splat.DependencyInjection.SourceGenerator.csproj

ILRepack 2.0.28

ReactiveMarbles.RoslynHelpers 1.2.1

Microsoft.CodeAnalysis.CSharp.Workspaces 4.0.1

Microsoft.CodeAnalysis.Common 4.0.1

Microsoft.CodeAnalysis.Analyzers 3.3.4

Check this box to trigger a request for Renovate to run again on this repository

Use SplatRegistrations.Register with Generic

Is it possible to use SplatRegistrations like this?

It says:

ViewModelLocator.cs(64, 9): [SPLATDI001] TConcrete has more than one constructor and one hasn't been marked with DependencyInjectionConstructorAttribute

public static void RegisterWithDesign<TInterface, TDesign>(this IMutableDependencyResolver resolver)
    where TDesign : TInterface, new() => RegisterWithDesign<TInterface, TInterface, TDesign>(resolver);

public static void RegisterWithDesign<TInterface, TConcrete, TDesign>(this IMutableDependencyResolver resolver)
    where TDesign : TInterface, new()
{
    SplatRegistrations.Register<TInterface, TConcrete>("Init");
    resolver.Register<TInterface>(() =>
        Design.IsDesignMode ? new TDesign() : Locator.Current.GetService<TInterface>("Init"));
}

If not; it could be a neat feature to add.

Throw Exception if Missing Splat Registrations

Using Splat for Dependency Injection, I'm noticing that if a class is initialized and there are missing registrations, it will pass null to the constructor and I won't know about it. Is there a way to make it "fail early" and tell me there's a missing registration to build the object?

[BUG] Failing to Build WPF Project

Describe the bug
This behavior happened on a more developed project, but I'm able to reproduce it on a new WPF project.

In a nutshell, I'm unable to build a project when Splat.DependencyInjection.SourceGenerator is included in the project. When I do, I get the following errors:

Severity	Code	Description	Project	File	Line	Suppression State	Priority
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	28	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'Register' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	13	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'Register' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	21	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	36	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	44	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	53	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'Register' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	60	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'Register' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	69	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	76	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterLazySingleton' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	85	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterConstant' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	92	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'RegisterConstant' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	98	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'SetupIOC' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	103	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'SetupIOC' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	112	Active	Normal
Error	CS0111	Type 'SplatRegistrations' already defines a member called 'SetupIOCInternal' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	118	Active	Normal
Error	CS0756	A partial method may not have multiple defining declarations	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	118	Active	Normal
Error	CS0579	Duplicate 'System.AttributeUsage' attribute	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	124	Active	Normal
Error	CS0101	The namespace 'Splat' already contains a definition for 'DependencyInjectionPropertyAttribute'	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	125	Active	Normal
Error	CS0111	Type 'DependencyInjectionPropertyAttribute' already defines a member called 'DependencyInjectionPropertyAttribute' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	130	Active	Normal
Error	CS0579	Duplicate 'System.AttributeUsage' attribute	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	138	Active	Normal
Error	CS0101	The namespace 'Splat' already contains a definition for 'DependencyInjectionConstructorAttribute'	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	139	Active	Normal
Error	CS0111	Type 'DependencyInjectionConstructorAttribute' already defines a member called 'DependencyInjectionConstructorAttribute' with the same parameter types	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.g.cs	144	Active	Normal
Error	CS0757	A partial method may not have multiple implementing declarations	WpfApp1	C:\Source\repos\WpfApp1\WpfApp1\Splat.DependencyInjection.SourceGenerator\Splat.DependencyInjection.SourceGenerator.Generator\Splat.DI.Reg.g.cs	7	Active	Normal

The curious thing is this used to work just fine on version 1.1.33 but now, when I revert, it still doesn't work. I've rolled back to an older commit on my main project that DID work, but it still won't build. This leads me to believe it's something with NET6. I'm on SDK 6.0.400. I would have likely been on 6.0.300 when I last had a successful build, but I have not yet tested that theory.

Steps To Reproduce

Failing Example Project:
WpfApp1.zip

Provide the steps to reproduce the behavior:

Create WPF C# App targeting NET 6
Add ReactiveUI nuget packages:

	<ItemGroup>
		<PackageReference Include="ReactiveUI" Version="18.3.1" />
		<PackageReference Include="ReactiveUI.Events.WPF" Version="15.1.1" />
		<PackageReference Include="ReactiveUI.Fody" Version="18.3.1" />
		<PackageReference Include="ReactiveUI.WPF" Version="18.3.1" />
		<PackageReference Include="Splat.DependencyInjection.SourceGenerator" Version="1.1.69">
			<PrivateAssets>all</PrivateAssets>
		</PackageReference>
	</ItemGroup>

Build
See error

Expected behavior
It should build.

Screenshots

Environment

OS: Windows 10 Enterprise 21H2
Device: Dell Precision 7730
IDE: Visual Studio Pro 17.3.2
NET6 Version: 6.0.400
Version: 1.1.69, 1.1.33
Working Version:

Additional context

How to Use

Avalonia comes with ReactiveUI and ReactiveUI comes with Splat. I'm trying to use those default tools.

What bugs me off is that Splat by default needs to manually create each object. Splat.DI.SourceGenerator is supposed to solve that problem.

Now in my project I have Avalonia.ReactiveUI and Splat.DI.SourceGenerator

SplatRegistrations is not recognized. I find no way to use this.

SplatRegistrations.Register<IMenuUseCase, MenuUseCase>();
SplatRegistrations.Register<IOtherDependency, OtherDependency>();

I spent several hours trying to get this to work. What am I missing?

Besides the troubles to get this setup; what are the benefits of going the Splat route vs some more established DI containers like Microsoft DI or Simple Injector?

My project file contains this

<ItemGroup>
  <PackageReference Include="Avalonia" Version="0.10.10" />
  <PackageReference Include="Avalonia.Desktop" Version="0.10.10" />
  <!--Condition below is needed to remove Avalonia.Diagnostics package from build output in Release configuration.-->
  <PackageReference Condition="'$(Configuration)' == 'Debug'" Include="Avalonia.Diagnostics" Version="0.10.10" />
  <PackageReference Include="Avalonia.ReactiveUI" Version="0.10.10" />
  <PackageReference Include="Avalonia.Xaml.Behaviors" Version="0.10.10.4" />
  <PackageReference Include="Splat.DependencyInjection.SourceGenerator" Version="1.1.33">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
  </PackageReference>
</ItemGroup>

Registration calls from generic type result in compile-time error

public static void RegisterService<TConcrete>()
{
    SplatRegistrations.Register<TConcrete>();
}

The above method results in a SPLATDI001 error (TConcrete has more than one constructor and one hasn't been marked with DependencyInjectionConstructorAttribute) that is not related to the type being used. The error appears even if the method is not called.

Support IEnumerable dependencies

IEnumerables in constructor injection (and I assume, but have not tested, property injection) are currently not being initialized and left as null. They should be resolved by Locator.Current.GetServices().

Here is a helper method workaround in the meantime.

public static void ResolveIEnumerable<T>(ref IEnumerable<T> target)
{
    // https://github.com/reactivemarbles/Splat.DI.SourceGenerator/issues/72
    if (target != null)
    {
        throw new InvalidOperationException("This issue has been resolved. Remove this method.");
    }

    target = Locator.Current.GetServices<T>();
}