-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update MSTest analyzers for 4.1 release #51464
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
base: main
Are you sure you want to change the base?
Conversation
| dev_langs: | ||
| - CSharp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this shouldn't be needed. But will let @gewarren or someone from docs team to say for sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dev_langs declares which languages the code snippets are available for in the doc, so I think this is correct.
https://learn.microsoft.com/en-us/help/platform/using-dev-langs#defining-dev_langs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds documentation for the new MSTEST0063 analyzer rule introduced in MSTest 4.1, which validates test class constructor signatures. The PR also updates severity descriptions for four existing analyzer rules (MSTEST0001, MSTEST0023, MSTEST0037, and MSTEST0045) to clarify that they were temporarily elevated to Warning in version 4.0 but have since reverted to Info severity.
Changes:
- Added complete documentation for MSTEST0063 rule (test class constructor validation)
- Updated severity descriptions from verbose "Warning starting with 4.0.0, Info before" to concise "Info (Warning in 4.0)" format
- Added MSTEST0063 to table of contents, rule tables, and conceptual groupings
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/navigate/devops-testing/toc.yml | Added MSTEST0063 entry to table of contents |
| docs/core/testing/mstest-analyzers/usage-rules.md | Added MSTEST0063 to usage rules table and test structure section |
| docs/core/testing/mstest-analyzers/overview.md | Added MSTEST0063 to overview table and test structure concept group |
| docs/core/testing/mstest-analyzers/mstest0063.md | New documentation page for MSTEST0063 rule with examples and guidance |
| docs/core/testing/mstest-analyzers/mstest0045.md | Updated severity description for clarity |
| docs/core/testing/mstest-analyzers/mstest0037.md | Updated severity description and reformatted property table |
| docs/core/testing/mstest-analyzers/mstest0023.md | Updated severity description for clarity |
| docs/core/testing/mstest-analyzers/mstest0001.md | Updated severity description for clarity |
Comments suppressed due to low confidence (1)
docs/core/testing/mstest-analyzers/mstest0063.md:75
- According to the Microsoft writing style guide (guideline 1000002), list items should be complete sentences with proper punctuation. These list items should end with periods. For example: "1. Declared as
public." and "1. Either parameterless or accepts a single..."
1. Declared as `public`
1. Either parameterless or accept a single <xref:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext> parameter
Youssef1313
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we also update mstest0062 which is warning by default, not info?
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
Add missing rule documentation and update severity of some rules following release of MSTest 4.1
Fixes microsoft/testfx#7337
Internal previews