Refactor Tooltip/ListItemText mapping to use CompletionDisplayInfoMapper delegate
#25395
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ArmaanMcleod
commented
Apr 21, 2025
src/Microsoft.PowerShell.Commands.Management/commands/management/NewPropertyCommand.cs
Outdated
Show resolved
Hide resolved
…nt/NewPropertyCommand.cs
ArmaanMcleod
commented
Apr 21, 2025
src/Microsoft.PowerShell.Commands.Utility/commands/utility/Join-String.cs
Outdated
Show resolved
Hide resolved
9074808 to
96170ce
Compare
ArmaanMcleod
commented
Apr 21, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the mapping of tooltip and list item text for completion results by replacing separate mapping delegates with a single delegate returning a CompletionDisplayInfo instance.
- Replaced toolTipMapping and listItemTextMapping with a unified CompletionDisplayInfoMapper delegate.
- Introduced the CompletionDisplayInfo class and its default mapper in CompletionHelpers.cs.
- Updated separator and registry property type mappings in Join-String.cs and NewPropertyCommand.cs to use the new delegate.
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CompletionHelpers.cs | Replaced two mapping delegates with CompletionDisplayInfoMapper and added helper types. |
| Join-String.cs | Updated separator mapping to use the new delegate-based approach. |
| NewPropertyCommand.cs | Updated registry property type mappings to use CompletionDisplayInfoMapper. |
Files not reviewed (1)
- test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1: Language not supported
Comments suppressed due to low confidence (2)
src/Microsoft.PowerShell.Commands.Management/commands/management/NewPropertyCommand.cs:233
- Consider adding tests that cover each registry property type mapping provided by RegistryPropertyTypeDisplayInfoMapper to ensure all mapping cases are correctly handled.
displayInfoMapper: RegistryPropertyTypeDisplayInfoMapper,
src/Microsoft.PowerShell.Commands.Utility/commands/utility/Join-String.cs:175
- [nitpick] Ensure that the SeparatorDisplayInfoMapper switch expression and the s_separatorValues list remain consistent; adding a brief comment may help future maintainers keep both updated simultaneously when new separators are introduced.
private static readonly CompletionHelpers.CompletionDisplayInfoMapper SeparatorDisplayInfoMapper = separator => separator switch
iSazonov
reviewed
Apr 21, 2025
src/System.Management.Automation/engine/CommandCompletion/CompletionHelpers.cs
Outdated
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
iSazonov
reviewed
Apr 21, 2025
src/System.Management.Automation/engine/CommandCompletion/CompletionHelpers.cs
Outdated
Show resolved
Hide resolved
…letionHelpers.cs Co-authored-by: Ilya <darpa@yandex.ru>
|
Thanks @iSazonov. I have resolved style comment and also fixed some Codefactor issues. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
iSazonov
approved these changes
Apr 21, 2025
|
📣 Hey @@ArmaanMcleod, how did we do? We would love to hear your feedback with the link below! 🗣️ 🔗 https://aka.ms/PSRepoFeedback |
Sysoiev-Yurii
pushed a commit
to Sysoiev-Yurii/PowerShell
that referenced
this pull request
May 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Replaced
Func<string, string> toolTipMappingandFunc<string, string> listItemTextMappingwithCompletionDisplayInfoMapperdelegate.This is to allow any delegate to be passed into
GetMatchingResultsand reduces mapping parameters. TheToolTipandListItemTextis wrapped in a tuple.I realised as well there is a lack of tests for
ToolTipandListItemTextso added those as well.PR Context
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright header