Merge pull request #347 from SSvilen/KeywordSpaceAfterCheck

PSScriptAnalyzer: One Space Between Keyword and Parenthesis check

Author: PlagueHO

CHANGELOG.md

@@ -78,6 +78,7 @@
 - Removed the legacy `CHANGELOG` link in the `README.md` table of contents.
 - Fixed broken links and formatting in the `README.md` file.
 - Added Measure-Keyword function to check if all keywords are in lower case.
+  - If a keyword is followed by parentheses,there should be a single space between them.
 
 ## 0.3.0.0
 

DscResource.AnalyzerRules/DscResource.AnalyzerRules.psm1

@@ -1036,14 +1036,24 @@ function Measure-Keyword
         $script:diagnosticRecord['RuleName'] = $PSCmdlet.MyInvocation.InvocationName
 
         $keywordFlag = [System.Management.Automation.Language.TokenFlags]::Keyword
-        $upperCaseTokens = $Token.Where( { $_.TokenFlags.HasFlag($keywordFlag) -and $_.Text -cmatch '[A-Z]+' })
+        $keywords = $Token.Where{ $_.TokenFlags.HasFlag($keywordFlag) }
+        $upperCaseTokens = $keywords.Where{ $_.Text -cmatch '[A-Z]+' }
+
+        $tokenWithNoSpace = $keywords.Where{ $_.Extent.StartScriptPosition.Line -match "$($_.Extent.Text)\(.*" }
 
         foreach ($item in $upperCaseTokens)
         {
             $script:diagnosticRecord['Extent'] = $item.Extent
             $script:diagnosticRecord['Message'] = $localizedData.StatementsContainsUpperCaseLetter -f $item.Text
             $script:diagnosticRecord -as $diagnosticRecordType
-        } #if
+        }
+
+        foreach ($item in $tokenWithNoSpace)
+        {
+            $script:diagnosticRecord['Extent'] = $item.Extent
+            $script:diagnosticRecord['Message'] = $localizedData.OneSpaceBetweenKeywordAndParenthesis
+            $script:diagnosticRecord -as $diagnosticRecordType
+        }
     }
     catch
     {

DscResource.AnalyzerRules/en-US/DscResource.AnalyzerRules.psd1

@@ -42,4 +42,5 @@ EnumOpeningBraceShouldBeFollowedByOnlyOneNewLine = Opening brace on Enum should
 ClassOpeningBraceNotOnSameLine = Class should not have the open brace on the same line as the declaration. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#one-newline-before-braces
 ClassOpeningBraceShouldBeFollowedByNewLine = Opening brace on Class should be followed by a new line. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#one-newline-after-opening-brace
 ClassOpeningBraceShouldBeFollowedByOnlyOneNewLine = Opening brace on Class should only be followed by one new line. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#one-newline-after-opening-brace
+OneSpaceBetweenKeywordAndParenthesis = If a keyword is followed by a parenthesis, there should be single space between the keyword and the parenthesis. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#one-newline-after-opening-brace
 '@

Tests/Unit/DscResource.AnalyzerRules.Tests.ps1

@@ -3315,6 +3315,23 @@ Describe 'Measure-Keyword' {
             }
         }
 
+        Context 'When keyword is not followed by a single space' {
+            It 'Should write the correct error record' {
+                $definition = '
+                        if("example" -eq "example" -or "magic")
+                        {
+                            Write-Verbose -Message "Example found."
+                        }
+                    '
+
+                $token = Get-TokensFromDefinition -ScriptDefinition $definition
+                $record = Measure-Keyword -Token $token
+                ($record | Measure-Object).Count | Should -Be 1
+                $record.Message | Should -Be $localizedData.OneSpaceBetweenKeywordAndParenthesis
+                $record.RuleName | Should -Be $ruleName
+            }
+        }
+
         Context 'When keyword does not contain upper case letters' {
             It 'Should not return an error record' {
                 $definition = '
@@ -3329,12 +3346,28 @@ Describe 'Measure-Keyword' {
                 ($record | Measure-Object).Count | Should -Be 0
             }
         }
+
+        Context 'When keyword is followed by a single space' {
+            It 'Should not return an error record' {
+                $definition = '
+                        if ("example" -eq "example" -or "magic")
+                        {
+                            Write-Verbose -Message "Example found."
+                        }
+                    '
+
+                $token = Get-TokensFromDefinition -ScriptDefinition $definition
+                $record = Measure-Keyword -Token $token
+                ($record | Measure-Object).Count | Should -Be 0
+            }
+        }
     }
 
     Context 'When calling PSScriptAnalyzer' {
         BeforeAll {
             $invokeScriptAnalyzerParameters = @{
                 CustomRulePath = $modulePath
+                IncludeRule    = 'Measure-Keyword'
             }
             $ruleName = "$($script:ModuleName)\Measure-Keyword"
         }
@@ -3356,19 +3389,48 @@ Describe 'Measure-Keyword' {
                 }
             }
 
+            Context 'When keyword is not followed by a single space' {
+                It 'Should write the correct error record' {
+                    $invokeScriptAnalyzerParameters['ScriptDefinition'] = '
+                            if("example" -eq "example" -or "magic")
+                            {
+                                Write-Verbose -Message "Example found."
+                            }
+                        '
+
+                    $record = Invoke-ScriptAnalyzer @invokeScriptAnalyzerParameters
+                    ($record | Measure-Object).Count | Should -Be 1
+                    $record.Message | Should -Be $localizedData.OneSpaceBetweenKeywordAndParenthesis
+                    $record.RuleName | Should -Be $ruleName
+                }
+            }
+
             Context 'When keyword does not contain upper case letters' {
                 It 'Should not return an error record' {
-                    $definition = '
+                    $invokeScriptAnalyzerParameters['ScriptDefinition'] = '
                             function Test
                             {
                                return $true
                             }
                         '
 
                     $record = Invoke-ScriptAnalyzer @invokeScriptAnalyzerParameters
-                    ($record | Measure-Object).Count | Should -BeExactly 1
+                    ($record | Measure-Object).Count | Should -BeExactly 0
                 }
-        }
+            }
+
+            Context 'When keyword is followed by a single space' {
+                It 'Should not return an error record' {
+                    $invokeScriptAnalyzerParameters['ScriptDefinition'] = '
+                            if ("example" -eq "example" -or "magic")
+                            {
+                                Write-Verbose -Message "Example found."
+                            }
+                        '
+                    $record = Invoke-ScriptAnalyzer @invokeScriptAnalyzerParameters
+                    ($record | Measure-Object).Count | Should -Be 0
+                }
+            }
         }
     }
 }