Skip to content

Exclude redundant parameter aliases from completion results#19382

Merged
iSazonov merged 3 commits intoPowerShell:masterfrom
MartinGC94:ExcludeParamAlias
Mar 22, 2023
Merged

Exclude redundant parameter aliases from completion results#19382
iSazonov merged 3 commits intoPowerShell:masterfrom
MartinGC94:ExcludeParamAlias

Conversation

@MartinGC94
Copy link
Contributor

@MartinGC94 MartinGC94 commented Mar 21, 2023 •
edited
Loading

PR Summary

Exclude parameter aliases from completion results when the real parameter is available. For example: Get-ChildItem -P<Tab> will not show the alias pv because PipelineVariable is already included in the results. You can still tab complete parameter aliases if they don't conflict with the real parameter, for example: Get-NetIPAddress -if<Tab> will still show ifIndex and ifAlias.

Also replaced some linq usage with foreach loops.

PR Context

Fixes #19376

PR Checklist

@ghost ghost assigned iSazonov Mar 21, 2023
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Mar 21, 2023
@iSazonov iSazonov requested a review from daxian-dbw March 21, 2023 17:10
daxian-dbw
daxian-dbw approved these changes Mar 21, 2023
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Mar 21, 2023

This PR has 46 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 -17
Percentile : 18.4%

Total files changed: 3

Change summary by file extension:
.cs : +16 -11
.ps1 : +13 -6

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.

@iSazonov iSazonov merged commit 18f0c5a into PowerShell:master Mar 22, 2023
@MartinGC94 MartinGC94 deleted the ExcludeParamAlias branch March 22, 2023 07:13
CarloToso pushed a commit to CarloToso/PowerShell that referenced this pull request Apr 8, 2023
@stevenebutler
Pr/19379 (#1)
1a6707d 
* Remove FormObject.cs and FormObjectCollection.cs (PowerShell#19383)

* Exclude redundant parameter aliases from completion results (PowerShell#19382)

* Revert "Remove FormObject.cs and FormObjectCollection.cs (PowerShell#19383)" (PowerShell#19387)

This reverts commit 190c99a.

* Add the parameter `-RelativeBasePath` to `Resolve-Path` (PowerShell#19358)

* Fix a crash in the type inference code (PowerShell#19400)

* Remove GetResponseObject (PowerShell#19380)

* Add `-Environment` parameter to `Start-Process` (PowerShell#19374)

* Add `-Environment` parameter to `Start-Process`

* address codefactor

* fix test for Windows

* handle case where value is $null to remove env var

* change variables to make it more clear what the test is doing

* Add PoolNames variable group to compliance pipeline (PowerShell#19408)

* Improve package management acceptance tests by not going to the gallery (PowerShell#19412)

* Skip VT100 tests on Windows Server 2012R2 as console does not support it (PowerShell#19413)

* Update the `ICommandPredictor` interface to reduce boilerplate code from predictor implementation (PowerShell#19414)

* Enable type conversion of `AutomationNull` to `$null` for assignment (PowerShell#19415)

* Remove code related to `#requires -pssnapin` (PowerShell#19320)

* Support CTRL-C when reading data and connection hangs for `Invoke-RestMethod` and `Invoke-WebRequest` (PowerShell#19330)

* Update to the latest NOTICES file (PowerShell#19332)

* Update the cgmanifest (PowerShell#19459)

* WIP: Harden default command test. (PowerShell#19416)
@ghost
Copy link

ghost commented Apr 20, 2023

🎉v7.4.0-preview.3 has been released which incorporates this pull request.:tada:

Handy links:

@ghost ghost mentioned this pull request Apr 20, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@iSazonov iSazonov iSazonov approved these changes

Assignees

@iSazonov iSazonov

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tab completion should not include parameter aliases for parameters that are already in the completionresults

3 participants

@MartinGC94 @daxian-dbw @iSazonov