Skip to content

Add Statement property to $MyInvocation #19027

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.

Sign up for GitHub

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

Jump to bottom
Merged
adityapatwardhan merged 4 commits into from
Mar 6, 2023
Merged

Add Statement property to $MyInvocation #19027

adityapatwardhan merged 4 commits into from
Mar 6, 2023

Conversation

@IISResetMe
Copy link
Collaborator

@IISResetMe IISResetMe commented Jan 24, 2023

PR Summary

Fixes #12609

It's currently near-impossible to obtain the exact invocation statement of the current callsite in a script block or script function if the invocation spans multiple lines:

PS ~> function Capture-Extent { return $MyInvocation.Line.Substring($MyInvocation.OffSetInLine - 1) }
PS ~> $ext = Capture-Extent @'
these are not the droids you're looking for
'@
PS ~> $ext
Capture-Extent @'
PS ~>

This PR exposes the full text of the current invocation via a new instance property Statement, allowing command authors to capture multi-line invocations:

PS ~> function Capture-Extent { return $MyInvocation.Statement }
PS ~> $ext = Capture-Extent @'
Now we can see what's going on down here!
'@
PS ~> $ext
Capture-Extent @'
Now we can see what's going on down here!
'@
PS ~>

PR Context

WG-Engine previously discussed this behavior and found no good reason not to expose the full text, but decided against modifying any existing behavior, hence this additional property.

PR Checklist

iSazonov
iSazonov reviewed Jan 25, 2023
View reviewed changes
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jan 25, 2023
iSazonov
iSazonov reviewed Jan 25, 2023
View reviewed changes
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jan 25, 2023

This PR has 14 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       : +14 -0
Percentile : 5.6%

Total files changed: 2

Change summary by file extension:
.cs : +3 -0
.ps1 : +11 -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 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.

@ghost ghost added the Review - Needed The PR is being reviewed label Feb 8, 2023
@ghost
Copy link

ghost commented Feb 8, 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

@iSazonov iSazonov requested a review from daxian-dbw February 8, 2023 05:53
SeeminglyScience
SeeminglyScience approved these changes Feb 13, 2023
View reviewed changes
Copy link
Collaborator

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you @IISResetMe ❤️

@SeeminglyScience SeeminglyScience removed the Review - Needed The PR is being reviewed label Mar 6, 2023
@adityapatwardhan adityapatwardhan merged commit 1925cf6 into PowerShell:master Mar 6, 2023
@iSazonov iSazonov added the Documentation Needed in this repo Documentation is needed in this repo label Mar 7, 2023
@iSazonov
Copy link
Collaborator

iSazonov commented Mar 7, 2023

Do we need new doc issue?

@daxian-dbw
Copy link
Member

daxian-dbw commented Mar 7, 2023

The xml comment block will generate corresponding doc content for the new property in our doc pipeline, so I think we are good.

@iSazonov iSazonov removed the Documentation Needed in this repo Documentation is needed in this repo label Mar 8, 2023
@ghost
Copy link

ghost commented Mar 14, 2023

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

Handy links:

@ghost ghost mentioned this pull request Mar 14, 2023
Closed
@SteveL-MSFT SteveL-MSFT mentioned this pull request Nov 6, 2023
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov left review comments

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw

+1 more reviewer

@ArmaanMcleod ArmaanMcleod ArmaanMcleod left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@adityapatwardhan adityapatwardhan

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.

MyInvocation.Line doesn't work for commands split across multiple lines

6 participants

@IISResetMe @iSazonov @daxian-dbw @adityapatwardhan @ArmaanMcleod @SeeminglyScience