🩹 [Patch]: Fix #Requires statements on all script files (#93)

## Description This pull request involves updating the module requirements in various PowerShell script files to ensure compatibility and proper versioning. ### Module Version Updates: * [`scripts/helpers/Build-PSModule.ps1`](diffhunk://#diff-c688e346ad60fbe881bd05b6a5dbc1cd712fdca0bf8b8527965db583af825fd9L1-R2): Updated to require `GitHub` module version `0.13.2` and `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Build-PSModuleBase.ps1`](diffhunk://#diff-1ab7417b36702be4629b208ad7dd9ec76f94998bb625c4810edda2f9b5dbddb8L1-R1): Updated to require `GitHub` module version `0.13.2`. * [`scripts/helpers/Build/Build-PSModuleDocumentation.ps1`](diffhunk://#diff-dc95bfbd255c5bb79df192179e9cc5141ef230a8d82e80bc12fc6fefe6186fffL1-R3): Updated to require `GitHub` module version `0.13.2`, `platyPS` module version `0.14.2`, and `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Build-PSModuleManifest.ps1`](diffhunk://#diff-50cfb011f5c8aeef8145003927ec3e5edfdf26e5d417bcee6e441517c07454f9L1-R2): Updated to require `GitHub` module version `0.13.2` and `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Build-PSModuleRootModule.ps1`](diffhunk://#diff-1d337ff39f37506a54fda1c5d0487f1b2c2ef318f216a4d9a56c3e7248b69879L1-R2): Updated to require `GitHub` module version `0.13.2` and `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Get-PSModuleAliasesToExport.ps1`](diffhunk://#diff-ae18191466ffa02c1a8429365cf96d8768f5eae03331c4a35199f8cd961e76a7L1-R3): Added requirement for `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Get-PSModuleCmdletsToExport.ps1`](diffhunk://#diff-f542f4a75d778df60fee6e176c795e133be2ed109d8212c05aa545383bd26c46L1-R3): Added requirement for `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Import-PSModule.ps1`](diffhunk://#diff-15f2301e39f56f54fa469db56cc7c487e2df36eb295bb74e8d2325aabcd164c0L1-R3): Added requirement for `Utilities` module version `0.3.0`. * [`scripts/helpers/Build/Resolve-PSModuleDependency.ps1`](diffhunk://#diff-b278dc96f784d462b15a4fe67b088a5b5d9cc502dd6eba3d660da085e576652fL1-R1): Updated to require `Retry` module version `0.1.3`. * [`scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1`](diffhunk://#diff-faeb855accbc346b12f7a0ece1d91f67e26e8929ab8133aedca4051d179c66faR1-R3): Added requirements for `GitHub` module version `0.13.2` and `Utilities` module version `0.3.0`. ### Function Call Correction: * [`scripts/helpers/Build/Import-PSModule.ps1`](diffhunk://#diff-15f2301e39f56f54fa469db56cc7c487e2df36eb295bb74e8d2325aabcd164c0L36-R38): Corrected the function call from `Resolve-PSModuleDependencies` to `Resolve-PSModuleDependency`. ## 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
PSModule · Jan 30, 2025 · 9013bab · 9013bab
1 parent 0969771
commit 9013bab
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 12 deletions.
diff --git a/scripts/helpers/Build-PSModule.ps1 b/scripts/helpers/Build-PSModule.ps1
@@ -1,4 +1,5 @@
-#REQUIRES -Modules Utilities, PSScriptAnalyzer
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
 
 function Build-PSModule {
     <#

diff --git a/scripts/helpers/Build/Build-PSModuleBase.ps1 b/scripts/helpers/Build/Build-PSModuleBase.ps1
@@ -1,4 +1,4 @@
-#Requires -Modules Utilities
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
 
 function Build-PSModuleBase {
     <#

diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1
@@ -1,4 +1,6 @@
-#Requires -Modules platyPS, Utilities
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
+#Requires -Modules @{ ModuleName = 'platyPS'; ModuleVersion = '0.14.2' }
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
 
 function Build-PSModuleDocumentation {
     <#

diff --git a/scripts/helpers/Build/Build-PSModuleManifest.ps1 b/scripts/helpers/Build/Build-PSModuleManifest.ps1
@@ -1,4 +1,5 @@
-#Requires -Modules PSScriptAnalyzer, Utilities
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
 
 function Build-PSModuleManifest {
     <#

diff --git a/scripts/helpers/Build/Build-PSModuleRootModule.ps1 b/scripts/helpers/Build/Build-PSModuleRootModule.ps1
@@ -1,4 +1,5 @@
-#Requires -Modules PSScriptAnalyzer, Utilities
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
 
 function Build-PSModuleRootModule {
     <#

diff --git a/scripts/helpers/Build/Get-PSModuleAliasesToExport.ps1 b/scripts/helpers/Build/Get-PSModuleAliasesToExport.ps1
@@ -1,4 +1,6 @@
-function Get-PSModuleAliasesToExport {
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
+
+function Get-PSModuleAliasesToExport {
     <#
         .SYNOPSIS
         Gets the aliases to export from the module manifest.

diff --git a/scripts/helpers/Build/Get-PSModuleCmdletsToExport.ps1 b/scripts/helpers/Build/Get-PSModuleCmdletsToExport.ps1
@@ -1,4 +1,6 @@
-function Get-PSModuleCmdletsToExport {
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
+
+function Get-PSModuleCmdletsToExport {
     <#
         .SYNOPSIS
         Gets the cmdlets to export from the module manifest.

diff --git a/scripts/helpers/Build/Get-PSModuleVariablesToExport.ps1 b/scripts/helpers/Build/Get-PSModuleVariablesToExport.ps1
@@ -43,4 +43,3 @@
 
     $variablesToExport
 }
-
diff --git a/scripts/helpers/Build/Get-RootLevelVariables.ps1 b/scripts/helpers/Build/Get-RootLevelVariables.ps1
@@ -1,4 +1,4 @@
-function Get-RootLevelVariable {
+function Get-RootLevelVariable {
     <#
         .SYNOPSIS
         Get the root-level variables in a ast.

diff --git a/scripts/helpers/Build/Import-PSModule.ps1 b/scripts/helpers/Build/Import-PSModule.ps1
@@ -1,4 +1,6 @@
-function Import-PSModule {
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
+
+function Import-PSModule {
     <#
         .SYNOPSIS
         Imports a build PS module.
@@ -33,7 +35,7 @@
     $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
-    Resolve-PSModuleDependencies -ManifestFilePath $manifestFile
+    Resolve-PSModuleDependency -ManifestFilePath $manifestFile
     Import-Module -Name $ModuleName -RequiredVersion '999.0.0'
 
     Write-Host 'List loaded modules'

diff --git a/scripts/helpers/Build/Resolve-PSModuleDependency.ps1 b/scripts/helpers/Build/Resolve-PSModuleDependency.ps1
@@ -1,4 +1,4 @@
-#Requires -Modules Retry
+#Requires -Modules @{ ModuleName = 'Retry'; ModuleVersion = '0.1.3' }
 
 function Resolve-PSModuleDependency {
     <#

diff --git a/scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1 b/scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1
@@ -1,3 +1,6 @@
+#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
+#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
+
 function Update-PSModuleManifestAliasesToExport {
     <#
         .SYNOPSIS