Refactor module import and removal logic in PowerShell scripts to improve clarity and maintainability

Author: MariusStorhaug

scripts/helpers/Build-PSModuleDocumentation.ps1

@@ -53,10 +53,15 @@
 
     LogGroup 'Build docs - Generate markdown help' {
         Add-PSModulePath -Path (Split-Path -Path $ModuleOutputFolder -Parent)
-        $ModuleName | Remove-Module -Force -ErrorAction SilentlyContinue
         Import-PSModule -Path $ModuleOutputFolder -ModuleName $ModuleName
         Write-Host ($ModuleName | Get-Module)
         $null = New-MarkdownHelp -Module $ModuleName -OutputFolder $DocsOutputFolder -Force -Verbose
+        Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object {
+            $fileName = $_.Name
+            LogGroup " - [$fileName]" {
+                Show-FileContent -Path $_
+            }
+        }
     }
 
     LogGroup 'Build docs - Fix markdown code blocks' {

scripts/helpers/Import-PSModule.ps1

@@ -33,19 +33,15 @@
     $manifestFile = Get-ModuleManifest -Path $manifestFilePath -As FileInfo -Verbose
 
     Write-Host "Manifest file path: [$($manifestFile.FullName)]" -Verbose
-    $existingModule = Get-Module -Name $ModuleName -ListAvailable
-    $existingModule | Remove-Module -Force -Verbose
-    $existingModule.RequiredModules | ForEach-Object { $_ | Remove-Module -Force -Verbose -ErrorAction SilentlyContinue }
-    $existingModule.NestedModules | ForEach-Object { $_ | Remove-Module -Force -Verbose -ErrorAction SilentlyContinue }
-    # Get-InstalledPSResource | Where-Object Name -EQ $ModuleName | Uninstall-PSResource -SkipDependencyCheck -Verbose:$false
+    Remove-PSModule -Name $ModuleName
     Resolve-PSModuleDependency -ManifestFilePath $manifestFile
     Import-Module -Name $ModuleName -RequiredVersion '999.0.0'
 
     Write-Host 'List loaded modules'
     $availableModules = Get-Module -ListAvailable -Refresh -Verbose:$false
     $availableModules | Select-Object Name, Version, Path | Sort-Object Name | Format-Table -AutoSize
     Write-Host 'List commands'
-    Write-Host (Get-Command -Module $moduleName | Format-Table -AutoSize | Out-String)
+    Write-Host (Get-Command -Module $moduleName -ListImported | Format-Table -AutoSize | Out-String)
 
     if ($ModuleName -notin $availableModules.Name) {
         throw 'Module not found'

scripts/helpers/Remove-PSModule.ps1

@@ -0,0 +1,28 @@
+filter Remove-PSModule {
+    <#
+        .SYNOPSIS
+        Removes and uninstalls a PowerShell module.
+
+
+        .EXAMPLE
+        Remove-PSModule -ModuleName 'Utilities'
+
+        Removes a module 'Utilities' from the session then from the system.
+    #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Want to just write to the console, not the pipeline.'
+    )]
+    [CmdletBinding(SupportsShouldProcess)]
+    param(
+        # Name of the module.
+        [Parameter(Mandatory, ValueFromPipeline)]
+        [string] $Name
+    )
+
+    if ($PSCmdlet.ShouldProcess('Target', "Remove module [$Name]")) {
+        Write-Host "Removing module [$Name]"
+        Get-Module -Name $Name -ListAvailable | Remove-Module -Force
+        Get-InstalledPSResource -Name $Name | Uninstall-PSResource -SkipDependencyCheck
+    }
+}

scripts/helpers/Resolve-PSModuleDependency.ps1

@@ -49,9 +49,11 @@
         $installParams.Force = $true
         $installParams.Verbose = $false
 
-        Write-Host "[$($installParams.Name)] - Installing module"
         $VerbosePreferenceOriginal = $VerbosePreference
         $VerbosePreference = 'SilentlyContinue'
+        Write-Host "[$($installParams.Name)] - Uninstalling module"
+        Remove-PSModule -Name $installParams.Name
+        Write-Host "[$($installParams.Name)] - Installing module"
         Retry -Count 5 -Delay 10 {
             Install-Module @installParams -AllowPrerelease:$false
         }