Done some nice fixing, will relase a beta

Author: Robin Stolpe

MaintainModule/MaintainModule.psd1

@@ -27,7 +27,7 @@
     RootModule        = '.\MaintainModule.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '0.0.7'
+    ModuleVersion     = '0.0.8'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -125,7 +125,7 @@
             ReleaseNotes             = 'https://github.com/rstolpe/MaintainModule/releases'
 
             # Prerelease string of this module
-            Prerelease               = ''
+            Prerelease               = 'beta'
 
             # Flag to indicate whether the module requires explicit user acceptance for install/update/save
             RequireLicenseAcceptance = $false
@@ -138,7 +138,7 @@
     } # End of PrivateData hashtable
 
     # HelpInfo URI of this module
-    HelpInfoURI       = 'https://github.com/rstolpe/MaintainModule/blob/main/README.md'
+    # HelpInfoURI       = ''
 
     # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
     # DefaultCommandPrefix = ''

MaintainModule/MaintainModule.psm1

@@ -1,5 +1,5 @@
 <#
-    Copyright (C) {{year}}  Robin Stolpe.
+    Copyright (C) 2022 Robin Stolpe.
     <https://stolpe.io>
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -33,6 +33,9 @@ Function Uninstall-RSModule {
         Uninstall-RSModule -Module "VMWare.PowerCLI, ImportExcel"
         # This will uninstall all older versions of VMWare.PowerCLI and ImportExcel from the system.
 
+        .RELATED LINKS
+        https://github.com/rstolpe/MaintainModule/blob/main/README.md
+
         .NOTES
         Author:     Robin Stolpe
         Mail:       [email protected]
@@ -44,7 +47,7 @@ Function Uninstall-RSModule {
 
     [CmdletBinding()]
     Param(
-        [Parameter(Mandatory = $false, HelpMessage = "Specify modules that you want to uninstall all of the older versions from")]
+        [Parameter(Mandatory = $false, HelpMessage = "Enter the module or modules (separated with ,) you want to uninstall")]
         [string]$Module
     )
 
@@ -122,7 +125,7 @@ Function Update-RSModule {
         If you use this switch and the modules that are specified in the Module parameter are not installed on the system they will be installed.
 
         .EXAMPLE
-        Update-RSModule -Module "PowerCLI, ImportExcel"
+        Update-RSModule -Module "PowerCLI, ImportExcel" -Scope CurrentUser
         # This will update the modules PowerCLI, ImportExcel for the current user
 
         .EXAMPLE
@@ -137,6 +140,9 @@ Function Update-RSModule {
         Update-RSModule -Module "PowerCLI, ImportExcel" -UninstallOldVersion -ImportModule
         # This will update the modules PowerCLI and ImportExcel and delete all of the old versions that are installed of PowerCLI and ImportExcel and then import the modules.
 
+        .RELATED LINKS
+        https://github.com/rstolpe/MaintainModule/blob/main/README.md
+
         .NOTES
         Author:     Robin Stolpe
         Mail:       [email protected]
@@ -148,16 +154,16 @@ Function Update-RSModule {
 
     [CmdletBinding()]
     Param(
-        [Parameter(Mandatory = $false, HelpMessage = "Specify modules that you want to update, if this is empty all of the modules that are installed on the system will get updated")]
+        [Parameter(Mandatory = $false, HelpMessage = "Enter module or modules (separated with ,) that you want to update, if you don't enter any all of the modules will be updated")]
         [string]$Module,
-        [ValidateSet("CurrentUser", "AllUsers", $null)] 
-        [Parameter(Mandatory = $true, HelpMessage = "Choose either AllUsers or CurrentUser depending on which layer you want to update/Install/uninstall the module on")]
+        [ValidateSet("CurrentUser", "AllUsers")] 
+        [Parameter(Mandatory = $true, HelpMessage = "Enter CurrentUser or AllUsers depending on what scope you want to change your modules")]
         [string]$Scope = "CurrentUser",
-        [Parameter(Mandatory = $false, HelpMessage = "Imports all of the modules that are specified in the Module parameter in the end of the script")]
+        [Parameter(Mandatory = $false, HelpMessage = "Import modules that has been entered in the module parameter at the end of this function")]
         [switch]$ImportModule = $false,
         [Parameter(Mandatory = $false, HelpMessage = "Uninstalls all old versions of the modules")]
         [switch]$UninstallOldVersion = $false,
-        [Parameter(Mandatory = $false, HelpMessage = "When using this switch all modules that are specified in the Module parameter and are not installed will be installed")]
+        [Parameter(Mandatory = $false, HelpMessage = "Install all of the modules that has been entered in module that are not installed on the system")]
         [switch]$InstallMissing = $false
     )
 
@@ -230,33 +236,7 @@ Function Update-RSModule {
 
                 # If switch -UninstallOldVersion has been used then the old versions will be uninstalled from the module
                 if ($UninstallOldVersion -eq $true) {
-                    # Collecting all of the installed versions of the module, this is needed to run again as we might have been installed a new version above.
-                    Write-Verbose "Collecting all installed version of $($m)..."
-                    $GetAllInstalledVersions = Get-InstalledModule -Name $m -AllVersions | Sort-Object PublishedDate -Descending
-
-                    # If the module has more then one version installed, uninstall all of the old versions.
-                    if ($GetAllInstalledVersions.Count -gt 1) {
-                        $MostRecentVersion = $GetAllInstalledVersions[0].Version
-
-                        # Start to uninstall all of the older versions
-                        Foreach ($Version in $GetAllInstalledVersions.Version) {
-                            if ($Version -ne $MostRecentVersion) {
-                                try {
-                                    Write-Output "Uninstalling previous version $($Version) of module $($m)..."
-                                    Uninstall-Module -Name $m -RequiredVersion $Version -Force -ErrorAction SilentlyContinue
-                                    Write-Output "Version $($Version) of $($m) are now uninstalled!"
-                                }
-                                catch {
-                                    Write-Error "$($PSItem.Exception)"
-                                    continue
-                                }
-                            }
-                        }
-                        Write-Output "All older versions of $($m) are now uninstalled, the only installed version of $($m) is $($MostRecentVersion)"
-                    }
-                    else {
-                        Write-Verbose "$($m) don't have any older versions installed then the most current one, no need to uninstall anything."
-                    }
+                    Uninstall-RSModule -Module $m
                 }
             }
             else {

README.md

@@ -88,14 +88,10 @@ You can uninstall all of the older versions from one or more specific modules.
 ````
 Uninstall-RSModule
 ````
-You can also use the -Scope parameter if you want to change from CurrentUser to AllUsers, for example ```-Scope "AllUser"```  
-If -Scope parameter are empty it will set it as CurrentUser as default.
 
 ### Uninstall all older versions from a specific module
 If you want to uninstall all older version of a specific module
 ````
 Uninstall-RSModule -Module "ImportExcel"
 ````
-The parameter Module has support for multiple inputs, separate them with , for example ```-Module "ImportExcel, VMWare.PowerCLI"```
-You can also use the -Scope parameter if you want to change from CurrentUser to AllUsers, for example ```-Scope "AllUser"```  
-If -Scope parameter are empty it will set it as CurrentUser as default.
+The parameter Module has support for multiple inputs, separate them with , for example ```-Module "ImportExcel, VMWare.PowerCLI"```

RSPublish.ps1

@@ -1,37 +1,60 @@
 param (
-    #[string]$version,
-    #[string]$preReleaseTag,
-    [Parameter(Mandatory = $false, HelpMessage = "Use this switch if you want to publish to PSGallery after the module has been prepared")]
+    # Set this to true before releasing the module
+    [Parameter(Mandatory = $false, HelpMessage = "Enter the version number of this release")]
+    [string]$Version = "0.0.8",
+    # Fix this
+    [Parameter(Mandatory = $false, HelpMessage = ".")]
+    [string]$preRelease,
+    [Parameter(Mandatory = $false, HelpMessage = "Use this switch to publish this module on PSGallery")]
     [bool]$Publish = $false,
-    [Parameter(Mandatory = $false, HelpMessage = "Write your API key for PSGallery")]
+    # Validate so if $Publish is true this is needed
+    [Parameter(Mandatory = $false, HelpMessage = "Enter API key for PSGallery")]
     [string]$apiKey
 )
 
-$Version = "0.0.7"
-#$preReleaseTag = "-beta"
-$Year = (Get-Date).Year
-$ManifestDate = Get-Date -Format "yyyy-MM-dd"
+# When module creates this file add what version this file comes from for the EasyModuleBuild
+# Check if it's any newer version of this module, if it's any newer alert the user about it.
+# Create script to generate GUID and populate it in the manifest when generated, this should only happen in the setup new module script not in this one.
+# Create script will also populate the Company, PreReleaseTag, author and webpageURI for the manifest.
+
+# Need to find a way to handle -beta tags, might add a switch for that
+$preReleaseTag = "beta"
 
 # Creating ArrayList for use later in the script
 [System.Collections.ArrayList]$FunctionPSD = @()
 
-# Name of the module
+$Year = (Get-Date).Year
+$ManifestDate = Get-Date -Format "yyyy-MM-dd"
+
+# Gets the folder name from the folder where this script are located
 $ModuleName = $(Get-Location) -split "/" | Select-Object -last 1
+
+# Paths for different sections inside the module
 $scriptPath = split-path -parent $MyInvocation.MyCommand.Definition
 $ModuleFolderPath = "$($scriptPath)/$($ModuleName)"
 $srcPath = "$($scriptPath)/src"
 $srcPublicFunctionPath = "$($scriptPath)/src/public/function"
 $outPSMFile = "$($ModuleFolderPath)/$($ModuleName).psm1"
 $outPSDFile = "$($ModuleFolderPath)/$($ModuleName).psd1"
 $psdTemplate = "$($srcPath)/$($ModuleName).psd1.source"
-$psmLicensPath = "$($srcPath)/FileLicens.ps1.source"
+$psmLicensPath = "$($srcPath)/License"
+$EMBSourceFiles = "$($env:PSModulePath)/EasyModuleBuild/source_files"
+
+# Needed folders
+$srcNeededFolders = @("$($srcPath)/Private", "$($srcPath)/Private/Function", "$($srcPath)/Public", "$($srcPath)/Public/Function")
+
+# Needed files
+$moduleNeededFiles = @("$($scriptPath)/.gitignore", "$($scriptPath)/LICENSE", "$($scriptPath)/README.md")
 
 Write-OutPut "`n== Preparing $($ModuleName) for publishing ==`n"
 Write-OutPut "Starting to build the module, please wait..."
 
 if (!(Test-Path $ModuleFolderPath)) {
     Write-Verbose "Creating folder $($ModuleFolderPath)"
-    New-Item -Path $ModuleFolderPath -ItemType Directory -Force
+    [void](New-Item -Path $ModuleFolderPath -ItemType Directory -Force)
+    
+    # add check to see if the user has this files in there user profile and wrap this to if/else
+    # if they don't have it copy it from this root module
 }
 else {
     if (Test-Path $outPSMFile) {
@@ -43,10 +66,31 @@ else {
         Write-Verbose "Removing file $($outPSDFile)"
         Remove-Item -Path $outPSDFile -Force
     }
+    # Check so .gitignore, LICENSE, README.md exists in the module folder, if not se line below what to do.
+    # check if .gitignore, LICENSE, README.md exists in user settings folder, if not copy the original ones from this modules root folder.
+}
+
+if (!(Test-Path $srcPath)) {
+    Write-Verbose "Creating folder $($srcPath)"
+    New-Item -Path $srcPath -ItemType Directory -Force
+    foreach ($f in $srcNeededFolders) {
+        Write-Verbose "Creating folder $($f)"
+        [void](New-Item -Path $f -ItemType Directory -Force)
+    }
+    # Check if the user has any settingfiles for this module if not, then Copy .psd1.source and FileLicens.ps1.source to this folder from the this modules root folder
+}
+else {
+    foreach ($f in $srcNeededFolders) {
+        if (!(Test-Path $f)) {
+            Write-Verbose "Creating folder $($f)"
+            [void](New-Item -Path $f -ItemType Directory -Force)
+        }
+    }
+    # check so all the nessacary files are there, if not check if user has user settingsfiles for this module if he don't have it copy the original files from the root module folder
 }
 
-# Adding the text from the filelicens.ps1 to the .psm1 file for licensing of GNU v3
-$psmLicens = Get-Content -Path $psmLicensPath -ErrorAction SilentlyContinue
+# Adding the text from the gnu3_add_file_licens.source to the to of the .psm1 file for licensing of GNU v3
+$psmLicens = Get-Content -Path "$($psmLicensPath)/gnu3_add_file_licens.source" -ErrorAction SilentlyContinue
 $psmLicens | Add-Content -Path $outPSMFile
 
 # Collecting all .ps1 files that are located in src/function folders
@@ -70,36 +114,60 @@ foreach ($function in $MigrateFunction) {
     [void]($FunctionPSD.Add($function))
 }
 
-# I know that I need to fix this one, but it's the best I can think of for now to remove the last , in the ArrayList
-$FunctionPSD = $FunctionPSD | ForEach-Object { 
-    if ( $FunctionPSD.IndexOf($_) -eq ($FunctionPSD.count - 1) ) {
-        $_.replace(",", "")
+# if $MigrateFunction are not empty remove the last , from the $FunctionPSD ArrayList
+if ($null -ne $MigrateFunction) {
+    # I know that I need to fix this one, but it's the best I can think of for now to remove the last , in the ArrayList
+    $FunctionPSD = $FunctionPSD | ForEach-Object { 
+        if ( $FunctionPSD.IndexOf($_) -eq ($FunctionPSD.count - 1) ) {
+            $_.replace(",", "")
+        }
+        else { $_ }  
     }
-    else { $_ }  
 }
 
+# Change the placeholder in the $outPSMFile file
+Write-Verbose "Getting the content from file $($outPSMFile)"
+$PSMfileContent = Get-Content -Path $outPSMFile
+Write-Verbose "Replacing the placeholders in the $($outPSMFile) file"
+$PSMfileContent = $PSMfileContent -replace '{{year}}', $year
+
+Write-Verbose "Setting the placeholders for $($outPSMFile)"
+Set-Content -Path $outPSMFile -Value $PSMfileContent  -Force
+
 # Copy the .psd1.source file from the srcPath to the module folder and removing the .source ending
 Write-Verbose "Copy the file $($psdTemplate) to $($outPSDFile)"
 Copy-Item -Path $psdTemplate -Destination $outPSDFile -Force
 
 # Getting the content from the .psd1 file
 Write-Verbose "Getting the content from file $($outPSDFile)"
-$fileContent = Get-Content -Path $outPSDFile
+$PSDfileContent = Get-Content -Path $outPSDFile
 
+# Can I do a loop here? I just might :) remember to check if the varible is empty or not
 # Changing version, preReleaseTag and function in the .psd1 file
-$fileContent = $fileContent -replace '{{manifestDate}}', $ManifestDate
-$fileContent = $fileContent -replace '{{moduleName}}', $ModuleName
-$fileContent = $fileContent -replace '{{year}}', $Year
-$fileContent = $fileContent -replace '{{version}}', $version
-$fileContent = $fileContent -replace '{{preReleaseTag}}', $preReleaseTag
-$fileContent = $fileContent -replace '{{function}}', $FunctionPSD
+Write-Verbose "Replacing the placeholders in the $($outPSDFile) file"
+$PSDfileContent = $PSDfileContent -replace '{{manifestDate}}', $ManifestDate
+$PSDfileContent = $PSDfileContent -replace '{{moduleName}}', $ModuleName
+$PSDfileContent = $PSDfileContent -replace '{{year}}', $Year
+$PSDfileContent = $PSDfileContent -replace '{{version}}', $version
+$PSDfileContent = $PSDfileContent -replace '{{preReleaseTag}}', $preReleaseTag
+
+# If $FunctionPSD are empty, then adding @() instead according to best practices for performance
+if ($null -ne $FunctionPSD) {
+    $PSDfileContent = $PSDfileContent -replace '{{function}}', $FunctionPSD
+}
+else {
+    $PSDfileContent = $PSDfileContent -replace '{{function}}', '@()'
+}
 
-Write-Verbose "Changing the placeholders in $($outPSDFile)"
-Set-Content -Path $outPSDFile -Value $fileContent -Force
+Write-Verbose "Setting the placeholders for $($outPSDFile)"
+Set-Content -Path $outPSDFile -Value $PSDfileContent -Force
 
 if ($Publish -eq $true) {
+    # Check so that the module has .ps1 and .psd1 files in the module folder before it trys to publish it.
+    Write-Verbose "Publishing $($ModuleName) version $($version) to PowerShell Gallery"
     Publish-Module -Path $ModuleFolderPath -NuGetApiKey $apiKey -Force
+    Write-Output "---/// $($ModuleName) version $($Version) has now been built and published to PowerShell Gallery! ///---"
 }
 else {
-    Write-Output "---/// $($ModuleName) is now prepared for publishing! ///---"
+    Write-Output "---/// $($ModuleName) version $($Version)  is now prepared for publishing! ///---"
 }