Write docs for DependencyPropertyGenerator

[Lamparter]

No description provided.

[michael-hawker]

Would be great to see this expanded to use the generator here in the code-behind, and then see that property bound in the XAML.

[hawkerm]

I know Sergio's been busy to review, and I didn't see movement on the comment. I wanted to do some tinkering in this space, so I did a pass on the doc and integrating the sample into it within the sample app with a NumberBox control.

However, I the generator isn't running within the samples project to provide the implementation of the property:

The attribute is found, I can see the project dependency, but either the generator doesn't appear to even be running:

Rebased this branch on main with my non-working change here: https://github.com/hawkerm/Labs-Windows/tree/dp-generator-docs - I think once the generator runs, it should be fine?

[hawkerm]

I tried checking out a clean main and I actually still can't build the DependencyPropertyGenerator project (in stand-alone component mode, default wasdk setup). I get a bunch of nuget errors like:

1>I:\oss\Labs-Windows\components\DependencyPropertyGenerator\CommunityToolkit.DependencyPropertyGenerator.Tests\CommunityToolkit.DependencyPropertyGenerator.Tests.csproj : error NU1201: Project CommunityToolkit.Labs.WinUI.DependencyPropertyGenerator is not compatible with net8.0-windows10.0.17763 (.NETCoreApp,Version=v8.0). Project CommunityToolkit.Labs.WinUI.DependencyPropertyGenerator supports:
1>I:\oss\Labs-Windows\components\DependencyPropertyGenerator\CommunityToolkit.DependencyPropertyGenerator.Tests\CommunityToolkit.DependencyPropertyGenerator.Tests.csproj : error NU1201:   - net8.0-windows10.0.19041 (.NETCoreApp,Version=v8.0)
1>I:\oss\Labs-Windows\components\DependencyPropertyGenerator\CommunityToolkit.DependencyPropertyGenerator.Tests\CommunityToolkit.DependencyPropertyGenerator.Tests.csproj : error NU1201:   - net9.0-windows10.0.19041 (.NETCoreApp,Version=v9.0)

And these generator errors:

3>I:\oss\Labs-Windows\tooling\CommunityToolkit.App.Shared\AppLoadingView.xaml.cs(113,16,113,39): error CS0103: The name 'ToolkitDocumentRegistry' does not exist in the current context
3>I:\oss\Labs-Windows\tooling\CommunityToolkit.App.Shared\AppLoadingView.xaml.cs(118,16,118,37): error CS0103: The name 'ToolkitSampleRegistry' does not exist in the current context
3>I:\oss\Labs-Windows\tooling\CommunityToolkit.App.Shared\Renderers\ToolkitDocumentationRenderer.xaml.cs(111,29,111,50): error CS0103: The name 'ToolkitSampleRegistry' does not exist in the current context
3>I:\oss\Labs-Windows\tooling\CommunityToolkit.App.Shared\Renderers\ToolkitDocumentationRenderer.xaml.cs(131,36,131,57): error CS0103: The name 'ToolkitSampleRegistry' does not exist in the current context
3>Done building project "DependencyPropertyGenerator.Wasdk.csproj" -- FAILED.

Binlogs: binlogs.zip
VS: 17.14.17

I:\oss\Labs-Windows>msbuild --version
MSBuild version 17.14.23+b0019275e for .NET Framework
17.14.23.42201

I was able to build and run the all components solution... I'll check if the branch works as well, but was confused by the stand-alone component not building for the faster dev loop. (I did notice that opening the all solution changed my multi-targets to include more, including a netstandard one, does that need to be in the default targets list for the generator projects to work?)

Branch still has issue with analyzer not running, I think it's because the samples project just references the src project as a regular project from the standard props file for samples vs. including it as an analyzer type. Trying to add both may be causing a conflict now...

[hawkerm]

I still get lots of weird TFM errors from nuget... these seem ignorable at the moment.

I was thinking trying to add the netstandard target to the multitargets would help, but when I run the single component OpenSolution.bat it resets the multitargets to wasdk and wasm... I can't override that it seems?

Looks like GenerateSingleSolution.ps1 and GenerateSingleSampleHeads.ps1 are missing netstandard as an option, so it can't be added at the end of the OpenSolution.bat for the DependencyPropertyGenerator component? -MultiTargets wasdk, netstandard

But as mentioned, that didn't actually help, removing the auto-added src project from ToolkitComponent.SampleProject.props and adding it to the samples Dependencies.props as an analyzer:

    <ItemGroup>
      <ProjectReference Include="..\src\CommunityToolkit.WinUI.DependencyPropertyGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="True" />  
    </ItemGroup>

Seemed to resolve the triangle warning of the duplicate reference, AND I see it in the analyzer list now, but it's not running still:

Like it's not even saying it's not generating files...

It'd be really nice to show a working embedded sample in the sample app for this stuff.

I can try adding a special prop for the samples config about excluding the src project and then see if I can try in the all solution again where I'm not seeing the other problems with the dependency property project tfms at least...? Otherwise, I'm not sure what else to do here to get this to work.

[hawkerm]

Same issue in the all solution, generator won't run. I see it passed into the Csc step of the XamlPreCompile step as an /analyzer: argument alongside the other generator which is outputting a file:

I finally may be getting somewhere with the SG ReportAnalyzer though...

I then just did a build of the sample project on the command line as per the docs and saw this right after the csc commandline call and before it failed:

  CompilerServer: server failed - server rejected the request due to analyzer / generator issues 'analyzer assembly 'I:\oss\Labs-Windows\components\DependencyPropertyGenerator\src\bin\Debug\net8.0-windows10.0.19041.0\CommunityToolkit.WinUI.DependencyPropertyGenerator.dll' has MVID '95763b3d-8b95-4d45-a6b0-372d398722ca' but loaded assembly 'I:\oss\Labs-Windows\components\DependencyPropertyGenerator\src\bin\Debug\net8.0-windows10.0.19041.0\CommunityToolkit.WinUI.DependencyPropertyGenerator.dll' has MVID 'bdac653d-e093-4dd4-98bb-46d8968e6f30'' - DependencyPropertyGenerator.Samples (net8.0-windows10.0.19041.0)
  Microsoft (R) Visual C# Compiler version 4.14.0-3.25412.6 (c167adef)
  Copyright (C) Microsoft Corporation. All rights reserved.

I:\oss\Labs-Windows\components\DependencyPropertyGenerator\samples\DependencyPropertyGeneratorCustomSample.xaml.cs(15,2
4): error CS9248: Partial property 'DependencyPropertyGeneratorCustomSample.Number' must have an implementation part. [
I:\oss\Labs-Windows\components\DependencyPropertyGenerator\samples\DependencyPropertyGenerator.Samples.csproj::TargetFr
amework=net8.0-windows10.0.19041.0]
  NOTE: Elapsed time may be less than analyzer execution time because analyzers can run concurrently.

  Total analyzer execution time: 0.000 seconds.

  Time (s)    %   Analyzer
    <0.001  100   Microsoft.Interop.LibraryImportGenerator, Version=8.0.12.47513, Culture=neutral, PublicKeyToken=b03f5
  f7f11d50a3a
    <0.001  100      Microsoft.Interop.Analyzers.ShapeBreakingDiagnosticSuppressor (SYSLIBSUPPRESS0001)

  Total generator execution time: 7.429 seconds.

Looks like there's some MVID mismatch? But I'm not sure what would cause that... @Sergio0694 any ideas?

I still have issues just trying to build the stand-alone, e.g.

    I:\oss\Labs-Windows\components\DependencyPropertyGenerator\CommunityToolkit.DependencyPropertyGenerator.Tests\CommunityToolkit.DependencyPropertyGenerator.Tests.csproj : error NU1201:
      Project CommunityToolkit.Labs.WinUI.DependencyPropertyGenerator is not compatible with net8.0-windows10.0.17763 (.
      NETCoreApp,Version=v8.0). Project CommunityToolkit.Labs.WinUI.DependencyPropertyGenerator supports:
        - net8.0-windows10.0.19041 (.NETCoreApp,Version=v8.0)
        - net9.0-windows10.0.19041 (.NETCoreApp,Version=v9.0)

Restore failed with 1 error(s) and 10 warning(s) in 8.7s

[Sergio0694]

"Looks like there's some MVID mismatch? But I'm not sure what would cause that..."

Not entirely sure, also I don't recall seeing this before, and can't repro in other projects (eg. Store, other apps).

@CyrusNajmabadi would you know who we could ask for some help to investigate issues like this? 🤔