Skip to content

🚀 [Feature]: Get info about loaded aliases after build #53

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
merged 4 commits into from
Apr 15, 2024
Merged

🚀 [Feature]: Get info about loaded aliases after build #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1052cb
Get info about loaded aliases after build
MariusStorhaug Apr 15, 2024
c5dfd69
Test getting all aliases
MariusStorhaug Apr 15, 2024
e385887
Store and show aliases in module manifest
MariusStorhaug Apr 15, 2024
3e2119c
Cleanup
MariusStorhaug Apr 15, 2024
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
6 changes: 6 additions & 0 deletions scripts/helpers/Build-PSModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,11 @@ function Build-PSModule {
Build-PSModuleBase -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -ModuleOutputFolder $moduleOutputFolder
Build-PSModuleManifest -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
Build-PSModuleRootModule -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
Build-PSModuleDocumentation -ModuleName $ModuleName -DocsOutputFolder $docsOutputFolder

$outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"
Start-LogGroup 'Build manifest file - Final Result'
Show-FileContent -Path $outputManifestPath
Stop-LogGroup
}
24 changes: 24 additions & 0 deletions scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
function Update-PSModuleManifestAliasesToExport {
<#
.SYNOPSIS
Updates the aliases to export in the module manifest.
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
Justification = 'Updates a file that is being built.'
)]
[CmdletBinding()]
param(
# Name of the module.
[Parameter(Mandatory)]
[string] $ModuleName,

# Folder where the module is outputted.
[Parameter(Mandatory)]
[System.IO.DirectoryInfo] $ModuleOutputFolder
)

$aliases = Get-Command -Module $ModuleName -CommandType Alias
$outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"
Set-ModuleManifest -Path $outputManifestPath -AliasesToExport $aliases.Name -Verbose:$false
}
8 changes: 8 additions & 0 deletions tests/src/public/New-PSModuleTest.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ function New-PSModuleTest {
'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
Justification = 'Reason for suppressing'
)]
[Alias('New-PSModuleTestAlias1')]
[Alias('New-PSModuleTestAlias2')]
[CmdletBinding()]
param (
# Name of the person to greet.
Expand All @@ -27,3 +29,9 @@ function New-PSModuleTest {
)
Write-Output "Hello, $Name!"
}

New-Alias New-PSModuleTestAlias3 New-PSModuleTest
New-Alias -Name New-PSModuleTestAlias4 -Value New-PSModuleTest


Set-Alias New-PSModuleTestAlias5 New-PSModuleTest