v2.50.0

Author: jdhitsolutions

PSScriptToolData.json

@@ -91,6 +91,9 @@ $global:PSSpecialChar = @{
 Write-Verbose "Defining the variable `$PSSamplePath to the samples folder for this module"
 $global:PSSamplePath = Join-Path -Path $PSScriptRoot -ChildPath Samples
 
+#define a private variable with PSScriptTools data
+$ToolDataPath = "$PSScriptRoot\PSScriptToolData.json"
+
 #region editor integrations
 Write-Verbose 'Add ToDo options to the ISE or VS Code'
 if ($psEditor) {

PSScriptTools.psd1

@@ -1563,19 +1563,6 @@ Get-Service | Out-More
 
 This also works in PowerShell 7.
 
-### [Out-ConditionalColor](docs/Out-ConditionalColor.md)
-
-__This command is marked as deprecated and will be removed in a future release.__
-
-This command is designed to take pipeline input and display it in a colorized format, based on a set of conditions. Unlike `Write-Host`, which doesn't write to the pipeline, this command will write output to the pipeline. You can use a simple hashtable to define a color if the given property matches the hashtable key.
-
-![Out-ConditionalColor-1](images/occ-1.png)
-
-Or you can specify an ordered hashtable for more complex processing.
-![Out-ConditionalColor-2](images/occ-2.png)
-
-This command doesn't always work depending on the type of object you pipe to it. The problem appears to be related to the formatting system. Development and testing are ongoing.
-
 ### [Set-ConsoleTitle](docs/Set-ConsoleTitle.md)
 
 Set the title bar of the current PowerShell console window.
@@ -1586,16 +1573,6 @@ if (Test-IsAdministrator) {
   }
 ```
 
-### [Set-ConsoleColor](docs/Set-ConsoleColor.md)
-
-__This command is marked as deprecated and will be removed in a future release.__
-
-Configure the foreground or background color of the current PowerShell console window. Note that if you are running the PSReadLine module, this command won't work. You should use `Set-PSReadLineOption` or a similar command to configure your session settings.
-
-```powershell
-Set-ConsoleColor -background DarkGray -foreground Yellow
-```
-
 ### [Add-Border](docs/Add-Border.md)
 
 This command will create a character or text-based border around a line of text. You might use this to create a formatted text report or to improve the display of information on the screen.
@@ -1910,7 +1887,7 @@ Rabbit   Popcorn       Green
 Rabbit   Pretzels      Green
 ```
 
-The duplicate items have been removed. This command works best with simple objects. If your objects have nested object properties, you will need to test if this command can properly filter for unique items.
+The duplicate items have been removed. This command works best with simple objects. If your objects have nested object properties, you will need to test if this command can properly filter for unique items. For more complex objects, you should use the `Property` parameter.
 
 ### [Test-IsElevated](docs/Test-IsElevated.md)
 
@@ -2473,7 +2450,7 @@ PS C:\> Get-CimMember -ClassName win32_Volume -Property q*
     QuotasRebuilding Boolean   ReadOnly, NullValue
 ```
 
-### Get-CimClassPropertyQualifier](docs/Get-CimClassPropertyQualifier.md)
+### [Get-CimClassPropertyQualifier](docs/Get-CimClassPropertyQualifier.md)
 
 This command is an alternative to Get-CimClass to make it easier to get information about property qualifiers of a WMI/CIM class.
 
@@ -2654,7 +2631,7 @@ $sb = {
       $i++
       $pct = [math]::round($i/$top.count,2)
       Write-ANSIProgress -PercentComplete $pct -position $pos
-      Write-Host "  Processing $(($item.FullName).padright(80))"
+      Write-Host "  Processing $(($item.FullName).PadRight(80))"
       -ForegroundColor Yellow -NoNewline
       $out+= Get-ChildItem -Path $item -Recurse -file |
       Measure-Object -property length -sum |
@@ -2837,7 +2814,7 @@ I've created a PDF version of this document which I thought you might find usefu
 
 ## Deprecated Commands
 
-The following commands have been marked as deprecated and will be removed in a future release.
+The following commands have been removed as of v2.50.0.
 
 + [Set-ConsoleColor](docs/Set-ConsoleColor.md)
 + [Out-ConditionalColor](docs/Out-ConditionalColor.md)

PSScriptTools.psm1

@@ -4,28 +4,46 @@ This file contains the most recent change history for the PSScriptTools module.
 
 ## [Unreleased]
 
+## [2.50.0] - 2024-07-13
+
+### Added
+
+- Added an argument completer for the `Name` parameter of `Show-FunctionItem`.
+- Added a new `Property` parameter to `Get-PSUnique` to allow the user to specify a property or properties to use for comparison. The command will also display a warning if a comparison can't be made. [Issue #150](https://github.com/jdhitsolutions/PSScriptTools/issues/150)
+
+### Changed
+
+- Ongoing and general code cleanup.
+- Removed previously deprecated commands `Set-ConsoleColor` and `Out-ConditionalColor`.
+- Changed `Get-PSScriptTools to use saved data from a JSON file instead of building the data from `Get-Command`, `Get-Alias`, and `Get-Help`. This also fixes display problems with the Synopsis property in Linux.
+- Changed `Write-ANSIProgress` by adding a parameter to write to the host and not the pipeline.
+- Updated `README`.
+
+### Fixed
+
+- Removed obsolete comment-based help for `New-PSDynamicParameter`.
+
 ## [2.49.0] - 2024-06-06
 
 ### Added
 
-- Modified `ConvertTo-Markdown` to use `Property`and `Value` headings when converting to a list.
-- Added CimMember functions `Get-CimNamespace`,`Get-CimClassMethod`, `Get-CimClassProperty`,`Get-CimClassPropertyQualifier`, `Get-CimClassName` and `Get-CimMember`. ([Issue #137](https://github.com/jdhitsolutions/PSScriptTools/issues/137))
+- Modified `ConvertTo-Markdown` to use `Property` and `Value` headings when converting to a list.
+- Added CimMember functions `Get-CimNamespace`, `Get-CimClassMethod`, `Get-CimClassProperty`, `Get-CimClassPropertyQualifier`, `Get-CimClassName` and `Get-CimMember`. ([Issue #137](https://github.com/jdhitsolutions/PSScriptTools/issues/137))
 - Added custom formatting for `Get-CimClassName`.
 - Added the module `ThreadJob` as a module dependency to the manifest.
 
 ### Changed
 
 - Modified module manifest to remove version logic on function export. Now exporting everything. If there is an OS limitation, try to handle it on a per-command basis. **This may be a breaking change**.
 - Changed PDF manual theme from `github` to `github.dark`.
-- Changed PDF manual theme from `github` to `github.dark`.
 - Updated `Get-ParameterInfo` to recognize `ProgressAction` as a common parameter. This parameter was add in PowerShell 7.
 - Updated the default table view for output from `Get-ModuleCommand` to include the module version number.
 - Modified `Show-Tree` to better handle multi-string and binary values in the registry.
 - Modified `Show-Tree` to use `PSStyle.FileInfo` for color information if detected. ([Issue #147](https://github.com/jdhitsolutions/PSScriptTools/issues/147))
 - Updated `README.md`
 - Revised `Get-FolderSizeInfo` to be more consistent between PowerShell versions. The command will skip counting all reparse points. **This may be a breaking change**. ([Issue #145](https://github.com/jdhitsolutions/PSScriptTools/issues/145))
 - Re-wrote `Find-CimClass` to use `CimSession`.
-- Revised `Get-ParameterInfo` to sort output by default using ParameterSet,Position, and Name
+- Revised `Get-ParameterInfo` to sort the output by default using ParameterSet, Position, and Name
 - Help updates.
 
 ### Fixed
@@ -37,7 +55,7 @@ This file contains the most recent change history for the PSScriptTools module.
 
 ### Added
 
-- Added parameter `ProviderName` to `Get-CommandSyntax to let the user specify a provider.`[Issue #139](https://github.com/jdhitsolutions/PSScriptTools/issues/139)
+- Added parameter `ProviderName` to `Get-CommandSyntax to let the user specify a provider.` [Issue #139](https://github.com/jdhitsolutions/PSScriptTools/issues/139)
 
 ### Changed
 
@@ -110,7 +128,8 @@ This file contains the most recent change history for the PSScriptTools module.
 
 If you need to see older change history, look at the [Archive ChangeLog](https://github.com/jdhitsolutions/PSScriptTools/blob/master/Archive-ChangeLog.md) online.
 
-[Unreleased]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.49.0..HEAD
+[Unreleased]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.50.0..HEAD
+[2.50.0]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.49.0..v2.50.0
 [2.49.0]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.48.0..v2.49.0
 [v2.48.0]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.47.0..v2.48.0
 [v2.47.0]: https://github.com/jdhitsolutions/PSScriptTools/compare/v2.46.0..v2.47.0

PSScriptToolsManual.pdf

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Get information about CIM class members
+Get information about CIM class members.
 
 ## SYNTAX
 

README.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Enumerate WMI/CIM namespaces
+Enumerate WMI/CIM namespaces.
 
 ## SYNTAX
 

docs/Out-ConditionalColor.md renamed to archive/Out-conditionalColor.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Display the PSAnsiFileMap
+Display the PSAnsiFileMap.
 
 ## SYNTAX
 

docs/Set-ConsoleColor.md renamed to archive/Set-ConsoleColor.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Get PowerShell profile locations
+Get PowerShell profile locations.
 
 ## SYNTAX
 

changelog.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Get details about the current PowerShell session
+Get details about the current PowerShell session.
 
 ## SYNTAX
 

docs/Get-CimMember.md

@@ -13,15 +13,15 @@ Filter for unique objects.
 
 ## SYNTAX
 
-```yaml
-Get-PSUnique [-InputObject] <Object> [<CommonParameters>]
+```
+Get-PSUnique [-InputObject] <Object> [-Property <String[]>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
 You can use this command to filter for truly unique objects. That is, every property on every object is considered unique. Most things in PowerShell are already guaranteed to be unique, but you might import data from a CSV file with duplicate entries. Get-PSUnique can help filter.
 
-This command works best with simple objects. Objects with nested objects as properties may not be properly detected.
+This command works best with simple objects. Objects with nested objects as properties may not be properly detected. For complex objects, you might need to specify the property or properties to use for comparison.
 
 ## EXAMPLES
 
@@ -51,6 +51,22 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -Property
+
+Specify a property to use for the comparison.
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

docs/Get-CimNamespace.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Create a function item from the console
+Create a function item from the console.
 
 ## SYNTAX
 

docs/Get-PSAnsiFileMap.md

@@ -9,15 +9,14 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Create a PowerShell dynamic parameter.
+Create a PowerShell function dynamic parameter.
 
 ## SYNTAX
 
 ```yaml
-New-PSDynamicParameter [-ParameterName] <String[]> -Condition <String> [-Mandatory] [-DefaultValue <Object[]>] [-Alias <String[]>]
-[-ParameterType <Type>] [-HelpMessage <String>][-ValueFromPipelineByPropertyName]  [-ParameterSetName <String>]
-[-Comment <String>] [-ValidateNotNullOrEmpty] [-ValidateLength <Int32[]>]
-[-ValidateSet <Object[]>] [-ValidateRange <Int32[]>] [-ValidateCount <Int32[]>] [-ValidatePattern <String>] [-ValidateScript <ScriptBlock>] [<CommonParameters>]
+New-PSDynamicParameter [-ParameterName] <String[]> -Condition <String> [-Mandatory]
+[-DefaultValue <Object[]>] [-Alias <String[]>] [-ParameterType <Type>] [-HelpMessage <String>][-ValueFromPipelineByPropertyName] [-ParameterSetName <String>][-Comment <String>] [-ValidateNotNullOrEmpty] [-ValidateLength <Int32[]>] [-ValidateSet <Object[]>]
+[-ValidateRange <Int32[]>] [-ValidateCount <Int32[]>] [-ValidatePattern <String>] [-ValidateScript <ScriptBlock>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION

docs/Get-PSProfile.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Change script editor terminal location.
+Change your script editor terminal location. Only valid in VSCode or the ISE.
 
 ## SYNTAX
 

docs/Get-PSSessionInfo.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Modify or add a PSAnsiFileEntry
+Modify or add a PSAnsiFileEntry.
 
 ## SYNTAX
 

docs/Get-PSUnique.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Display ANSI escape sequences
+Display ANSI escape sequences.
 
 ## SYNTAX