Add comprehensive test suite, fix minor issues, rename function and file names to match approved verbs (#708)

Scripts/CLI/Show-CliAppRemoval.ps1

@@ -1,6 +1,6 @@
 # Shows the CLI app removal menu and prompts the user to select which apps to remove.
-function ShowCLIAppRemoval {
-    PrintHeader "App Removal"
+function Show-CliAppRemoval {
+    Write-CliHeader "App Removal"
 
     Write-Output "> Opening app selection form..."
 
@@ -8,10 +8,10 @@ function ShowCLIAppRemoval {
 
     if ($result -eq $true) {
         Write-Output "You have selected $($script:SelectedApps.Count) apps for removal"
-        AddParameter 'RemoveApps'
-        AddParameter 'Apps' ($script:SelectedApps -join ',')
+        Add-Parameter 'RemoveApps'
+        Add-Parameter 'Apps' ($script:SelectedApps -join ',')
 
-        SaveSettings
+        Save-Settings
 
         # Suppress prompt if Silent parameter was passed
         if (-not $Silent) {
@@ -19,7 +19,7 @@ function ShowCLIAppRemoval {
             Write-Output ""
             Write-Output "Press enter to remove the selected apps or press CTRL+C to quit..."
             Read-Host | Out-Null
-            PrintHeader "App Removal"
+            Write-CliHeader "App Removal"
         }
     }
     else {

Scripts/CLI/Show-CliDefaultModeAppRemovalOptions.ps1

@@ -1,6 +1,6 @@
 # Shows the CLI default mode app removal options. Loops until a valid option is selected.
-function ShowCLIDefaultModeAppRemovalOptions {
-    PrintHeader 'Default Mode'
+function Show-CliDefaultModeAppRemovalOptions {
+    Write-CliHeader 'Default Mode'
 
     Write-Host "Please note: The default selection of apps includes Microsoft Teams, Spotify, Sticky Notes and more. Select option 2 to verify and change what apps are removed by the script" -ForegroundColor DarkGray
     Write-Host ""

Scripts/CLI/Show-CliDefaultModeOptions.ps1

@@ -1,5 +1,5 @@
 # Show CLI default mode options for removing apps, or set selection if RunDefaults or RunDefaultsLite parameter was passed
-function ShowCLIDefaultModeOptions {
+function Show-CliDefaultModeOptions {
     if ($RunDefaults) {
         $RemoveAppsInput = '1'
     }
@@ -7,7 +7,7 @@ function ShowCLIDefaultModeOptions {
         $RemoveAppsInput = '0'                
     }
     else {
-        $RemoveAppsInput = ShowCLIDefaultModeAppRemovalOptions
+        $RemoveAppsInput = Show-CliDefaultModeAppRemovalOptions
 
         if ($RemoveAppsInput -eq '2' -and ($script:SelectedApps.contains('Microsoft.XboxGameOverlay') -or $script:SelectedApps.contains('Microsoft.XboxGamingOverlay')) -and 
           $( Read-Host -Prompt "Disable Game Bar integration and game/screen recording? This also stops ms-gamingoverlay and ms-gamebar popups (y/n)" ) -eq 'y') {
@@ -15,40 +15,40 @@ function ShowCLIDefaultModeOptions {
         }
     }
 
-    PrintHeader 'Default Mode'
+    Write-CliHeader 'Default Mode'
 
     try {
         # Select app removal options based on user input
         switch ($RemoveAppsInput) {
             '1' {
-                AddParameter 'RemoveApps'
-                AddParameter 'Apps' 'Default'
+                Add-Parameter 'RemoveApps'
+                Add-Parameter 'Apps' 'Default'
             }
             '2' {
-                AddParameter 'RemoveApps'
-                AddParameter 'Apps' ($script:SelectedApps -join ',')
+                Add-Parameter 'RemoveApps'
+                Add-Parameter 'Apps' ($script:SelectedApps -join ',')
 
                 if ($DisableGameBarIntegrationInput) {
-                    AddParameter 'DisableDVR'
-                    AddParameter 'DisableGameBarIntegration'
+                    Add-Parameter 'DisableDVR'
+                    Add-Parameter 'DisableGameBarIntegration'
                 }
             }
         }
 
-        LoadSettings -filePath $script:DefaultSettingsFilePath -expectedVersion "1.0"
+        Import-Settings -filePath $script:DefaultSettingsFilePath -expectedVersion "1.0"
     }
     catch {
         Write-Error "Failed to load settings from DefaultSettings.json file: $_"
-        AwaitKeyToExit
+        Wait-ForKeyPress
     }
 
-    SaveSettings
+    Save-Settings
 
     if ($Silent) {
         # Skip change summary and confirmation prompt
         return
     }
 
-    PrintPendingChanges
-    PrintHeader 'Default Mode'
+    Write-PendingChanges
+    Write-CliHeader 'Default Mode'
 }

Scripts/CLI/Show-CliLastUsedSettings.ps1

@@ -1,13 +1,13 @@
 # Shows the CLI last used settings from LastUsedSettings.json file, displays pending changes and prompts the user to apply them.
-function ShowCLILastUsedSettings {
-    PrintHeader 'Custom Mode'
+function Show-CliLastUsedSettings {
+    Write-CliHeader 'Custom Mode'
 
     try {
-        LoadSettings -filePath $script:SavedSettingsFilePath -expectedVersion "1.0"
+        Import-Settings -filePath $script:SavedSettingsFilePath -expectedVersion "1.0"
     }
     catch {
         Write-Error "Failed to load settings from LastUsedSettings.json file: $_"
-        AwaitKeyToExit
+        Wait-ForKeyPress
     }
 
     if ($Silent) {
@@ -15,6 +15,6 @@ function ShowCLILastUsedSettings {
         return
     }
 
-    PrintPendingChanges
-    PrintHeader 'Custom Mode'
+    Write-PendingChanges
+    Write-CliHeader 'Custom Mode'
 }

Scripts/CLI/Show-CliMenuOptions.ps1

@@ -1,9 +1,9 @@
 # Shows the CLI menu options and prompts the user to select one. Loops until a valid option is selected.
-function ShowCLIMenuOptions {
+function Show-CliMenuOptions {
     Do { 
         $ModeSelectionMessage = "Please select an option (1/2)" 
 
-        PrintHeader 'Menu'
+        Write-CliHeader 'Menu'
 
         Write-Host "(1) Default mode: Quickly apply the recommended changes"
         Write-Host "(2) App removal mode: Select & remove apps, without making other changes"

Scripts/CLI/Wait-ForKeyPress.ps1

@@ -1,4 +1,4 @@
-function AwaitKeyToExit {
+function Wait-ForKeyPress {
     # Suppress prompt if Silent parameter was passed
     if (-not $Silent) {
         Write-Output ""
@@ -8,4 +8,4 @@ function AwaitKeyToExit {
 
     Stop-Transcript
     Exit
-}
+}

Scripts/CLI/Write-CliHeader.ps1

@@ -1,5 +1,5 @@
 # Prints the header for the script
-function PrintHeader {
+function Write-CliHeader {
     param (
         $title
     )
@@ -10,11 +10,11 @@ function PrintHeader {
         $fullTitle = "$fullTitle (Sysprep mode)"
     }
     else {
-        $fullTitle = "$fullTitle (User: $(GetUserName))"
+        $fullTitle = "$fullTitle (User: $(Get-UserName))"
     }
 
     Clear-Host
     Write-Host "-------------------------------------------------------------------------------------------"
     Write-Host $fullTitle
     Write-Host "-------------------------------------------------------------------------------------------"
-}
+}

Scripts/CLI/Write-PendingChanges.ps1

@@ -12,7 +12,7 @@
         After printing the summary the function pauses until the user presses
         Enter, giving them an opportunity to review and cancel via Ctrl+C.
 #>
-function PrintPendingChanges {
+function Write-PendingChanges {
     Write-Output "Win11Debloat will make the following changes:"
 
     if ($script:Params['CreateRestorePoint']) {
@@ -32,7 +32,7 @@ function PrintPendingChanges {
                 continue
             }
             'RemoveApps' {
-                $appsList = GenerateAppsList
+                $appsList = Generate-AppsList
 
                 if ($appsList.Count -eq 0) {
                     Write-Host "No valid apps were selected for removal" -ForegroundColor Yellow
@@ -56,4 +56,4 @@ function PrintPendingChanges {
     Write-Output ""
     Write-Output "Press enter to execute the script or press CTRL+C to quit..."
     Read-Host | Out-Null
-}
+}