Improved message formatting for variable assignment and defining the …

…first positional parameter with piping
Lombiq · Jan 17, 2023 · d000ed3 · d000ed3
1 parent 08e4d67
commit d000ed3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/Lombiq.Analyzers.PowerShell/Invoke-Analyzer.ps1 b/Lombiq.Analyzers.PowerShell/Invoke-Analyzer.ps1
@@ -95,9 +95,11 @@ if ((Get-InstalledModule PSScriptAnalyzer -ErrorAction SilentlyContinue).Version
     catch
     {
         $infoUrl = 'https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules#installing-psscriptanalyzer'
-        Write-FileError ('Unable to detect Invoke-ScriptAnalyzer and failed to install PSScriptAnalyzer. If you are' +
-            ' on Windows Powershell, open an administrator shell and type "Install-Module -Name PSScriptAnalyzer' +
-            " -RequiredVersion $installVersion`". Otherwise see $infoUrl to learn more.")
+        @(
+            'Unable to detect Invoke-ScriptAnalyzer and failed to install PSScriptAnalyzer. If you are on Windows'
+            'Powershell, open an administrator shell and type "Install-Module -Name PSScriptAnalyzer -RequiredVersion'
+            "$installVersion`". Otherwise see $infoUrl to learn more."
+        ) -join ' ' | Write-FileError
         exit -2
     }
 }

diff --git a/...yzers.PowerShell/Rules/Measure-AutomaticVariableAlias/Measure-AutomaticVariableAlias.psm1 b/...yzers.PowerShell/Rules/Measure-AutomaticVariableAlias/Measure-AutomaticVariableAlias.psm1
@@ -48,8 +48,10 @@ function Measure-AutomaticVariableAlias
 
                 $results += [Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord]@{
                     'Extent' = $automaticVariableAliasToken.Extent
-                    'Message' = '"$_" is an alias of the automatic variable "$PSItem". Please consider using the full' +
-                    ' name of this variable for consistency.'
+                    'Message' = @(
+                        '"$_" is an alias of the automatic variable "$PSItem". Please use the full name of this'
+                        'variable for consistency.'
+                    ) -join ' '
                     'RuleName' = 'PSAvoidUsingAutomaticVariableAlias'
                     'RuleSuppressionID' = 'PSAvoidUsingAutomaticVariableAlias'
                     'Severity' = 'Warning'

diff --git a/Lombiq.Analyzers.PowerShell/Rules/Measure-LineContinuation/Measure-LineContinuation.psm1 b/Lombiq.Analyzers.PowerShell/Rules/Measure-LineContinuation/Measure-LineContinuation.psm1
@@ -39,8 +39,10 @@ function Measure-LineContinuation
             {
                 $results += [Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord]@{
                     'Extent' = $lineContinuationToken.Extent
-                    'Message' = 'Using backtick (line continuation) makes the code harder to read and maintain.' +
-                    ' Please use parameter splatting instead.'
+                    'Message' = @(
+                        'Using backtick (line continuation) makes the code harder to read and maintain. Please use'
+                        'parameter splatting instead.'
+                    ) -join ' '
                     'RuleName' = 'PSAvoidUsingLineContinuation'
                     'RuleSuppressionID' = 'PSAvoidUsingLineContinuation'
                     'Severity' = 'Warning'