Merge pull request #50 from santisq/49-feature---get-pstree---alias-for-recursivesize-parameter

Adds parameter aliases for `Get-PSTree` and `Get-PSTreeRegistry` commands.

Author: santisq

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+- __04/19/2025__
+  - Adds parameter aliases for `Get-PSTree` and `Get-PSTreeRegistry`, issue #49.
+
 - __04/07/2025__
   - Modifies the `Get-PSTreeRegistry` cmdlet to include registry default values (unnamed values displayed as `(Default)` in regedit), which were previously excluded due to a filter on empty value names.
 

docs/en-US/Get-PSTree.md

@@ -128,7 +128,7 @@ Specifies the maximum depth of the folder traversal. The default value is 3, lim
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases:
+Aliases: p, dp
 
 Required: False
 Position: Named
@@ -144,7 +144,7 @@ Limits output to directories only, excluding files. When specified, the cmdlet d
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: d, dir
 
 Required: False
 Position: Named
@@ -165,7 +165,7 @@ Specifies an array of one or more string patterns to exclude items from the outp
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: exc
 
 Required: False
 Position: Named
@@ -181,7 +181,7 @@ Allows the cmdlet to access items that would otherwise be inaccessible, such as
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: f
 
 Required: False
 Position: Named
@@ -203,7 +203,7 @@ Specifies an array of one or more string patterns to include only matching items
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: inc
 
 Required: False
 Position: Named
@@ -251,7 +251,7 @@ Enables recursive traversal of all subfolders under the specified path. Use this
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: r, rec
 
 Required: False
 Position: Named
@@ -269,7 +269,7 @@ By default, hidden and system items are excluded from recursive size calculation
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: rs
 
 Required: False
 Position: Named

docs/en-US/Get-PSTreeRegistry.md

@@ -121,7 +121,7 @@ Specifies the maximum depth of the registry traversal. Default value is 3. Use t
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases:
+Aliases: p, dp
 
 Required: False
 Position: Named
@@ -137,7 +137,7 @@ Limits output to `TreeRegistryKey` objects only, excluding `TreeRegistryValue` o
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: k, key
 
 Required: False
 Position: Named
@@ -191,7 +191,7 @@ Enables recursive traversal of all subkeys under the specified registry path. Us
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: r, rec
 
 Required: False
 Position: Named
@@ -213,7 +213,7 @@ Specifies an array of one or more string patterns to exclude registry keys or va
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: exc
 
 Required: False
 Position: Named
@@ -235,7 +235,7 @@ Specifies an array of one or more string patterns to include only matching regis
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: inc
 
 Required: False
 Position: Named

module/PSTree.psd1

@@ -16,7 +16,7 @@
     }
 
     # Version number of this module.
-    ModuleVersion = '2.2.5'
+    ModuleVersion = '2.2.6'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

src/PSTree/Commands/GetPSTreeCommand.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
 using System.Management.Automation;
 using Microsoft.PowerShell.Commands;
 using PSTree.Extensions;
@@ -20,12 +19,15 @@ public sealed class GetPSTreeCommand : TreeCommandBase
     private readonly TreeComparer _comparer = new();
 
     [Parameter]
+    [Alias("f")]
     public SwitchParameter Force { get; set; }
 
     [Parameter]
+    [Alias("dir", "d")]
     public SwitchParameter Directory { get; set; }
 
     [Parameter]
+    [Alias("rs")]
     public SwitchParameter RecursiveSize { get; set; }
 
     protected override void ProcessRecord()

src/PSTree/Commands/GetPSTreeRegistryCommand.cs

@@ -24,6 +24,7 @@ public sealed class GetPSTreeRegistryCommand : TreeCommandBase
 #endif
 
     [Parameter]
+    [Alias("k", "key")]
     public SwitchParameter KeysOnly { get; set; }
 
     protected override void BeginProcessing()

src/PSTree/Extensions/TreeExtensions.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
-using System.Runtime.CompilerServices;
 using System.Text;
 using Microsoft.Win32;
+#if NETCOREAPP
+using System.Runtime.CompilerServices;
+#endif
 
 namespace PSTree.Extensions;
 

src/PSTree/TreeCommandBase.cs

@@ -55,19 +55,23 @@ public virtual string[]? LiteralPath
 
     [Parameter]
     [ValidateRange(0, int.MaxValue)]
+    [Alias("p", "dp")]
     public virtual int Depth { get; set; } = 3;
 
     [Parameter]
+    [Alias("rec", "r")]
     public SwitchParameter Recurse { get; set; }
 
     [Parameter]
     [SupportsWildcards]
     [ValidateNotNullOrEmpty]
+    [Alias("exc")]
     public string[]? Exclude { get; set; }
 
     [Parameter]
     [SupportsWildcards]
     [ValidateNotNullOrEmpty]
+    [Alias("inc")]
     public string[]? Include { get; set; }
 
     protected override void BeginProcessing()