Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MariusStorhaug merged 20 commits into from
Jan 30, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
f54fe6e
Implement functions to extract and add module dependencies from Power…
MariusStorhaug Jan 30, 2025
245c965
🩹 [Patch]: Refactor Get-RequiredModulesFromFile to use consistent par…
MariusStorhaug Jan 30, 2025
6ec4b7f
🩹 [Patch]: Comment out table formatting in Get-RequiredModulesFromFil…
MariusStorhaug Jan 30, 2025
a2ff609
🩹 [Patch]: Fix formatting of #Requires statements in Add-RequiresStat…
MariusStorhaug Jan 30, 2025
4b5e20d
🩹 [Patch]: Fix regex to correctly remove previous #Requires -Modules …
MariusStorhaug Jan 30, 2025
bca0b92
🩹 [Patch]: Update regex to remove previous '#Requires -Modules' lines…
MariusStorhaug Jan 30, 2025
eec27b0
🩹 [Patch]: Ensure only one blank line at the end of the script in Add…
MariusStorhaug Jan 30, 2025
c244f49
🩹 [Patch]: Update Get-RequiredModulesFromFile to use Get-InstalledPSR…
MariusStorhaug Jan 30, 2025
3c51cd2
🩹 [Feature]: Introduce Add-ModuleRequires function to manage module d…
MariusStorhaug Jan 30, 2025
3b0677c
🩹 [Feature]: Enhance Add-ModuleRequires function to validate paths, c…
MariusStorhaug Jan 30, 2025
6e1fd26
Fix requires
MariusStorhaug Jan 30, 2025
b930918
🩹 [Refactor]: Improve comments for clarity and organization in Add-Mo…
MariusStorhaug Jan 30, 2025
0ca55ef
🩹 [Feature]: Enhance Add-ModuleRequires function to collect unresolve…
MariusStorhaug Jan 30, 2025
c86d71c
🩹 [Refactor]: Rename Add-ModuleRequires function to Set-ScriptFileReq…
MariusStorhaug Jan 30, 2025
8951842
🩹 [Refactor]: Update Set-ScriptFileRequirement function documentation…
MariusStorhaug Jan 30, 2025
0beeb1a
🩹 [Refactor]: Update Set-ScriptFileRequirement function documentation…
MariusStorhaug Jan 30, 2025
1f5360b
🩹 [Refactor]: Update module dependency requirements to use hashtable …
MariusStorhaug Jan 30, 2025
59589cf
🩹 [Refactor]: Remove leading whitespace from #Requires statements acr…
MariusStorhaug Jan 30, 2025
8a16d50
🩹 [Enhancement]: Add SupportsShouldProcess to Set-ScriptFileRequireme…
MariusStorhaug Jan 30, 2025
cb418fc
🩹 [Refactor]: Remove Set-ScriptFileRequirement function to streamline…
MariusStorhaug Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion scripts/helpers/Build-PSModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
<#
Expand Down
2 changes: 1 addition & 1 deletion scripts/helpers/Build/Build-PSModuleBase.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Requires -Modules Utilities
#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }

function Build-PSModuleBase {
<#
Expand Down
4 changes: 3 additions & 1 deletion scripts/helpers/Build/Build-PSModuleDocumentation.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
<#
Expand Down
3 changes: 2 additions & 1 deletion scripts/helpers/Build/Build-PSModuleManifest.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
<#
Expand Down
3 changes: 2 additions & 1 deletion scripts/helpers/Build/Build-PSModuleRootModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
<#
Expand Down
4 changes: 3 additions & 1 deletion scripts/helpers/Build/Get-PSModuleAliasesToExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 3 additions & 1 deletion scripts/helpers/Build/Get-PSModuleCmdletsToExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion scripts/helpers/Build/Get-PSModuleVariablesToExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,3 @@

$variablesToExport
}

2 changes: 1 addition & 1 deletion scripts/helpers/Build/Get-RootLevelVariables.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
function Get-RootLevelVariable {
function Get-RootLevelVariable {
<#
.SYNOPSIS
Get the root-level variables in a ast.
Expand Down
6 changes: 4 additions & 2 deletions scripts/helpers/Build/Import-PSModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
function Import-PSModule {
#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }

function Import-PSModule {
<#
.SYNOPSIS
Imports a build PS module.
Expand Down Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion scripts/helpers/Build/Resolve-PSModuleDependency.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Requires -Modules Retry
#Requires -Modules @{ ModuleName = 'Retry'; ModuleVersion = '0.1.3' }

function Resolve-PSModuleDependency {
<#
Expand Down
3 changes: 3 additions & 0 deletions scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
#Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }

function Update-PSModuleManifestAliasesToExport {
<#
.SYNOPSIS
Expand Down