Skip to content

Use AST extent for PSScriptRoot path completion#17376

Merged
daxian-dbw merged 3 commits intoPowerShell:masterfrom
SeeminglyScience:add-psscriptroot-path-completion
Jun 6, 2022
Merged

Use AST extent for PSScriptRoot path completion#17376
daxian-dbw merged 3 commits intoPowerShell:masterfrom
SeeminglyScience:add-psscriptroot-path-completion

Conversation

@SeeminglyScience
Copy link
Copy Markdown
Contributor

@SeeminglyScience SeeminglyScience commented May 18, 2022

When completing a path, if the source is an expandable string containing the variable $PSScriptRoot then attempt to use the file identity from the AST's extent.

The primary reason for this change is to easily allow path completion with $PSScriptRoot reflecting the current file inside an editor.

PR Summary

PR Context

PR Checklist

@SeeminglyScience
Use AST extent for PSScriptRoot path completion
7124788 
When completing a path, if the source is an expandable string containing
the variable `$PSScriptRoot` then attempt to use the file identity from
the AST's extent.
@SeeminglyScience SeeminglyScience mentioned this pull request May 20, 2022
Merged
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented May 23, 2022

This PR has 44 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       : +32 -12
Percentile : 17.6%

Total files changed: 2

Change summary by file extension:
.cs : +16 -12
.ps1 : +16 -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.

@ghost ghost added the Review - Needed The PR is being reviewed label May 31, 2022
@ghost
Copy link
Copy Markdown

ghost commented May 31, 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

daxian-dbw
daxian-dbw approved these changes Jun 6, 2022
View reviewed changes
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.

LGTM

@ghost ghost removed the Review - Needed The PR is being reviewed label Jun 6, 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 Jun 6, 2022
@daxian-dbw daxian-dbw merged commit 97e8e0c into PowerShell:master Jun 6, 2022
@SeeminglyScience SeeminglyScience deleted the add-psscriptroot-path-completion branch June 7, 2022 16:46
@ghost
Copy link
Copy Markdown

ghost commented Jun 22, 2022

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

Handy links:

@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
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

@daxian-dbw daxian-dbw

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.

4 participants

@SeeminglyScience @daxian-dbw @iSazonov @adityapatwardhan