Skip to content

Commit e821c84

Browse files
committed
switch to aliases
1 parent aec6e5c commit e821c84

File tree

4 files changed

+32
-42
lines changed

4 files changed

+32
-42
lines changed

Build.ps1

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,10 @@ If (!(Get-Module PwshSpectreConsole -ListAvailable)) {
3434

3535
$manifestContent = (Get-Content -Path $manifestPath -Raw) -replace '<ModuleVersion>', $buildVersion
3636

37-
# Add this before you build $funcStrings
38-
$wrapperFunctionNames = @(
39-
'Set-LMNormalizedProperties','Remove-LMNormalizedProperties','New-LMNormalizedProperties','Import-LMRepositoryLogicModules',
40-
'Get-LMWebsiteGroupAlerts','Get-LMWebsiteAlerts','Get-LMUsageMetrics','Get-LMRepositoryLogicModules','Get-LMNormalizedProperties',
41-
'Get-LMNetscanExecutionDevices','Get-LMIntegrationLogs','Get-LMDeviceNetflowPorts','Get-LMDeviceNetflowFlows','Get-LMDeviceNetflowEndpoints',
42-
'Get-LMDeviceGroupDevices','Get-LMDeviceGroupGroups','Get-LMDeviceGroupAlerts','Get-LMDeviceDatasourceInstanceAlertRecipients','Get-LMDeviceAlertSettings',
43-
'Get-LMDatasourceAssociatedDevices','Get-LMCostOptimizationRecommendations','Get-LMCostOptimizationRecommendationCategories',
44-
'Get-LMAuditLogs','Find-LMDashboardWidgets'
45-
)
46-
47-
# Export function names and wrapper functions
4837
If ((Test-Path -Path $publicFuncFolderPath) -and ($publicFunctionNames = Get-ChildItem -Path $publicFuncFolderPath -Filter '*.ps1' | Select-Object -ExpandProperty BaseName)) {
49-
$allFunctionNames = $publicFunctionNames + $wrapperFunctionNames
50-
$funcStrings = "'$($allFunctionNames -join "','")'"
51-
} else {
38+
$funcStrings = "'$($publicFunctionNames -join "','")'"
39+
}
40+
Else {
5241
$funcStrings = $null
5342
}
5443

Logic.Monitor.psd1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@
7878
VariablesToExport = '*'
7979

8080
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
81-
AliasesToExport = @()
81+
AliasesToExport = @('Set-LMNormalizedProperties','Remove-LMNormalizedProperties','New-LMNormalizedProperties','Import-LMRepositoryLogicModules','Get-LMWebsiteGroupAlerts','Get-LMWebsiteAlerts','Get-LMUsageMetrics','Get-LMRepositoryLogicModules','Get-LMNormalizedProperties','Get-LMNetscanExecutionDevices','Get-LMIntegrationLogs','Get-LMDeviceNetflowPorts','Get-LMDeviceNetflowFlows','Get-LMDeviceNetflowEndpoints','Get-LMDeviceGroupDevices','Get-LMDeviceGroupGroups','Get-LMDeviceGroupAlerts','Get-LMDeviceDatasourceInstanceAlertRecipients','Get-LMDeviceAlertSettings','Get-LMDatasourceAssociatedDevices','Get-LMCostOptimizationRecommendations','Get-LMCostOptimizationRecommendationCategories','Get-LMAuditLogs','Find-LMDashboardWidgets')
82+
8283

8384
# DSC resources to export from this module
8485
# DscResourcesToExport = @()

Logic.Monitor.psm1

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@ Foreach ($import in @($Public + $Private)) {
1212
}
1313
}
1414

15-
# Plural function wrappers for backward compatibility +7.4
16-
function Set-LMNormalizedProperties { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Set-LMNormalizedProperty @Args }
17-
function Remove-LMNormalizedProperties { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Remove-LMNormalizedProperty @Args }
18-
function New-LMNormalizedProperties { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) New-LMNormalizedProperty @Args }
19-
function Import-LMRepositoryLogicModules { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Import-LMRepositoryLogicModule @Args }
20-
function Get-LMWebsiteGroupAlerts { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMWebsiteGroupAlert @Args }
21-
function Get-LMWebsiteAlerts { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMWebsiteAlert @Args }
22-
function Get-LMUsageMetrics { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMUsageMetric @Args }
23-
function Get-LMRepositoryLogicModules { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMRepositoryLogicModule @Args }
24-
function Get-LMNormalizedProperties { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMNormalizedProperty @Args }
25-
function Get-LMNetscanExecutionDevices { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMNetscanExecutionDevice @Args }
26-
function Get-LMIntegrationLogs { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMIntegrationLog @Args }
27-
function Get-LMDeviceNetflowPorts { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceNetflowPort @Args }
28-
function Get-LMDeviceNetflowFlows { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceNetflowFlow @Args }
29-
function Get-LMDeviceNetflowEndpoints { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceNetflowEndpoint @Args }
30-
function Get-LMDeviceGroupDevices { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceGroupDevice @Args }
31-
function Get-LMDeviceGroupAlerts { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceGroupAlert @Args }
32-
function Get-LMDeviceDatasourceInstanceAlertRecipients { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceDatasourceInstanceAlertRecipient @Args }
33-
function Get-LMDeviceAlertSettings { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDeviceAlertSetting @Args }
34-
function Get-LMDatasourceAssociatedDevices { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMDatasourceAssociatedDevice @Args }
35-
function Get-LMCostOptimizationRecommendations { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMCostOptimizationRecommendation @Args }
36-
function Get-LMCostOptimizationRecommendationCategories { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMCostOptimizationRecommendationCategory @Args }
37-
function Get-LMAuditLogs { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Get-LMAuditLog @Args }
38-
function Find-LMDashboardWidgets { [CmdletBinding()] param([Parameter(ValueFromRemainingArguments = $true)][Object[]]$Args) Find-LMDashboardWidget @Args }
15+
# Plural aliases for backward compatibility +7.4
16+
Set-Alias -Name Set-LMNormalizedProperties -Value Set-LMNormalizedProperty
17+
Set-Alias -Name Remove-LMNormalizedProperties -Value Remove-LMNormalizedProperty
18+
Set-Alias -Name New-LMNormalizedProperties -Value New-LMNormalizedProperty
19+
Set-Alias -Name Import-LMRepositoryLogicModules -Value Import-LMRepositoryLogicModule
20+
Set-Alias -Name Get-LMWebsiteGroupAlerts -Value Get-LMWebsiteGroupAlert
21+
Set-Alias -Name Get-LMWebsiteAlerts -Value Get-LMWebsiteAlert
22+
Set-Alias -Name Get-LMUsageMetrics -Value Get-LMUsageMetric
23+
Set-Alias -Name Get-LMRepositoryLogicModules -Value Get-LMRepositoryLogicModule
24+
Set-Alias -Name Get-LMNormalizedProperties -Value Get-LMNormalizedProperty
25+
Set-Alias -Name Get-LMNetscanExecutionDevices -Value Get-LMNetscanExecutionDevice
26+
Set-Alias -Name Get-LMIntegrationLogs -Value Get-LMIntegrationLog
27+
Set-Alias -Name Get-LMDeviceNetflowPorts -Value Get-LMDeviceNetflowPort
28+
Set-Alias -Name Get-LMDeviceNetflowFlows -Value Get-LMDeviceNetflowFlow
29+
Set-Alias -Name Get-LMDeviceNetflowEndpoints -Value Get-LMDeviceNetflowEndpoint
30+
Set-Alias -Name Get-LMDeviceGroupDevices -Value Get-LMDeviceGroupDevice
31+
Set-Alias -Name Get-LMDeviceGroupAlerts -Value Get-LMDeviceGroupAlert
32+
Set-Alias -Name Get-LMDeviceDatasourceInstanceAlertRecipients -Value Get-LMDeviceDatasourceInstanceAlertRecipient
33+
Set-Alias -Name Get-LMDeviceAlertSettings -Value Get-LMDeviceAlertSetting
34+
Set-Alias -Name Get-LMDatasourceAssociatedDevices -Value Get-LMDatasourceAssociatedDevice
35+
Set-Alias -Name Get-LMCostOptimizationRecommendations -Value Get-LMCostOptimizationRecommendation
36+
Set-Alias -Name Get-LMCostOptimizationRecommendationCategories -Value Get-LMCostOptimizationRecommendationCategory
37+
Set-Alias -Name Get-LMAuditLogs -Value Get-LMAuditLog
38+
Set-Alias -Name Find-LMDashboardWidgets -Value Find-LMDashboardWidget
3939

4040
# Export both singular and plural names
4141
$AllCmdlets = $Public | ForEach-Object { $_.BaseName }
@@ -49,4 +49,4 @@ $Plural = @(
4949
) | ForEach-Object { [string]$_ }
5050
$Singular = $AllCmdlets | Where-Object { $Plural -notcontains $_ } | ForEach-Object { [string]$_ }
5151

52-
Export-ModuleMember -Function ($Singular + $Plural)
52+
Export-ModuleMember -Function $Singular -Alias $Plural

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ Connect-LMAccount -UseCachedCredential
104104
- `Find-LMDashboardWidgets``Find-LMDashboardWidget`
105105

106106
- **Backward Compatibility:**
107-
Wrapper functions for the previous plural-noun cmdlet names have been included for backward compatibility.
108-
**Note:** These plural-noun wrappers are considered deprecated and will be removed in a future major release. Please update your scripts to use the new singular-noun cmdlet names.
107+
Alias functions for the previous plural-noun cmdlet names have been included for backward compatibility.
108+
**Note:** These plural-noun alias are considered deprecated and will be removed in a future major release. Please update your scripts to use the new singular-noun cmdlet names.
109109

110110
### Bug Fixes:
111111
- This version of Logic.Monitor module addresses some unintended issues introduced in the pervious version of the module. Some cmdlets had been inadvertently updated causing *cmdlet is not recognized as a name of a cmdlet, function script file or executable program* errors.

0 commit comments

Comments
 (0)