Skip to content

Enable completion of variables across scriptblock scopes#19819

Merged
daxian-dbw merged 5 commits intoPowerShell:masterfrom
MartinGC94:CompleteVarsAcrossScopes
Jun 19, 2023
Merged

Enable completion of variables across scriptblock scopes#19819
daxian-dbw merged 5 commits intoPowerShell:masterfrom
MartinGC94:CompleteVarsAcrossScopes

Conversation

@MartinGC94
Copy link
Copy Markdown
Contributor

@MartinGC94 MartinGC94 commented Jun 16, 2023

PR Summary

Enables completion of variables assigned in other scriptblocks like:
ls | foreach -Begin {$MyVar = "Hello"} -Process {$MyV<Tab>}
Scriptblocks that are executed as commands with ampersand are explicitly excluded because variables assigned in those are not available outside the scope.

PR Context

PR Checklist

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Jun 19, 2023

The change enables completion on some commands that are not appliable to the assumption, such as Invoke-Command, New-Module, and Register-ArgumentCompleter.

Quick search in a default session shows the following cmdlets that have parameter with the type ScriptBlock, some of them do not run the script block in the calling scope. So, it's better to restrict when this completion should be enabled.

PS:1> gcm -ParameterType ([scriptblock])

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Cmdlet          ForEach-Object                                     7.2.11.500 Microsoft.PowerShell.Core
Cmdlet          Invoke-Command                                     7.2.11.500 Microsoft.PowerShell.Core
Cmdlet          Measure-Command                                    7.0.0.0    Microsoft.PowerShell.Utility
Cmdlet          New-Module                                         7.2.11.500 Microsoft.PowerShell.Core
Cmdlet          Register-ArgumentCompleter                         7.2.11.500 Microsoft.PowerShell.Core
Cmdlet          Register-EngineEvent                               7.0.0.0    Microsoft.PowerShell.Utility
Cmdlet          Register-ObjectEvent                               7.0.0.0    Microsoft.PowerShell.Utility
Cmdlet          Set-PSBreakpoint                                   7.0.0.0    Microsoft.PowerShell.Utility
Cmdlet          Set-PSReadLineKeyHandler                           2.3.1      PSReadLine
Cmdlet          Set-PSReadLineOption                               2.3.1      PSReadLine
Cmdlet          Start-Job                                          7.2.11.500 Microsoft.PowerShell.Core
Cmdlet          Trace-Command                                      7.0.0.0    Microsoft.PowerShell.Utility
Cmdlet          Where-Object                                       7.2.11.500 Microsoft.PowerShell.Core

@daxian-dbw daxian-dbw added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jun 19, 2023
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jun 19, 2023
@MartinGC94
Copy link
Copy Markdown
Contributor Author

MartinGC94 commented Jun 19, 2023

@daxian-dbw Good point. I've changed it to only work for dot sourced scriptblocks, and arguments to Foreach/Where-Object. What prompted this change was me writing a pester test and being annoyed that a var in BeforeAll was not completable. Can I add third party commands like "BeforeAll" and "BeforeEach" to the whitelist?

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Jun 19, 2023

Can I add third party commands like "BeforeAll" and "BeforeEach" to the whitelist?

Sure, I think they should be in the whitelist. You are really solving a pain point here 👍

@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented Jun 19, 2023

This PR has 36 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       : +33 -3
Percentile : 14.4%

Total files changed: 2

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

daxian-dbw
daxian-dbw approved these changes Jun 19, 2023
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

@daxian-dbw daxian-dbw merged commit 0cbcf7b into PowerShell:master Jun 19, 2023
@ghost
Copy link
Copy Markdown

ghost commented Jun 29, 2023

🎉v7.4.0-preview.4 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

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

Assignees

No one assigned

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MartinGC94 @daxian-dbw