🧪 [Experiment] DependencyPropertyGenerator #624

Sergio0694 · 2024-12-28T00:34:18Z

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

…r component

…cyPropertyGenerator tests

…l, and global.json

…no/Wasm compatibility

…nerator component

Lamparter

This is looking amazing ❤️

Arlodotexe · 2025-01-08T19:04:23Z

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 · 2025-01-08T21:01:40Z

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 · 2025-01-13T17:56:12Z

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

Arlodotexe · 2025-01-13T17:56:46Z

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 · 2025-01-24T23:58:19Z

@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 · 2025-01-25T00:01:36Z

...s/DependencyPropertyGenerator/src/CommunityToolkit.WinUI.DependencyPropertyGenerator.targets

+    <DependencyPropertyGeneratorUseWindowsUIXaml Condition="'$(DependencyPropertyGeneratorUseWindowsUIXaml)' == '' AND '$(TargetPlatformIdentifier)' == 'UAP'">true</DependencyPropertyGeneratorUseWindowsUIXaml>
+    <DependencyPropertyGeneratorUseWindowsUIXaml Condition="'$(DependencyPropertyGeneratorUseWindowsUIXaml)' == '' AND '$(UseUwp)' == 'true'">true</DependencyPropertyGeneratorUseWindowsUIXaml>
+    <DependencyPropertyGeneratorUseWindowsUIXaml Condition="'$(DependencyPropertyGeneratorUseWindowsUIXaml)' == ''">false</DependencyPropertyGeneratorUseWindowsUIXaml>
+  </PropertyGroup>


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?

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

@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 build 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 · 2025-01-25T00:02:14Z

@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 and others added 30 commits December 2, 2024 16:55

Generated DependencyPropertyGenerator component from template

054506c

Port files from private repo

4ed6172

Cleanup and merge ported csproj, rename files

794d0c3

Fix default namespace and package name for DependencyPropertyGenerato…

bd3f0c5

…r component

Disable globalusings in DependencyPropertyGenerator

28b5c83

Move files, fix folder name

8e7694f

Bring back embedded resources

54f0445

Fix folder name typo

9aec601

Fix project references and update embedded resource paths in Dependen…

f472ab0

…cyPropertyGenerator tests

Fix wrong paths in test project

a559c58

Fix more wrong paths

bf62d4d

Fix some warnings in the test project

eb854c9

Create .gitattributes

df93079

Fix newlines to LF

03f041e

Use 'WellKnownTypeNames' in all analyzers

d503756

Remove global usings

8846a70

Finish 'InvalidPropertyDefaultValueTypeAnalyzer'

51d44bd

Add unit tests

6b2d0cb

Consolidate GlobalUsings imports around tooling

6c1ceb7

Fixed namespace errors when running under Uno

d9bec94

Update tooling submodule

291f7fa

Remove LangVersion setting from DependencyPropertyGenerator project

9637c3a

Ran XAML styler

9f0809d

Remove empty samples

8436bde

Remove empty component doc to fix CI error

1babcec

Remove unused test files from DependencyPropertyGenerator project

c2351ac

Update .NET version to 9.0 in Dockerfile, devcontainer.json, build.ym…

471c161

…l, and global.json

Fixed compilation conditionals

9657827

Temporarily limit WinUI and multitarget options in build matrix for U…

10499ac

…no/Wasm compatibility

Temporarily disable wasm-linux check, only build DependencyPropertyGe…

da2b2c3

…nerator component

Sergio0694 added 12 commits January 4, 2025 14:29

Update code fixer unit tests

2f412cc

Enable diagnostics on orphaned properties, add tests

544c0e5

Emit 'WCTDP0030' even on misnamed fields

ddce264

Add new diagnostics for default values

2ca8aa8

Improve message formats for some diagnostics

d518919

Handle 'UnsetValue' in analyzer and code fixer

ff99c77

Fix format message for 'WCTDP0028' diagnostic

901c106

Add more unit tests for 'WCTDP0030' diagnostic

515a42c

Emit diagnostics even if default value is not constant

d6743ba

Handle name colon in forwarded attribute arguments

c3ec9cf

Tweak diagnostic error codes

762665e

Update the embedded attribute type source file

f43c0e4

Lamparter approved these changes Jan 5, 2025

View reviewed changes

Sergio0694 added 7 commits January 5, 2025 22:56

Merge branch 'main' into component/DependencyPropertyGenerator

36c1995

Analyze default values even if callback is present

c8835d3

Analyze more cases even with invalid field declarations

f7f3e86

Fix nullability checks in type parameter constraints

fd9faea

Add more nullability test cases

9a56de0

Support target-typed 'new()' expressions for metadata

1d9ba0a

Fix some incorrect diagnostic messages

74109d6

Sergio0694 added 3 commits January 17, 2025 19:58

Fix UWP detection on modern .NET

f68b369

Add '[GeneratedAppServiceHost]' attribute type

70c49d1

Add 'AppServiceHost.OnCloseRequested' method

7ccd2f5

michael-hawker reviewed Jan 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🧪 [Experiment] DependencyPropertyGenerator #624

🧪 [Experiment] DependencyPropertyGenerator #624

Sergio0694 commented Dec 28, 2024 •

edited

Loading

Lamparter left a comment

Arlodotexe commented Jan 8, 2025 •

edited

Loading

Sergio0694 commented Jan 8, 2025

michael-hawker commented Jan 13, 2025

Arlodotexe commented Jan 13, 2025 •

edited

Loading

michael-hawker commented Jan 24, 2025

michael-hawker Jan 25, 2025

Sergio0694 Jan 25, 2025 •

edited

Loading

Arlodotexe Jan 25, 2025 •

edited

Loading

Sergio0694 commented Jan 25, 2025

🧪 [Experiment] DependencyPropertyGenerator #624

Are you sure you want to change the base?

🧪 [Experiment] DependencyPropertyGenerator #624

Conversation

Sergio0694 commented Dec 28, 2024 • edited Loading

Closes #621

Lamparter left a comment

Choose a reason for hiding this comment

Arlodotexe commented Jan 8, 2025 • edited Loading

Sergio0694 commented Jan 8, 2025

michael-hawker commented Jan 13, 2025

Arlodotexe commented Jan 13, 2025 • edited Loading

michael-hawker commented Jan 24, 2025

michael-hawker Jan 25, 2025

Choose a reason for hiding this comment

Sergio0694 Jan 25, 2025 • edited Loading

Choose a reason for hiding this comment

Arlodotexe Jan 25, 2025 • edited Loading

Choose a reason for hiding this comment

Sergio0694 commented Jan 25, 2025

Sergio0694 commented Dec 28, 2024 •

edited

Loading

Arlodotexe commented Jan 8, 2025 •

edited

Loading

Arlodotexe commented Jan 13, 2025 •

edited

Loading

Sergio0694 Jan 25, 2025 •

edited

Loading

Arlodotexe Jan 25, 2025 •

edited

Loading