microsoft / microsoft/CsWinRT

[Diagnostics] Check against WindowsRuntimeType attribute when checking types

Open
#649 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

authoring
Dominant language
C#
Stars
665
Forks
134
Avg merge
1d 3h
Merged PRs (30d)
32

Description

This issue is related to the diagnostic work in the cswinrt source generator, used for component authoring.
Today we check for invalid types, but there could be a valid, non-WinRT type used that goes unnoticed. We should block it as invalid.

For example, if someone uses System.Version, which does not have a custom mapping we would need to block it.
Or, if someone references another dotnet library that does not use CsWinRT.

For most things, add a check like this would help.

When the type is also authored in c# it won't have the attribute, so we need to check to see if it has a "ABI.Impl" type, or something else altogether.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/Authoring/WinRT.SourceGenerator/WinRTTypeWriter.cs near the referenced check at line 482, then trace the diagnostic validation for component-authoring types. Verify that types such as System.Version and types from libraries without CsWinRT metadata are rejected, while C#-authored types with an ABI.Impl type are handled correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
desktop, devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.