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

Improve hashtable completion #16498

Merged
merged 14 commits into from
Mar 4, 2022

Conversation

MartinGC94
Copy link
Contributor

@MartinGC94 MartinGC94 commented Nov 21, 2021

PR Summary

Fixes a few things about hashtable completion:

  1. Use partial input to filter the suggested keys
  2. Filters out keys that have already been specified in the hashtable
  3. Allows hashtable key completion to happen on blank lines, even if a key/value pair was specified on an earlier line

Example of a scenario that currently fails, but will get fixed by this PR:

ls | sort @{
Expression={}
<Cursor here>
}

Also adds completers for the Arguments parameter for Invoke-CimMethod the FilterHashtable parameter for Get-WinEvent the Property Parameter for the cim cmdlets and the standard cim completers for Set-CimInstance.
This also removes duplicates from member completion in scenarios like ls | select Attributes,<Cursor here> this could be split off into its own PR but since it depends on changes made in this PR I thought I may as well include it here.
Finally it adds some basic completion support for hashtables used for splatting. The pseudo binding doesn't take the hashtable parameters into account so it's not perfect but IMO some completion is better than none.

Fixes #9239

PR Checklist

…ady in a hashtable and add argument completers for Get-WinEvent and Invoke-CimMethod
@iSazonov
Copy link
Collaborator

iSazonov commented Nov 24, 2021

I like this
image
image

@ghost ghost added the Review - Needed The PR is being reviewed label Dec 1, 2021
@ghost
Copy link

ghost commented Dec 1, 2021

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

Copy link
Collaborator

@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

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

LGTM with one minor comment.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 6, 2021
@adityapatwardhan
Copy link
Member

@daxian-dbw can you have a look?

@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 3, 2022
Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
@ghost ghost added the Review - Needed The PR is being reviewed label Jan 11, 2022
@ghost
Copy link

ghost commented Jan 11, 2022

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

@MartinGC94
Copy link
Contributor Author

I understand if you are busy, to help prioritize I will say that out of all my open PRs, this is the one I'm most interested in seeing in the near future. It's just so convenient being able to tab complete parameters in splatting hashtables.

@daxian-dbw
Copy link
Member

@MartinGC94 Sorry for the long delay on this. I will get to this PR this week.

@ghost ghost removed the Review - Needed The PR is being reviewed label Feb 16, 2022
@ghost ghost added the Review - Needed The PR is being reviewed label Feb 23, 2022
@ghost
Copy link

ghost commented Feb 23, 2022

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

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.

Sorry for the delay on review.
The changes overall look good. Thanks for the improvements!

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

@ghost ghost removed the Review - Needed The PR is being reviewed label Mar 1, 2022
@daxian-dbw daxian-dbw closed this Mar 3, 2022
@daxian-dbw daxian-dbw reopened this Mar 3, 2022
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Large
Size       : +234 -51
Percentile : 68.5%

Total files changed: 4

Change summary by file extension:
.cs : +178 -48
.ps1 : +56 -3

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
Copy link
Member

The Invoke-RestMethod test failures are known issue, not related to changes in this PR.

@daxian-dbw daxian-dbw merged commit c196e2f into PowerShell:master Mar 4, 2022
@ghost
Copy link

ghost commented Mar 21, 2022

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

Handy links:

@santisq
Copy link

santisq commented Nov 22, 2022

Sorry if this is not the right place to comment but I've just noticed this a few days ago and I must say it's amazing. Thank you for the hard work! 💪

@SeeminglyScience
Copy link
Collaborator

SeeminglyScience commented Nov 23, 2022

@MartinGC94 don't know if you have a presence in twitter or reddit, but in case you don't lurk here's some more folks very excited to hear about this finally coming 😁

https://twitter.com/SeeminglyScienc/status/1595149054610399232

https://old.reddit.com/r/PowerShell/comments/z2qxed/powershell_ide_that_supports_tab/ixi3yu8/?context=10000

Twitter
reddit
It's worth noting that this PR is one of *many* of Martin's absolutely incredible PRs. A good chunk of which made it into v7.3.0 GA including...

@MartinGC94
Copy link
Contributor Author

Thanks for the kind words :)
It's always nice to hear people appreciate one's work. ❤

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 Large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Request: Improve user experience of Get-WinEvent -FilterHashtable
6 participants