🩹 [Patch]: Add test where enabling -Verbose in a function is not allowed (#53)

MariusStorhaug · web-flow · commit d08f4fe81e42 · 2024-04-14T11:26:35.000+02:00
## Description - One of the points of having `[Cmdletbinding()]` is to be able to turn on verbosity logging from outside the function. This test now checks for enabling switches `-Verbose` or `-Verbose:$true`. - Fixes #20 ## 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
@@ -46,6 +46,16 @@ Describe 'PSModule - SourceCode tests' {
 
         # It 'All script files have tests' {} # Look for the folder name in tests called the same as section/folder name of functions
 
+        It "Should not contain '-Verbose' unless it is disabled using ':`$false' qualifier after it" {
+            $issues = @('')
+            $scriptFiles | ForEach-Object {
+                Select-String -Path $_.FullName -Pattern '\s(-Verbose(?::\$true)?)\b(?!:\$false)' -AllMatches | ForEach-Object {
+                    $issues += " - $($_.Path):L$($_.LineNumber)"
+                }
+            }
+            $issues -join [Environment]::NewLine |
+                Should -BeNullOrEmpty -Because "the script should not contain '-Verbose' unless it is disabled using ':`$false' qualifier after it."
+        }
     }
 
     Context 'Function/filter design' {
diff --git a/tests/src/finally.ps1 b/tests/src/finally.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '------------------------------' -Verbose
-Write-Verbose '---  THIS IS A LAST LOADER ---' -Verbose
-Write-Verbose '------------------------------' -Verbose
+﻿Write-Verbose '------------------------------'
+Write-Verbose '---  THIS IS A LAST LOADER ---'
+Write-Verbose '------------------------------'
diff --git a/tests/src/init/initializer.ps1 b/tests/src/init/initializer.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '-------------------------------' -Verbose
-Write-Verbose '---  THIS IS AN INITIALIZER ---' -Verbose
-Write-Verbose '-------------------------------' -Verbose
+﻿Write-Verbose '-------------------------------'
+Write-Verbose '---  THIS IS AN INITIALIZER ---'
+Write-Verbose '-------------------------------'
diff --git a/tests/src/scripts/loader.ps1 b/tests/src/scripts/loader.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '-------------------------' -Verbose
-Write-Verbose '---  THIS IS A LOADER ---' -Verbose
-Write-Verbose '-------------------------' -Verbose
+﻿Write-Verbose '-------------------------'
+Write-Verbose '---  THIS IS A LOADER ---'
+Write-Verbose '-------------------------'
diff --git a/tests/srcWithManifest/finally.ps1 b/tests/srcWithManifest/finally.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '------------------------------' -Verbose
-Write-Verbose '---  THIS IS A LAST LOADER ---' -Verbose
-Write-Verbose '------------------------------' -Verbose
+﻿Write-Verbose '------------------------------'
+Write-Verbose '---  THIS IS A LAST LOADER ---'
+Write-Verbose '------------------------------'
diff --git a/tests/srcWithManifest/init/initializer.ps1 b/tests/srcWithManifest/init/initializer.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '-------------------------------' -Verbose
-Write-Verbose '---  THIS IS AN INITIALIZER ---' -Verbose
-Write-Verbose '-------------------------------' -Verbose
+﻿Write-Verbose '-------------------------------'
+Write-Verbose '---  THIS IS AN INITIALIZER ---'
+Write-Verbose '-------------------------------'
diff --git a/tests/srcWithManifest/scripts/loader.ps1 b/tests/srcWithManifest/scripts/loader.ps1
@@ -1,3 +1,3 @@
-﻿Write-Verbose '-------------------------' -Verbose
-Write-Verbose '---  THIS IS A LOADER ---' -Verbose
-Write-Verbose '-------------------------' -Verbose
+﻿Write-Verbose '-------------------------'
+Write-Verbose '---  THIS IS A LOADER ---'
+Write-Verbose '-------------------------'
