🧪 [Experiment] DependencyPropertyGenerator

[Sergio0694]

Closes #621

This PR introduces a new DependencyPropertyGenerator component that utilizes source generators on partial properties to generate DependencyProperty quickly in your projects. This is the final API shape available with this PR:

namespace CommunityToolkit.WinUI;

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public sealed class GeneratedDependencyPropertyAttribute : Attribute
{
    public object? DefaultValue { get; init; }

    [DisallowNull]
    public string? DefaultValueCallback { get; init; }

    public bool IsLocalCacheEnabled { get; init; }

    [DisallowNull]
    public Type? PropertyType { get; init; }
}

public sealed class GeneratedDependencyProperty
{
    public const object UnsetValue;
}

This went through some community discussion before the current API design was finalized.

This PR includes:

• The thin API surface with the attribute
• A source generator for the attribute
• A comprehensive set of analyzers
• A code fixer to easily update all trivially supported dependency projects in a project/solution

[Lamparter]

This is looking amazing ❤️

[Arlodotexe]

The completeness and stability of the code here inclines me to suggest including it in the mainline repo for 8.2, rather than housing the component in Labs. Labs is a parallel repo where we do incubation and new stuff until stable. Nearing 200 commits, this new component seems stable and well-tested.

[Sergio0694]

It's well-tested in the sense that I have a ton of unit tests, but it's not really stable. It basically has 0 use in production. I fully expect that stuff might come up to warrant changing the API surface a bit or altering the generated code. Doing that would be a breaking change. I think it'd make sense to let this incubate a bit so that we can be sure stuff doesn't come up 🤔

[michael-hawker]

Yeah, seems like we should just merge this into Labs and get feedback on this here? That's its purpose.

[Arlodotexe]

Understood. If we expect that the API surface might change, then testing production via Labs before including it in 8.x stable makes sense.

[michael-hawker]

@Sergio0694 I assume we think the API is relatively good at this point.

Whenever we get the next clean build, it'd be nice to merge and get more eyes on things in a way other folks can use in the Labs feed. We can continue to make improvements in Labs, that's the point of it.

[michael-hawker]

Rather than having this be a bool, would it be better to have specific states? Like could we ever differentiate between WinUI 3 and WPF? In a similar to your check for "UseUwp"? Just wondering if we can generalize this at all in the future?

[Sergio0694]

That would introduce complexity and I don't really plan on ever adding WPF support for this 😅

[Arlodotexe]

@michael-hawker There are some subtle differences between the DP system in traditional WPF and the
DP system in UWP/WASDK, but this generator wasn't built with those differences in mind. If it were, we might consider supporting traditional WPF in the future, but it would require significant planning that hasn't happened yet.

The primary target here was WinUI, same as all components that use our tooling. Nothing else in the Windows Community Toolkit supports WPF, outside of the WinUI-based MultiTarget afforded to us by Uno. Being WinUI-based, this generator already supports those targets.

Adding traditional WPF in any capacity would stretch both the generator code and our tooling beyond what they're currently designed to do.

[Sergio0694]

@michael-hawker yup, already on it 😄
I'm just working with Arlo to fix the CI, that's the only reason why this hasn't been merged yet!

[Arlodotexe]

CI has revealed another error that needs fixing:

       "D:\a\Labs-Windows\Labs-Windows\CommunityToolkit.AllComponents.sln" (default target) (1:2) ->
       "D:\a\Labs-Windows\Labs-Windows\components\AppServices\src\CommunityToolkit.AppServices.csproj" (default target) (3:20) ->
       "D:\a\Labs-Windows\Labs-Windows\components\AppServices\src\CommunityToolkit.AppServices.csproj" (Build target) (3:26) ->
         D:\a\Labs-Windows\Labs-Windows\components\AppServices\src\AppServiceHost.cs(148,63): error CS1584: XML comment has syntactically incorrect cref attribute 'SystemNavigationManagerPreview.GetForCurrentView().CloseRequested' [D:\a\Labs-Windows\Labs-Windows\components\AppServices\src\CommunityToolkit.AppServices.csproj::TargetFramework=net9.0-windows10.0.17763.0]

[Sergio0694]

Fixed!