-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
139 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <# | ||
| - Ensures preprocessor symbols have uppercase stems. | ||
| - Ensures there is no space after the '#' character. | ||
| .PARAMETER filePath | ||
| The path to the file to be checked. | ||
| .PARAMETER symbolConfigs | ||
| An array of hash tables where each entry has a stem, an upper, and a lower bound. | ||
| .EXAMPLE | ||
| $alfiles = Get-ChildItem -Recurse -Filter *.al -Path .\App\ | ||
| foreach ($alfile in $alfiles) { | ||
| $symbolConfigs = @( | ||
| @{stem="CLEAN"; lowerBound=22; upperBound=26}, | ||
| @{stem="CLEANSCHEMA"; lowerBound=22; upperBound=26} | ||
| ) | ||
| Test-PreprocessorSymbols -filePath $alfile.FullName -symbolConfigs $symbolConfigs | ||
| } | ||
| .NOTES | ||
| Author: Gert Robyns | ||
| Date: 2024-09-03 | ||
| Updated by: Gert Robyns | ||
| Date: 2024-09-20 | ||
| #> | ||
| function Test-PreprocessorSymbols { | ||
|
Check notice Code scanning / PSScriptAnalyzer The cmdlet 'Test-PreprocessorSymbols' does not have a help comment. Note
The cmdlet 'Test-PreprocessorSymbols' does not have a help comment.
|
||
| param ( | ||
| [Parameter(Mandatory=$true)] | ||
| [string]$filePath, | ||
| [Parameter(Mandatory=$true)] | ||
| [hashtable[]]$symbolConfigs | ||
| ) | ||
|
|
||
| # check if extension is .al, else return $null | ||
| if ('.al' -ne [system.io.path]::GetExtension($filePath)) { | ||
| return $null | ||
| } | ||
|
Check notice Code scanning / PSScriptAnalyzer Line has trailing whitespace Note
Line has trailing whitespace
|
||
|
|
||
| # Define the regex pattern for disallowing a space after # | ||
| $noSpaceAfterHashPattern = "^#\s" | ||
| $lowercasePattern = "^#(if|elseif|else\b|endif)" | ||
| $lowercaseNotPattern = "^#if not " | ||
| $symbolPattern = @() | ||
|
|
||
| foreach ($config in $symbolConfigs) { | ||
| $stem = $config.stem | ||
| $lowerBound = $config.lowerBound | ||
| $upperBound = $config.upperBound | ||
|
|
||
| # Generate the regex pattern for the SymbolStem range | ||
| $rangePattern = "$($lowerBound..$upperBound -join '|')" | ||
|
|
||
| $upperStem = $stem.ToUpper() | ||
| $symbolPattern += "^#if\s${upperStem}($rangePattern)" | ||
| $symbolPattern += "^#if\snot\s${upperStem}($rangePattern)" | ||
| $symbolPattern += "^#elseif\s${upperStem}($rangePattern)" | ||
| } | ||
|
|
||
| # Add #endif to the symbol pattern but not to the strict pattern | ||
| $symbolPattern += "#else\b" | ||
| $symbolPattern += "#endif" | ||
|
|
||
| # Read the content of the file | ||
| $content = Get-Content -Path $filePath | ||
|
|
||
| # Initialize lists to store any invalid preprocessor symbols with line numbers | ||
| $invalidLowercaseSymbols = @() | ||
| $invalidPatternSymbols = @() | ||
| $invalidStemSymbols = @() | ||
|
|
||
| # Iterate through each line in the file content with line numbers | ||
| for ($i = 0; $i -lt $content.Count; $i++) { | ||
| $line = $content[$i] | ||
| $lineNumber = $i + 1 | ||
|
|
||
| # Check for space after # | ||
| if ($line -cmatch $noSpaceAfterHashPattern) { | ||
| $invalidPatternSymbols += "${filePath}:${lineNumber}: $line" | ||
| } | ||
|
|
||
| # Check for lowercase | ||
| if (($line -match $lowercasePattern) -and ($line -cnotmatch $lowercasePattern)) { | ||
| $invalidLowercaseSymbols += "${filePath}:${lineNumber}: $line" | ||
| } | ||
|
|
||
| # Check for lowercase not | ||
| if (($line -match $lowercaseNotPattern) -and ($line -cnotmatch $lowercaseNotPattern)) { | ||
| $invalidLowercaseSymbols += "${filePath}:${lineNumber}: $line" | ||
| } | ||
|
|
||
|
Check notice Code scanning / PSScriptAnalyzer Line has trailing whitespace Note
Line has trailing whitespace
|
||
| # Check for strict pattern match | ||
| $isValidPattern = $false | ||
| foreach ($pattern in $symbolPattern) { | ||
| if ($line -match $pattern) { | ||
| $isValidPattern = $true | ||
| break | ||
| } | ||
| } | ||
| if ($line -match $lowercasePattern -and -not $isValidPattern -and $line -notmatch "^#endif") { | ||
| $invalidPatternSymbols += "${filePath}:${lineNumber}: $line" | ||
| } | ||
|
|
||
| # Check for uppercase stem | ||
| foreach ($config in $symbolConfigs) { | ||
| $stem = $config.stem | ||
| $upperStem = $stem.ToUpper() | ||
| if ($line -match "#(if|if not|elseif)\s+${stem}($rangePattern)" -and $line -cnotmatch "#((?i)(if|if not|elseif))\s+${upperStem}($rangePattern)") { | ||
| $invalidStemSymbols += "${filePath}:${lineNumber}: $line" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (($invalidLowercaseSymbols.Count -gt 0) -or ($invalidPatternSymbols -gt 0) -or ($invalidStemSymbols -gt 0)) { | ||
| return @{ "invalidLowercaseSymbols" = $invalidLowercaseSymbols; "invalidPatternSymbols" = $invalidPatternSymbols; "invalidStemSymbols" = $invalidStemSymbols } | ||
| } else { | ||
| return $null | ||
| } | ||
|
Check notice Code scanning / PSScriptAnalyzer Line has trailing whitespace Note
Line has trailing whitespace
|
||
| } | ||
|
|
||
| Export-ModuleMember -Function Test-PreprocessorSymbols | ||