Added IDE analyzers checks and enabled certain checks by vlada-shubina · Pull Request #8336 · dotnet/msbuild

vlada-shubina · 2023-01-23T08:20:58Z

Related to #7174

Context

While working in the repo different code style issues are observed

Changes Made

enabled IDE code style checks as warning, set the rules that are currently violated to suggestion
auto-fixed IDE0011 - add braces to statement
auto-fixed IDE0036 - modifiers are not ordered
auto-fixed IDE0040 - accessibility modifiers required
auto-fixed IDE0050 - fix formatting, manual disabling was needed for the code in regions compiled for full/core framework
auto-fixed SA1110 and SA1111 - parenthesis formatting, manual disabling was needed for the parameters with conditional compilation.
auto-fixed IDE0073 - A source file contains a header that does not match the required text. Disabled SA1633 as it is same check but required separate config.

All the work was done in separate commits to facilitate easier review.

Testing

Notes

The following checks to be added to #7174 to be gradually fixed:

# Cast is redundant
dotnet_diagnostic.IDE0004.severity = suggestion

# IDE0005: Remove unnecessary usings/imports
dotnet_diagnostic.IDE0005.severity = warning

# Use explicit type instead of 'var'
dotnet_diagnostic.IDE0008.severity = suggestion

# Populate switch
dotnet_diagnostic.IDE0010.severity = suggestion

# Null check can be simplified
dotnet_diagnostic.IDE0016.severity = suggestion

# Object initialization can be simplified
dotnet_diagnostic.IDE0017.severity = suggestion

# Variable declaration can be inlined
dotnet_diagnostic.IDE0018.severity = suggestion

# Use pattern matching
dotnet_diagnostic.IDE0019.severity = suggestion
dotnet_diagnostic.IDE0020.severity = suggestion

# Use expression body for constructor
dotnet_diagnostic.IDE0021.severity = suggestion

# Use expression body for method
dotnet_diagnostic.IDE0022.severity = suggestion

# Use expression body for conversion operator
dotnet_diagnostic.IDE0023.severity = suggestion

# Use block body for operator
dotnet_diagnostic.IDE0024.severity = suggestion

# Use expression body for property
dotnet_diagnostic.IDE0025.severity = suggestion

# Use expression body for indexer
dotnet_diagnostic.IDE0026.severity = suggestion

# Use expression body for accessor
dotnet_diagnostic.IDE0027.severity = suggestion

# Collection initialization can be simplified
dotnet_diagnostic.IDE0028.severity = suggestion

# Null check can be simplified
dotnet_diagnostic.IDE0031.severity = suggestion

# Use auto property
dotnet_diagnostic.IDE0032.severity = suggestion

# 'default' expression can be simplified
dotnet_diagnostic.IDE0034.severity = suggestion

# Member name can be simplified
dotnet_diagnostic.IDE0037.severity = suggestion

# Use local function
dotnet_diagnostic.IDE0039.severity = suggestion

# Null check can be simplified
dotnet_diagnostic.IDE0041.severity = suggestion

# Variable declaration can be deconstructed
dotnet_diagnostic.IDE0042.severity = suggestion

# Made field readonly
dotnet_diagnostic.IDE0044.severity = suggestion

# 'if' statement can be simplified
dotnet_diagnostic.IDE0045.severity = suggestion
dotnet_diagnostic.IDE0046.severity = suggestion

# Parentheses can be removed
dotnet_diagnostic.IDE0047.severity = suggestion

# Parentheses should be added for clarity
dotnet_diagnostic.IDE0048.severity = suggestion

# Member name can be simplified
dotnet_diagnostic.IDE0049.severity = suggestion

# Use compound assignment
dotnet_diagnostic.IDE0054.severity = suggestion

# Indexing can be simplified
dotnet_diagnostic.IDE0056.severity = suggestion

# Slice can be simplified
dotnet_diagnostic.IDE0057.severity = suggestion

# Expression value is never used
dotnet_diagnostic.IDE0058.severity = suggestion

# Unnecessary assignment of a value
dotnet_diagnostic.IDE0059.severity = suggestion

# Remove unused parameter
dotnet_diagnostic.IDE0060.severity = suggestion

# Use expression body for a local function
dotnet_diagnostic.IDE0061.severity = suggestion

# Local function can be made static
dotnet_diagnostic.IDE0062.severity = suggestion

# Using directives must be placed outside of a namespace declaration
dotnet_diagnostic.IDE0065.severity = suggestion

# Use 'switch' expression
dotnet_diagnostic.IDE0066.severity = suggestion

# 'GetHashCode' implementation can be simplified
dotnet_diagnostic.IDE0070.severity = suggestion

# Interpolation can be simplified
dotnet_diagnostic.IDE0071.severity = suggestion

# Populate switch
dotnet_diagnostic.IDE0072.severity = suggestion

# Use compound assignment
dotnet_diagnostic.IDE0074.severity = suggestion

# Conditional expression can be simplified
dotnet_diagnostic.IDE0075.severity = suggestion

# Use pattern matching
dotnet_diagnostic.IDE0078.severity = suggestion
dotnet_diagnostic.IDE0083.severity = suggestion

# 'typeof' can be converted to 'nameof'
dotnet_diagnostic.IDE0082.severity = suggestion

# 'new' expression can be simplified
dotnet_diagnostic.IDE0090.severity = suggestion

# Simplify LINQ expression
dotnet_diagnostic.IDE0120.severity = suggestion

# namespace does not match folder structure
dotnet_diagnostic.IDE0130.severity = suggestion

# Null check can be clarified
dotnet_diagnostic.IDE0150.severity = suggestion

# Convert to block scoped namespaces
dotnet_diagnostic.IDE0160.severity = suggestion

# Simplify property pattern
dotnet_diagnostic.IDE0170.severity = suggestion

# Use tuple to swap values
dotnet_diagnostic.IDE0180.severity = suggestion

# Use tuple to swap values
dotnet_diagnostic.IDE0180.severity = suggestion

# Lambda expression can be removed
dotnet_diagnostic.IDE0200.severity = suggestion

# Convert to top-level statements
dotnet_diagnostic.IDE0210.severity = suggestion

# 'foreach' statement implicitly converts
dotnet_diagnostic.IDE0220.severity = suggestion

# Use UTF-8 string literal
dotnet_diagnostic.IDE0230.severity = suggestion

# Nullable directives
dotnet_diagnostic.IDE0240.severity = suggestion
dotnet_diagnostic.IDE0241.severity = suggestion

# Struct can be made 'readonly'
dotnet_diagnostic.IDE0250.severity = suggestion

# Null check can be simplified
dotnet_diagnostic.IDE0270.severity = suggestion

# naming rule violation
dotnet_diagnostic.IDE1006.severity = suggestion

JanKrivanek

Overall I love this!

I just want to have extra caution around the license header

.editorconfig

src/Build/Evaluation/ProjectRootElementCache.cs

…les to suggestion

manually fixed unresolvable cases

…tch the required text

clarified CTA on how to bypass the error

Recent changes dotnet#8336 and dotnet#8350 collided to produce a build break on just-introduced formatting.

Recent changes #8336 and #8350 collided to produce a build break on just-introduced formatting.

Forgind · 2023-02-06T16:45:42Z

.editorconfig

 dotnet_diagnostic.IDE0005.severity = warning
+
+# Use explicit type instead of 'var'
+dotnet_diagnostic.IDE0008.severity = suggestion


built-in: suggestion
apparent: suggestion
everything else: warning

rainersigwald

Comments from core team discussion.

rainersigwald · 2023-02-06T16:48:11Z

.editorconfig

+dotnet_diagnostic.IDE0008.severity = suggestion
+
+# Populate switch
+dotnet_diagnostic.IDE0010.severity = suggestion


rainersigwald · 2023-02-06T16:53:47Z

.editorconfig

+dotnet_diagnostic.IDE0010.severity = suggestion
+
+# Null check can be simplified
+dotnet_diagnostic.IDE0016.severity = suggestion


leave suggestion, but open to moving to warning if an autofixer is available

rainersigwald · 2023-02-06T16:58:54Z

.editorconfig

+dotnet_diagnostic.IDE0016.severity = suggestion
+
+# Object initialization can be simplified
+dotnet_diagnostic.IDE0017.severity = suggestion


rainersigwald · 2023-02-06T17:04:05Z

.editorconfig

+dotnet_diagnostic.IDE0017.severity = suggestion
+
+# Variable declaration can be inlined
+dotnet_diagnostic.IDE0018.severity = suggestion


rainersigwald · 2023-02-06T17:10:35Z

.editorconfig

+dotnet_diagnostic.IDE0018.severity = suggestion
+
+# Use pattern matching
+dotnet_diagnostic.IDE0019.severity = suggestion


rainersigwald · 2023-02-06T17:41:20Z

.editorconfig

+dotnet_diagnostic.IDE0041.severity = suggestion
+
+# Variable declaration can be deconstructed
+dotnet_diagnostic.IDE0042.severity = suggestion


rainersigwald · 2023-02-06T17:43:15Z

.editorconfig

+dotnet_diagnostic.IDE0042.severity = suggestion
+
+# Made field readonly
+dotnet_diagnostic.IDE0044.severity = suggestion


rainersigwald · 2023-02-06T17:48:00Z

.editorconfig

+dotnet_diagnostic.IDE0045.severity = suggestion
+dotnet_diagnostic.IDE0046.severity = suggestion


rainersigwald · 2023-02-06T17:56:17Z

.editorconfig

+dotnet_diagnostic.IDE0046.severity = suggestion
+
+# Parentheses can be removed
+dotnet_diagnostic.IDE0047.severity = suggestion


rainersigwald · 2023-02-06T17:56:44Z

.editorconfig

+# Parentheses can be removed
+dotnet_diagnostic.IDE0047.severity = suggestion
+
+# Parentheses should be added for clarity


***** start here for follow up

vlada-shubina force-pushed the analyzers branch from 0b809ad to de9558d Compare January 23, 2023 08:31

vlada-shubina marked this pull request as ready for review January 23, 2023 08:32

vlada-shubina marked this pull request as draft January 23, 2023 08:34

JanKrivanek approved these changes Jan 23, 2023

View reviewed changes

.editorconfig Outdated Show resolved Hide resolved

src/Build/Evaluation/ProjectRootElementCache.cs Outdated Show resolved Hide resolved

vlada-shubina marked this pull request as ready for review January 23, 2023 10:33

vlada-shubina force-pushed the analyzers branch 2 times, most recently from 4a9dc2c to 67bfb7d Compare January 23, 2023 15:17

AR-May approved these changes Jan 26, 2023

View reviewed changes

vlada-shubina added 12 commits January 26, 2023 10:46

added IDE code style checks as warning, set the currently violated ru…

72940a7

…les to suggestion

auto-fixed IDE0011 - add braces to statement

4ae04be

auto-fixed IDE0036 - Modifiers are not ordered

e22b8c8

auto fixed IDE0040 - Accessibility modifiers required

3ac17f2

auto-fixed IDE0055 - fix formatting

fa8541f

auto-fixed SA1110 and SA1111 - parenthesis formatting

7244df2

manually fixed unresolvable cases

auto-fixed IDE0073 - A source file contains a header that does not ma…

108b8df

…tch the required text

moved IDE rules to .editorconfig as they need to be filtered

334aa4f

added IDE0020 - use pattern matching to be excluded

b0d6332

extra disable format due to chunk of code conditioned for DEBUG only

d7d2ce0

added comment in Version line to bypass the check

aba947a

clarified CTA on how to bypass the error

extra disable format due to chunk of code conditioned for DEBUG only

83fd3ba

vlada-shubina force-pushed the analyzers branch from a489431 to 83fd3ba Compare January 26, 2023 10:03

MichalPavlik merged commit 56087a9 into dotnet:main Jan 26, 2023

rainersigwald mentioned this pull request Jan 26, 2023

Space around braces #8357

Merged

rainersigwald added a commit to rainersigwald/msbuild that referenced this pull request Jan 26, 2023

Space around braces

04dc9a1

Recent changes dotnet#8336 and dotnet#8350 collided to produce a build break on just-introduced formatting.

rainersigwald added a commit that referenced this pull request Jan 26, 2023

Space around braces (#8357)

8ac0c30

Recent changes #8336 and #8350 collided to produce a build break on just-introduced formatting.

vlada-shubina mentioned this pull request Jan 30, 2023

Change CodeAnalysis rules from 'Info' to 'Warning' after fixing all instances of the violations #7174

Open

Forgind reviewed Feb 6, 2023

View reviewed changes

rainersigwald reviewed Feb 6, 2023

View reviewed changes

		dotnet_diagnostic.IDE0045.severity = suggestion
		dotnet_diagnostic.IDE0046.severity = suggestion

Conversation

vlada-shubina commented Jan 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes Made

Testing

Notes

Uh oh!

JanKrivanek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rainersigwald left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

vlada-shubina commented Jan 23, 2023 •

edited

Loading