🩹 [Patch]: Add tests to check that functions have a param() block (#60)

MariusStorhaug · web-flow · commit 4b7b9fd9d7d9 · 2024-04-14T20:05:54.000+02:00
## Description - Add tests to check that functions have a param() block ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/scripts/tests/PSModule/SourceCode.Tests.ps1 b/scripts/tests/PSModule/SourceCode.Tests.ps1
@@ -119,6 +119,27 @@ Describe 'PSModule - SourceCode tests' {
                 Should -BeNullOrEmpty -Because 'the script should have [CmdletBinding()] attribute'
         }
 
+        It 'Should have a param() block' {
+            $issues = @('')
+            $functionFiles | ForEach-Object {
+                $found = $false
+                $filePath = $_.FullName
+                $relativePath = $filePath.Replace($Path, '').Trim('\').Trim('/')
+                $scriptAst = [System.Management.Automation.Language.Parser]::ParseFile($filePath, [ref]$null, [ref]$null)
+                $tokens = $scriptAst.FindAll({ $args[0] -is [System.Management.Automation.Language.ParamBlockAst] }, $true)
+                foreach ($token in $tokens) {
+                    if ($token.count -eq 1) {
+                        $found = $true
+                    }
+                }
+                if (-not $found) {
+                    $issues += " - $relativePath"
+                }
+            }
+            $issues -join [Environment]::NewLine |
+                Should -BeNullOrEmpty -Because 'the script should have a param() block'
+        }
+
         # It 'boolean parameters in CmdletBinding() attribute are written without assignments' {}
         #     I.e. [CmdletBinding(ShouldProcess)] instead of [CmdletBinding(ShouldProcess = $true)]
         # It 'has [OutputType()] attribute' {}
