Reenable compound assignment preference

[Molkree]

PR Summary

Reenable compound assignment preference in .editorconfig.

PR Context

All violations of the rule should be fixed by now.
Fixes #17631

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
      (which runs in a different PS Host).
      • Issue filed:
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
      • Issue filed:
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
      • Issue filed:
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
      • Issue filed:

[Molkree]

Okay, I already see some missed cases. I wonder what is different between the CI and my local environment?

[Molkree]

Hm, one of them looks like a false positive. In /src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs(1287,25):

                        if (s_defaultMshSnapins == null)
                        {
                            s_defaultMshSnapins = new List<DefaultPSSnapInInformation>()
                            {
#if !UNIX
                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Diagnostics", "Microsoft.PowerShell.Commands.Diagnostics", null,
                                    "GetEventResources,Description", "GetEventResources,Vendor"),
#endif
                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Host", "Microsoft.PowerShell.ConsoleHost", null,
                                    "HostMshSnapInResources,Description", "HostMshSnapInResources,Vendor"),

                                s_coreSnapin,

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Utility", "Microsoft.PowerShell.Commands.Utility", null,
                                    "UtilityMshSnapInResources,Description", "UtilityMshSnapInResources,Vendor"),

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Management", "Microsoft.PowerShell.Commands.Management", null,
                                    "ManagementMshSnapInResources,Description", "ManagementMshSnapInResources,Vendor"),

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Security", "Microsoft.PowerShell.Security", null,
                                    "SecurityMshSnapInResources,Description", "SecurityMshSnapInResources,Vendor")
                            };

#if !UNIX
                            if (!Utils.IsWinPEHost())
                            {
                                s_defaultMshSnapins.Add(new DefaultPSSnapInInformation("Microsoft.WSMan.Management", "Microsoft.WSMan.Management", null,
                                    "WsManResources,Description", "WsManResources,Vendor"));
                            }
#endif
                        }

It's not just an assignment inside the outer if, so analyzer shouldn't trigger here, what do you think?

[Molkree]

I wonder what is different between the CI and my local environment?

The system is different, CI errored on Linux and macOS and I use Windows. 3 cases were inside #if UNIX hence why they didn't trigger for me.

4th one has #if !UNIX clause inside hence why it doesn't trigger on my local machine. But in CI Analyzer thinks there's no extra code inside and suggests this change. I'm not sure if it is correct behaviour.

[Molkree]

It's not just an assignment inside the outer if, so analyzer shouldn't trigger here, what do you think?

We can rewrite the code block into this and it should please Analyzer on both platforms:

#if UNIX
                        s_defaultMshSnapins ??= new List<DefaultPSSnapInInformation>()
                        {
                            new DefaultPSSnapInInformation("Microsoft.PowerShell.Host", "Microsoft.PowerShell.ConsoleHost", null,
                                "HostMshSnapInResources,Description", "HostMshSnapInResources,Vendor"),

                            s_coreSnapin,

                            new DefaultPSSnapInInformation("Microsoft.PowerShell.Utility", "Microsoft.PowerShell.Commands.Utility", null,
                                "UtilityMshSnapInResources,Description", "UtilityMshSnapInResources,Vendor"),

                            new DefaultPSSnapInInformation("Microsoft.PowerShell.Management", "Microsoft.PowerShell.Commands.Management", null,
                                "ManagementMshSnapInResources,Description", "ManagementMshSnapInResources,Vendor"),

                            new DefaultPSSnapInInformation("Microsoft.PowerShell.Security", "Microsoft.PowerShell.Security", null,
                                "SecurityMshSnapInResources,Description", "SecurityMshSnapInResources,Vendor")
                        };
#else
                        if (s_defaultMshSnapins == null)
                        {
                            s_defaultMshSnapins = new List<DefaultPSSnapInInformation>()
                            {
                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Diagnostics", "Microsoft.PowerShell.Commands.Diagnostics", null,
                                    "GetEventResources,Description", "GetEventResources,Vendor"),
                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Host", "Microsoft.PowerShell.ConsoleHost", null,
                                    "HostMshSnapInResources,Description", "HostMshSnapInResources,Vendor"),

                                s_coreSnapin,

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Utility", "Microsoft.PowerShell.Commands.Utility", null,
                                    "UtilityMshSnapInResources,Description", "UtilityMshSnapInResources,Vendor"),

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Management", "Microsoft.PowerShell.Commands.Management", null,
                                    "ManagementMshSnapInResources,Description", "ManagementMshSnapInResources,Vendor"),

                                new DefaultPSSnapInInformation("Microsoft.PowerShell.Security", "Microsoft.PowerShell.Security", null,
                                    "SecurityMshSnapInResources,Description", "SecurityMshSnapInResources,Vendor")
                            };

                            if (!Utils.IsWinPEHost())
                            {
                                s_defaultMshSnapins.Add(new DefaultPSSnapInInformation("Microsoft.WSMan.Management", "Microsoft.WSMan.Management", null,
                                    "WsManResources,Description", "WsManResources,Vendor"));
                            }
                        }
#endif

Or we can ignore this rule locally.

I'll let the maintainers decide.

[iSazonov]

Hm, one of them looks like a false positive. In /src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs(1287,25):

Please suppress locally.

[Molkree]

Please suppress locally.

@iSazonov, done

[iSazonov]

@Molkree I guess CIs fail because we need to fix compound assignment in test code (weblistener).

[Molkree]

@iSazonov, I am stumped, from failing tests I can only see that the WebListener did not start before the timeout was reached., with no pointers as to why. Any help here?

[iSazonov]

@Molkree Try compile test\tools\WebListener\ - I guess there are compound assignments we should fix.

[Molkree]

Try compile test\tools\WebListener\

@iSazonov, thank you!

[ghost]

🎉v7.3.0-preview.7 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes