Skip to content
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.

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

Added -CaseInsensitive switch parameter to Select-Object & Get-Unique cmdlets #19683

Conversation

ArmaanMcleod
Copy link
Contributor

@ArmaanMcleod ArmaanMcleod commented May 20, 2023

PR Summary

Fixes #12059

Added -CaseInsensitive switch parameter to Select-Object & Get-Unique cmdlets.

PR Context

The Select-Object and Get-Unique cmdlets currently do case-sensitive string comparison when filtering unique items, and don't allow the user to override this behaviour and use case-insensitive comparison.

To make sure no breaking change is introduced, the most ideal solution is to introduce a -CaseInsensitive parameter.

Examples

Select-Object -Unique

> "derp", "Derp" | Select-Object -Unique
derp
Derp

> "derp", "Derp" | Select-Object -Unique -CaseInsensitive
derp

Get-Unique

> "aa", "Aa", "bb", "Bb" | Get-Unique
aa
Aa
bb
Bb

> "aa", "Aa", "bb", "Bb" | Get-Unique -AsString -CaseInsensitive
aa
bb

> "aa", "Aa", "bb", "Bb" | Get-Unique -CaseInsensitive
aa
bb

PR Checklist

@ArmaanMcleod ArmaanMcleod marked this pull request as ready for review May 20, 2023 08:44
@pull-request-quantifier-deprecated

This PR has 34 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +29 -5
Percentile : 13.6%

Total files changed: 4

Change summary by file extension:
.cs : +11 -4
.ps1 : +18 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@StevenBucher98 StevenBucher98 added PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed WG-Cmdlets-Utility cmdlets in the Microsoft.PowerShell.Utility module labels May 22, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label Jun 2, 2023
@ghost
Copy link

ghost commented Jun 2, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@doctordns doctordns added the WG-Cmdlets general cmdlet issues label Jun 9, 2023
@SteveL-MSFT
Copy link
Member

@PowerShell/wg-powershell-cmdlets reviewed this, we agree that adding a -CaseInsensitive switch makes sense particularly the internals also support it and just hard coded to be case sensitive.

@ghost ghost removed the Review - Needed The PR is being reviewed label Jun 21, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label Jun 29, 2023
@ghost
Copy link

ghost commented Jun 29, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@SteveL-MSFT SteveL-MSFT added WG-Reviewed A Working Group has reviewed this and made a recommendation CommunityDay-Small A small PR that the PS team has identified to prioritize to review labels Jul 5, 2023
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TravisEz13 TravisEz13 merged commit 836c0c5 into PowerShell:master Jul 24, 2023
37 checks passed
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Jul 24, 2023
@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 24, 2023
@ArmaanMcleod ArmaanMcleod deleted the case-insensitive-select-object-and-get-unique-cmdlets branch July 24, 2023 20:00
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
…nique` cmdlets (PowerShell#19683)

* Added Select-Object CaseInsensitive parameter and tests

* Added Get-Unique CaseInsensitive parameter and tests

* Fix codefactor issue

* Add named arguements

* Remove comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log CommunityDay-Small A small PR that the PS team has identified to prioritize to review Extra Small PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed WG-Cmdlets general cmdlet issues WG-Cmdlets-Utility cmdlets in the Microsoft.PowerShell.Utility module WG-Reviewed A Working Group has reviewed this and made a recommendation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Select-Object -unique is inconsistently case sensitive
7 participants