Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Diagnostic rules #685

Merged
merged 11 commits into from
Jan 26, 2021
Merged

Update Diagnostic rules #685

merged 11 commits into from
Jan 26, 2021

Conversation

j0shuams
Copy link
Contributor

@j0shuams j0shuams commented Jan 22, 2021

This PR introduces two new files -- AnalzyerReleases.Unshipped.md and AnalyzerReleases.Shipped.md
These are made from our diagnostic descriptors, and serve as a documentation page for our rules.
I am also changing the "WME" identifier of the rules to be "CsWinRT", which required a change in our diagnostic unit testing app.

I have updated our .gitignore as well, as there is a new directory that we don't want to track for our winui packaging sample.

closes #676 , addresses part of #677

@@ -18,124 +18,125 @@ private static DiagnosticDescriptor MakeRule(string id, string title, string mes
category: "Usage",
defaultSeverity: DiagnosticSeverity.Error,
isEnabledByDefault: true,
helpLinkUri: "https://docs.microsoft.com/en-us/previous-versions/hh977010(v=vs.110)");
helpLinkUri: "https://github.com/microsoft/CsWinRT/tree/master/src/Authoring/WinRT.SourceGenerator/AnalyzerReleases.Unshipped.md");
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want this to be AnalyzerReleases.Shipped.md, but I am not sure when we consider a version of our SourceGenerator analyzer "released"

.gitignore Outdated Show resolved Hide resolved
@j0shuams j0shuams merged commit 5351b4b into master Jan 26, 2021
@j0shuams j0shuams deleted the jlarkin/update-diagnostics branch January 26, 2021 15:26
@j0shuams j0shuams restored the jlarkin/update-diagnostics branch January 26, 2021 15:28
@j0shuams j0shuams deleted the jlarkin/update-diagnostics branch February 8, 2021 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename "WME" in Diagnostic rules
2 participants