Skip to content

Avoid binding positional parameters when completing parameter in front of value#17693

Merged
daxian-dbw merged 4 commits intoPowerShell:masterfrom
MartinGC94:ImproveParameterNameCompletion
Jul 18, 2022
Merged

Avoid binding positional parameters when completing parameter in front of value#17693
daxian-dbw merged 4 commits intoPowerShell:masterfrom
MartinGC94:ImproveParameterNameCompletion

Conversation

@MartinGC94
Copy link
Copy Markdown
Contributor

PR Summary

Fixes #7733
This prevents the pseudobinding from binding positional parameters if the cursor is in front of a positional value like: Get-ChildItem -<Tab> $HOME
It only does this if the tokenAtCursor is a dash because the completion already handles it for partially written parameters like Get-ChildItem -P<Tab> $Home.
This makes it easier for users to fix a script with a positional parameter that the user wants replaced with a named parameter.

PR Context

PR Checklist

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Outdated
MartinGC94 and others added 2 commits July 16, 2022 18:11
Copy link
Copy Markdown
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.

Looks good overall. Left 2 comments.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 18, 2022
Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 18, 2022
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 26 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       : +19 -7
Percentile : 10.4%

Total files changed: 3

Change summary by file extension:
.cs : +14 -7
.ps1 : +5 -0

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 detetcted.
  • 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.

@daxian-dbw daxian-dbw merged commit b06bcee into PowerShell:master Jul 18, 2022
@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 18, 2022
@ghost
Copy link
Copy Markdown

ghost commented Aug 11, 2022

🎉v7.3.0-preview.7 has been released which incorporates this pull request.:tada:

Handy links:

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 Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Autocomplete parameter name request - please show the name for the positionally bound thing immediately right of the cursor

4 participants