Merge branch 'main' into test-for-issue-1504

Author: bergmeister

.devcontainer/Dockerfile

@@ -0,0 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+FROM mcr.microsoft.com/dotnet/sdk:8.0
+    
+RUN pwsh --command Install-Module platyPS,Pester -Force

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+// For format details, see https://aka.ms/vscode-remote/devcontainer.json
+{
+    "name": "C# (.NET 8.0)",
+    "dockerFile": "Dockerfile",
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "terminal.integrated.defaultProfile.linux": "pwsh"
+            },
+            "extensions": [
+                "ms-dotnettools.csharp",
+                "ms-vscode.powershell"
+            ]
+        }
+    }
+}

.github/workflows/ci-test.yml

@@ -31,24 +31,43 @@ jobs:
         shell: pwsh
 
       - name: Build
-        run: ./build.ps1 -Configuration Release -All
+        run: ./build.ps1 -Configuration Release -All -Verbose
         shell: pwsh
 
       - name: Package
-        run: ./build.ps1 -BuildNupkg
+        run: ./build.ps1 -BuildNupkg -Verbose
         shell: pwsh
 
       - name: Test
-        run: ./build.ps1 -Test
+        run: ./build.ps1 -Test -Verbose
         shell: pwsh
 
       - name: Test Windows PowerShell
+        if: matrix.os == 'windows-latest'
         run: |
            Install-Module Pester -Scope CurrentUser -Force -SkipPublisherCheck
-           ./build.ps1 -Test
-        if: matrix.os == 'windows-latest'
+           ./build.ps1 -Test -Verbose
         shell: powershell
 
+      - name: Download PowerShell install script
+        uses: actions/checkout@v4
+        with:
+          repository: PowerShell/PowerShell
+          path: pwsh
+          sparse-checkout: tools/install-powershell.ps1
+          sparse-checkout-cone-mode: false
+
+      - name: Install preview
+        continue-on-error: true
+        run: ./pwsh/tools/install-powershell.ps1 -Preview -Destination ./preview
+        shell: pwsh
+
+      - name: Test preview
+        run: |
+          $PwshPreview = if ($isWindows) { "./preview/pwsh.exe" } else { "./preview/pwsh" }
+          ./build.ps1 -Test -WithPowerShell:$PwshPreview -Verbose
+        shell: pwsh
+
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
         if: always()

.pipelines/PSScriptAnalyzer-Official.yml

@@ -80,10 +80,7 @@ extends:
             inputs:
               packageType: sdk
               useGlobalJson: true
-          - pwsh: |
-              Register-PSRepository -Name CFS -SourceLocation "https://pkgs.dev.azure.com/powershell/PowerShell/_packaging/powershell/nuget/v2" -InstallationPolicy Trusted
-              Install-Module -Repository CFS -Name Microsoft.PowerShell.PSResourceGet
-              ./tools/installPSResources.ps1 -PSRepository CFS
+          - pwsh: ./tools/installPSResources.ps1 -PSRepository CFS
             displayName: Install PSResources
           - pwsh: ./build.ps1 -Configuration Release -All
             displayName: Build

CHANGELOG.MD

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## [1.23.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.23.0) - 2024-10-09
+
+## What's Changed
+* Adding OneBranch pipeline YAML config file for OSS_Microsoft_PSSA-Official by @adityapatwardhan in https://github.com/PowerShell/PSScriptAnalyzer/pull/1981
+* Update format and grammar of AvoidUsingAllowUnencryptedAuthentication by @sdwheeler in https://github.com/PowerShell/PSScriptAnalyzer/pull/1974
+* Move to OneBranch Signing and SBOM generation by @TravisEz13 in https://github.com/PowerShell/PSScriptAnalyzer/pull/1982
+* Sync rule docs changes by @sdwheeler in https://github.com/PowerShell/PSScriptAnalyzer/pull/1985
+* Sync docs changes from MicrosoftDocs/PowerShell-Docs-Modules#213 by @sdwheeler in https://github.com/PowerShell/PSScriptAnalyzer/pull/1987
+* Update CHANGELOG for 1.22.0 release by @sdwheeler in https://github.com/PowerShell/PSScriptAnalyzer/pull/1990
+* Update Code of Conduct by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2002
+* Update default type definition of `RuleInfo` by @liamjpeters in https://github.com/PowerShell/PSScriptAnalyzer/pull/2011
+* PSUseConsistentWhitespace: Handle redirect operators which are not in stream order by @liamjpeters in https://github.com/PowerShell/PSScriptAnalyzer/pull/2001
+* Setup GitHub Actions CI by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2018
+* Setup new OneBranch pipeline by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2027
+* Bump SMA version by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2028
+* Package updates by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2030
+* v1.23.0: Update version for new release by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2032
+* Migrate release pipeline to DeployBox by @andyleejordan in https://github.com/PowerShell/PSScriptAnalyzer/pull/2033
+
+## New Contributors
+* @adityapatwardhan made their first contribution in https://github.com/PowerShell/PSScriptAnalyzer/pull/1981
+
 ## [1.22.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.22.0) - 2024-03-05
 
 Minimum required version when using PowerShell 7 is now `7.2.11`.

Directory.Packages.props

@@ -11,7 +11,7 @@
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="Pluralize.NET" Version="1.0.2" />
     <PackageVersion Include="PowerShellStandard.Library" Version="3.0.0-preview-02" />
-    <PackageVersion Include="System.Management.Automation" Version="7.2.23" />
+    <PackageVersion Include="System.Management.Automation" Version="7.4.7" />
     <PackageVersion Include="System.Reflection.TypeExtensions" Version="4.7.0" />
   </ItemGroup>
 </Project>

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -34,7 +34,9 @@ public class InvokeScriptAnalyzerCommand : PSCmdlet, IOutputWriter
 
         #region Private variables
         List<string> processedPaths;
-        private int totalDiagnosticCount = 0;
+        // initialize to zero for all severity enum values
+        private Dictionary<DiagnosticSeverity, int> diagnosticCounts =
+                Enum.GetValues(typeof(DiagnosticSeverity)).Cast<DiagnosticSeverity>().ToDictionary(s => s, _ => 0);
         #endregion // Private variables
 
         #region Parameters
@@ -414,8 +416,35 @@ protected override void EndProcessing()
             ScriptAnalyzer.Instance.CleanUp();
             base.EndProcessing();
 
-            if (EnableExit) {
-                this.Host.SetShouldExit(totalDiagnosticCount);
+            var diagnosticCount = diagnosticCounts.Values.Sum();
+
+            if (ReportSummary.IsPresent)
+            {
+                if (diagnosticCount == 0)
+                {
+                    Host.UI.WriteLine("0 rule violations found.");
+                }
+                else
+                {
+                    var infoCount = diagnosticCounts[DiagnosticSeverity.Information];
+                    var warningCount = diagnosticCounts[DiagnosticSeverity.Warning];
+                    var errorCount = diagnosticCounts[DiagnosticSeverity.Error] + diagnosticCounts[DiagnosticSeverity.ParseError];
+                    var severeDiagnosticCount = diagnosticCount - infoCount;
+
+                    var colorPropertyPrefix = severeDiagnosticCount == 0 ? "Warning" : "Error";
+                    var pluralS = diagnosticCount > 1 ? "s" : string.Empty;
+                    ConsoleHostHelper.DisplayMessageUsingSystemProperties(
+                            Host, colorPropertyPrefix + "ForegroundColor", colorPropertyPrefix + "BackgroundColor",
+                            $"{diagnosticCount} rule violation{pluralS} found. Severity distribution: " +
+                            $"{DiagnosticSeverity.Error} = {errorCount}, " +
+                            $"{DiagnosticSeverity.Warning} = {warningCount}, " +
+                            $"{DiagnosticSeverity.Information} = {infoCount}");
+                }
+            }
+
+            if (EnableExit)
+            {
+                this.Host.SetShouldExit(diagnosticCount);
             }
         }
 
@@ -431,86 +460,47 @@ protected override void StopProcessing()
 
         private void ProcessInput()
         {
-            var diagnosticRecords = RunAnalysis();
-            WriteToOutput(diagnosticRecords);
-            totalDiagnosticCount += diagnosticRecords.Count;
-        }
-
-        private List<DiagnosticRecord> RunAnalysis()
-        {
-            if (!IsFileParameterSet())
+            foreach (var diagnostic in RunAnalysis())
             {
-                return ScriptAnalyzer.Instance.AnalyzeScriptDefinition(scriptDefinition, out _, out _);
-            }
+                diagnosticCounts[diagnostic.Severity]++;
 
-            var diagnostics = new List<DiagnosticRecord>();
-            foreach (string path in this.processedPaths)
-            {
-                if (fix)
+                foreach (var logger in ScriptAnalyzer.Instance.Loggers)
                 {
-                    ShouldProcess(path, $"Analyzing and fixing path with Recurse={this.recurse}");
-                    diagnostics.AddRange(ScriptAnalyzer.Instance.AnalyzeAndFixPath(path, this.ShouldProcess, this.recurse));
-                }
-                else
-                {
-                    ShouldProcess(path, $"Analyzing path with Recurse={this.recurse}");
-                    diagnostics.AddRange(ScriptAnalyzer.Instance.AnalyzePath(path, this.ShouldProcess, this.recurse));
+                    logger.LogObject(diagnostic, this);
                 }
             }
-
-            return diagnostics;
         }
 
-        private void WriteToOutput(List<DiagnosticRecord> diagnosticRecords)
+        private IEnumerable<DiagnosticRecord> RunAnalysis()
         {
-            foreach (ILogger logger in ScriptAnalyzer.Instance.Loggers)
+            if (!IsFileParameterSet())
             {
-                var errorCount = 0;
-                var warningCount = 0;
-                var infoCount = 0;
-                var parseErrorCount = 0;
+                foreach (var record in ScriptAnalyzer.Instance.AnalyzeScriptDefinition(scriptDefinition, out _, out _))
+                {
+                    yield return record;
+                }
+                yield break;
+            }
 
-                foreach (DiagnosticRecord diagnostic in diagnosticRecords)
+            foreach (var path in this.processedPaths)
+            {
+                if (!ShouldProcess(path, $"Analyzing path with Fix={this.fix} and Recurse={this.recurse}"))
                 {
-                    logger.LogObject(diagnostic, this);
-                    switch (diagnostic.Severity)
-                    {
-                        case DiagnosticSeverity.Information:
-                            infoCount++;
-                            break;
-                        case DiagnosticSeverity.Warning:
-                            warningCount++;
-                            break;
-                        case DiagnosticSeverity.Error:
-                            errorCount++;
-                            break;
-                        case DiagnosticSeverity.ParseError:
-                            parseErrorCount++;
-                            break;
-                        default:
-                            throw new ArgumentOutOfRangeException(nameof(diagnostic.Severity), $"Severity '{diagnostic.Severity}' is unknown");
-                    }
+                    continue;
                 }
 
-                if (ReportSummary.IsPresent)
+                if (fix)
                 {
-                    var numberOfRuleViolations = infoCount + warningCount + errorCount;
-                    if (numberOfRuleViolations == 0)
+                    foreach (var record in ScriptAnalyzer.Instance.AnalyzeAndFixPath(path, this.ShouldProcess, this.recurse))
                     {
-                        Host.UI.WriteLine("0 rule violations found.");
+                        yield return record;
                     }
-                    else
+                }
+                else
+                {
+                    foreach (var record in ScriptAnalyzer.Instance.AnalyzePath(path, this.ShouldProcess, this.recurse))
                     {
-                        var pluralS = numberOfRuleViolations > 1 ? "s" : string.Empty;
-                        var message = $"{numberOfRuleViolations} rule violation{pluralS} found.    Severity distribution:  {DiagnosticSeverity.Error} = {errorCount}, {DiagnosticSeverity.Warning} = {warningCount}, {DiagnosticSeverity.Information} = {infoCount}";
-                        if (warningCount + errorCount == 0)
-                        {
-                            ConsoleHostHelper.DisplayMessageUsingSystemProperties(Host, "WarningForegroundColor", "WarningBackgroundColor", message);
-                        }
-                        else
-                        {
-                            ConsoleHostHelper.DisplayMessageUsingSystemProperties(Host, "ErrorForegroundColor", "ErrorBackgroundColor", message);
-                        }
+                        yield return record;
                     }
                 }
             }

Engine/Engine.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <VersionPrefix>$(ModuleVersion)</VersionPrefix>
-    <TargetFrameworks>net6;net462</TargetFrameworks>
+    <TargetFrameworks>net8;net462</TargetFrameworks>
     <AssemblyName>Microsoft.Windows.PowerShell.ScriptAnalyzer</AssemblyName>
     <AssemblyVersion>$(ModuleVersion)</AssemblyVersion>
     <PackageId>Engine</PackageId>
@@ -18,11 +18,11 @@
     <DebugType>portable</DebugType>
   </PropertyGroup>
 
-  <PropertyGroup Condition=" '$(TargetFramework)' == 'net6' ">
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net8' ">
     <DefineConstants>$(DefineConstants);CORECLR</DefineConstants>
   </PropertyGroup>
 
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net6' ">
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net8' ">
     <Compile Remove="SafeDirectoryCatalog.cs" />
   </ItemGroup>
 
@@ -69,10 +69,10 @@
   </PropertyGroup>
 
 
-  <ItemGroup Condition="'$(TargetFramework)' == 'net6'">
+  <ItemGroup Condition="'$(TargetFramework)' == 'net8'">
     <PackageReference Include="System.Management.Automation" />
   </ItemGroup>
-  <PropertyGroup Condition="'$(TargetFramework)' == 'net6'">
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net8'">
     <DefineConstants>$(DefineConstants);PSV7;CORECLR</DefineConstants>
   </PropertyGroup>
 

Engine/Formatter.cs

@@ -47,6 +47,7 @@ public static string Format<TCmdlet>(
                 "PSAvoidUsingDoubleQuotesForConstantString",
                 "PSAvoidSemicolonsAsLineTerminators",
                 "PSAvoidExclaimOperator",
+                "PSAvoidTrailingWhitespace",
             };
 
             var text = new EditableText(scriptDefinition);

Engine/Generic/DiagnosticRecord.cs

@@ -74,7 +74,7 @@ public string ScriptPath
         }
 
         /// <summary>
-        /// Returns the rule id for this record
+        /// Returns the rule suppression id for this record
         /// </summary>
         public string RuleSuppressionID
         {
@@ -88,7 +88,7 @@ public string RuleSuppressionID
         /// </summary>
         public IEnumerable<CorrectionExtent> SuggestedCorrections
         {
-            get { return suggestedCorrections;  }            
+            get { return suggestedCorrections;  }
             set { suggestedCorrections = value; }
         }
 
@@ -100,14 +100,15 @@ public IEnumerable<CorrectionExtent> SuggestedCorrections
         public DiagnosticRecord()
         {
         }
-        
+
         /// <summary>
         /// DiagnosticRecord: The constructor for DiagnosticRecord class that takes in suggestedCorrection
         /// </summary>
         /// <param name="message">A string about why this diagnostic was created</param>
         /// <param name="extent">The place in the script this diagnostic refers to</param>
         /// <param name="ruleName">The name of the rule that created this diagnostic</param>
         /// <param name="severity">The severity of this diagnostic</param>
+        /// <param name="ruleId">The rule suppression ID of this diagnostic</param>
         /// <param name="scriptPath">The full path of the script file being analyzed</param>
         /// <param name="suggestedCorrections">The correction suggested by the rule to replace the extent text</param>
         public DiagnosticRecord(