Enable IDE0044: MakeFieldReadonly by xtqqczze · Pull Request #13880 · PowerShell/PowerShell

xtqqczze · Oct 26, 2020

Enable IDE0044: MakeFieldReadonly as warning.

Add suppression for ComInterop via GlobalSuppressions.cs
Convert a few static readonly fields to const.

iSazonov · Nov 2, 2020

@xtqqczze Please resolve merge conflicts and rebase.

xtqqczze · Nov 2, 2020

@iSazonov We can reuse this PR for src\Microsoft.Management.Automation changes?

iSazonov · Nov 2, 2020

The PR is still huge.

xtqqczze · Jun 27, 2021

@iSazonov ComInterop is frozen, but the code is not structured in separate project from System.Management.Automation, so we cannot currently disable analyzers for only ComInterop :(

D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(18,23): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(19,23): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(23,21): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(24,24): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(25,24): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ExcepInfo.cs(26,21): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]
D:\a\1\s\src\System.Management.Automation\engine\ComInterop\ComInvokeBinder.cs(26,37): error IDE0044: Make field readonly [D:\a\1\s\src\System.Management.Automation\System.Management.Automation.csproj]

iSazonov · Jun 28, 2021

@xtqqczze Please look the code in .Net Runtime repository. Perhaps they already fixed the issues. If no we could suppress the warnings on file level:

[ExcepInfo.cs]
dotnet_diagnostic.IDE0044.severity = none

(For generated code https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-options#exclude-generated-code)

Co-authored-by: Paul Higinbotham <paulhi@microsoft.com>

requested by @PaulHigin

xtqqczze · Jun 29, 2021

/home/vsts/work/1/s/src/System.Management.Automation/engine/interpreter/InstructionList.cs(99,49): error CS0649: Field 'InstructionList._debugCookies' is never assigned to, and will always have its default value null [/home/vsts/work/1/s/src/System.Management.Automation/System.Management.Automation.csproj]

iSazonov · Jun 29, 2021

@xtqqczze Please look the code in .Net Runtime repository. Perhaps they already fixed the issues. If no we could suppress the warnings on file level:
[ExcepInfo.cs]
dotnet_diagnostic.IDE0044.severity = none
(For generated code https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-options#exclude-generated-code)

Doesn't this work?

Configure code analysis rules - .NET
Learn how to configure code analysis rules in an analyzer configuration file.

xtqqczze · Jun 30, 2021

@xtqqczze Please look the code in .Net Runtime repository. Perhaps they already fixed the issues. If no we could suppress the warnings on file level:
[ExcepInfo.cs]
dotnet_diagnostic.IDE0044.severity = none
(For generated code https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-options#exclude-generated-code)
Doesn't this work?

@iSazonov Unless I specify the absolute path, I see warning InvalidGlobalSectionName, so probably this approach doesn't work in a GlobalConfig file. In any case, suppression in a GlobalSuppressions.cs file works for this PR. Ideally, the ComInterop code would be split to separate project and we set RunAnalyzers to false in the csproj. We could open an issue to discuss the best approach.

xtqqczze · Jul 1, 2021

Depends on #15704.

iSazonov · Jul 1, 2021

@iSazonov Unless I specify the absolute path, I see warning InvalidGlobalSectionName, so probably this approach doesn't work in a GlobalConfig file. In any case, suppression in a GlobalSuppressions.cs file works for this PR. Ideally, the ComInterop code would be split to separate project and we set RunAnalyzers to false in the csproj. We could open an issue to discuss the best approach.

absolute path? What about relative?

I don't like the assembly level suppression and I'd consider it as only last resort.

I believe we don't want ComInterop in separate project because we don't want new additional dll.

xtqqczze · Jul 3, 2021

@iSazonov Unless I specify the absolute path, I see warning InvalidGlobalSectionName, so probably this approach doesn't work in a GlobalConfig file. In any case, suppression in a GlobalSuppressions.cs file works for this PR. Ideally, the ComInterop code would be split to separate project and we set RunAnalyzers to false in the csproj. We could open an issue to discuss the best approach.

absolute path? What about relative?

I don't like the assembly level suppression and I'd consider it as only last resort.

It seems that section headers for global AnalyzerConfig files must specify an absolute file path. A relative file path produces a compiler warning and is ignored.

Prosper-web

Good

ghost · Jul 22, 2021

🎉v7.2.0-preview.8 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

ghost assigned anmenaga Oct 26, 2020

xtqqczze mentioned this pull request Oct 26, 2020

Enable Roslyn analyzers in build process #11916

Closed

14 tasks

xtqqczze force-pushed the IDE0044 branch from d927897 to bd574d5 Compare October 26, 2020 16:19

xtqqczze marked this pull request as ready for review October 27, 2020 20:49

xtqqczze requested review from SteveL-MSFT, TravisEz13, adityapatwardhan, anmenaga and daxian-dbw as code owners October 27, 2020 20:49

xtqqczze changed the title ~~Enable IDE0044: MakeFieldReadonly~~ Enable IDE0044: MakeFieldReadonly part 11 Nov 2, 2020

xtqqczze force-pushed the IDE0044 branch from bd574d5 to efd5e63 Compare November 2, 2020 10:44

xtqqczze changed the title ~~Enable IDE0044: MakeFieldReadonly part 11~~ Enable IDE0044: MakeFieldReadonly Nov 2, 2020

ghost removed the Review - Needed The PR is being reviewed label Jun 28, 2021

PaulHigin suggested changes Jun 28, 2021

View reviewed changes

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jun 28, 2021

xtqqczze and others added 5 commits June 29, 2021 01:28

Apply suggestions from code review

94576a5

Co-authored-by: Paul Higinbotham <paulhi@microsoft.com>

Revert and suppress

e45adb0

Add Github issue link

e616c49

Suppress IDE0044 for System.Management.Automation.ComInterop

57aae3d

Fix CA1805

c65645f

requested by @PaulHigin

Fix CS0649

1a0c328

Prosper-web approved these changes Jul 3, 2021

View reviewed changes

iSazonov approved these changes Jul 4, 2021

View reviewed changes

iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Jul 4, 2021

PaulHigin approved these changes Jul 6, 2021

View reviewed changes

iSazonov merged commit 03b07a0 into PowerShell:master Jul 7, 2021

iSazonov assigned iSazonov and unassigned anmenaga Jul 7, 2021

iSazonov added this to the 7.2.0-preview.8 milestone Jul 7, 2021

xtqqczze mentioned this pull request Jul 7, 2021

Fix HyperVSocketEndPoint.ServiceId setter #15704

Merged

xtqqczze deleted the IDE0044 branch July 7, 2021 06:36

xtqqczze mentioned this pull request Sep 27, 2022

Remove PathSearchTrimEnd #18166

Closed

22 tasks

Search code, repositories, users, issues, pull requests...

Conversation

xtqqczze commented Oct 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Nov 2, 2020

Uh oh!

iSazonov commented Nov 2, 2020

Uh oh!

xtqqczze commented Jun 27, 2021

Uh oh!

iSazonov commented Jun 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xtqqczze commented Jun 29, 2021

Uh oh!

iSazonov commented Jun 29, 2021 • edited by unfurl-links Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Jun 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Jul 1, 2021

Uh oh!

iSazonov commented Jul 1, 2021

Uh oh!

xtqqczze commented Jul 3, 2021

Uh oh!

Prosper-web left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Jul 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

xtqqczze commented Oct 26, 2020 •

edited

Loading

iSazonov commented Nov 2, 2020 •

edited

Loading

iSazonov commented Jun 28, 2021 •

edited

Loading

iSazonov commented Jun 29, 2021 •

edited by unfurl-links Bot

Loading

xtqqczze commented Jun 30, 2021 •

edited

Loading