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 enumeration of inferred types in pipeline #17799

Merged
merged 7 commits into from
Aug 9, 2022

Conversation

MartinGC94
Copy link
Contributor

@MartinGC94 MartinGC94 commented Jul 28, 2022

PR Summary

Update the type inference for $_ so it uses the same enumeration as the foreach loop.
Update the native member completion for the *-Object commands to enumerate the types of the input object.
Update the member completion for foreach-object to not add the parenthesis when completing methods.
Update the type inference for Where, Sort and Select so the inferred type after these commands are enumerated.

PR Context

PR Checklist

Co-authored-by: Ilya <darpa@yandex.ru>
@iSazonov
Copy link
Collaborator

@MartinGC94 Please look CI fails.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 29, 2022
@MartinGC94
Copy link
Contributor Author

@iSazonov Sorry, one more minor change so this works as expected:

$ThisIsAString = [System.IO.Directory]::EnumerateDirectories("C:\") | Select-Object -First 1
$ThisIsAString.<Tab>

Copy link
Member

@adityapatwardhan adityapatwardhan left a comment

Choose a reason for hiding this comment

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

Signed off as maintainer

@adityapatwardhan
Copy link
Member

@daxian-dbw - I would like your review as a SME.

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 except that the parameter name should use camel case.

Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
@daxian-dbw
Copy link
Member

@MartinGC94 You will need to do additional changes on the uses of that parameter within different methods. My suggested changes above didn't include those.

@MartinGC94 MartinGC94 closed this Aug 9, 2022
@MartinGC94 MartinGC94 reopened this Aug 9, 2022
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Small
Size       : +35 -32
Percentile : 26.8%

Total files changed: 4

Change summary by file extension:
.cs : +25 -31
.ps1 : +10 -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.

@daxian-dbw daxian-dbw merged commit 15dcf63 into PowerShell:master Aug 9, 2022
@MartinGC94 MartinGC94 deleted the EnumerateInferredTypes branch August 9, 2022 17:56
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
22 tasks
@ghost
Copy link

ghost commented Dec 20, 2022

🎉v7.4.0-preview.1 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 Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants