Clean up PSScriptAnalyzer

Author: Jaykul

Reference/default.ps1

@@ -150,7 +150,7 @@ function Get-ConciseViewPositionMessage {
         $message = $message.Replace($newline, ' ').Replace("`n", ' ').Replace("`t", ' ')
 
         $windowWidth = 120
-        if ($Host.UI.RawUI -ne $null) {
+        if ($null -ne $Host.UI.RawUI) {
             $windowWidth = $Host.UI.RawUI.WindowSize.Width
         }
 

ScriptAnalyzerSettings.psd1

@@ -0,0 +1,4 @@
+@{
+    Severity     = @('Error', 'Warning')
+    ExcludeRules = @('PSAvoidGlobalVars')
+}

source/private/GetConciseMessage.ps1

@@ -8,7 +8,6 @@ filter GetConciseMessage {
     $err = $InputObject
     $posmsg = ''
     $headerWhitespace = ''
-    $offsetWhitespace = ''
     $message = ''
     $prefix = ''
 
@@ -90,7 +89,6 @@ filter GetConciseMessage {
         }
 
         $posmsg += "${accentColor}${lineWhitespace}${ScriptLineNumber} ${verticalBar} ${resetcolor}${line}"
-        $offsetWhitespace = ' ' * $offsetInLine
         $prefix = "${accentColor}${headerWhitespace}     ${verticalBar} ${errorColor}"
         if ($highlightLine -ne '') {
             $posMsg += "${prefix}${highlightLine}${newline}"
@@ -122,7 +120,7 @@ filter GetConciseMessage {
         $message = $message.Replace($newline, ' ').Replace("`n", ' ').Replace("`t", ' ')
 
         $windowWidth = 120
-        if ($Host.UI.RawUI -ne $null) {
+        if ($null -ne $Host.UI.RawUI) {
             $windowWidth = $Host.UI.RawUI.WindowSize.Width
         }
 

source/private/GetErrorMessage.ps1

@@ -6,18 +6,18 @@ filter GetErrorTitle {
         [System.Management.Automation.ErrorRecord]
         $InputObject
     )
-    if (! $err.ErrorDetails -or ! $err.ErrorDetails.Message) {
-        if ($err.CategoryInfo.Category -eq 'ParserError' -and $err.Exception.Message.Contains("~$newline")) {
+    if ($InputObject.ErrorDetails -and $InputObject.ErrorDetails.Message) {
+        $InputObject.ErrorDetails.Message
+    } else {
+        if ($InputObject.CategoryInfo.Category -eq 'ParserError' -and $InputObject.Exception.Message.Contains("~$newline")) {
             # need to parse out the relevant part of the pre-rendered positionmessage
-            $err.Exception.Message.split("~$newline")[1].split("${newline}${newline}")[0]
-        } elseif ($err.Exception) {
-            $err.Exception.Message
-        } elseif ($err.Message) {
-            $err.Message
+            $InputObject.Exception.Message.split("~$newline")[1].split("${newline}${newline}")[0]
+        } elseif ($InputObject.Exception) {
+            $InputObject.Exception.Message
+        } elseif ($InputObject.Message) {
+            $InputObject.Message
         } else {
-            $err.ToString()
+            $InputObject.ToString()
         }
-    } else {
-        $err.ErrorDetails.Message
     }
 }

source/public/ConvertTo-DetailedErrorView.ps1

@@ -23,9 +23,9 @@ filter ConvertTo-DetailedErrorView {
     process {
         $newline + (GetListRecursive $InputObject) + $newline
         if ($Env:GITHUB_ACTIONS) {
-            Write-Host "::error $(GetGoogleWorkflowPositionMesage),title=$(GetErrorTitle $InputObject)::$(GetErrorMessage $InputObject)"
+            "::error $(GetGoogleWorkflowPositionMesage),title=$(GetErrorTitle $InputObject)::$(GetErrorMessage $InputObject)"
         } elseif ($Env:TF_BUILD) {
-            Write-Host "##vso[task.logissue type=error;$(GetAzurePipelinesPositionMesage)]$(GetErrorTitle $InputObject): $(GetErrorMessage $InputObject)"
+            "##vso[task.logissue type=error;$(GetAzurePipelinesPositionMesage)]$(GetErrorTitle $InputObject): $(GetErrorMessage $InputObject)"
         }
     }
 }

source/public/ConvertTo-YamlErrorView.ps1

@@ -5,6 +5,7 @@
         .DESCRIPTION
             This produces valid Yaml output from ErrorRecord you pass to it, recursively.
     #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'maxDepth')]
     [CmdletBinding()]
     param(
         # The object that you want to convert to YAML