GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Improve path completion by MartinGC94 · Pull Request #19489 · PowerShell/PowerShell

Conversation

@MartinGC94

@MartinGC94 MartinGC94 commented Apr 11, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

PR Summary

Refactor of the file path completion code to make it faster and prepare it for some future improvements I have planned (Not replacing variables in input text, user options for controlling sorting behavior and more).

Speed improvements for relative paths are pretty big:

cd C:\windows\System32\
Measure-Command -Expression {TabExpansion2 -inputScript .\}

old: 1.99 seconds
new: 199 ms

Similar improvements are seen in other providers:

cd HKCU:\SOFTWARE\Classes\
Measure-Command -Expression {TabExpansion2 -inputScript .\}

Old: 1.60 seconds
new: 139 ms

Also stopped it from replacing ~ when referring to home so this: ~\Downloads<Tab> no longer turns into: C:\Users\Martin\Downloads\

PR Context

Fixes #4797
Contributes to: #5350

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • Breaking changes
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed:
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
  • Tooling
    • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    • OR
    • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
      • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
        (which runs in a different PS Host).
        • Issue filed:
      • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        • Issue filed:
      • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
        • Issue filed:
      • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
        • Issue filed:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

testfailed and masterflitzer reacted with thumbs up emoji
All reactions
  • 👍 2 reactions
@MartinGC94
Improve path completion
b680be2
@ghost ghost assigned Paul Higinbotham (PaulHigin) Apr 11, 2023
@MartinGC94 MartinGC94 mentioned this pull request Apr 12, 2023
Auto-completion doesn't work for non build-in commands and path with [] #14015
Closed
@ghost ghost added the Review - Needed The PR is being reviewed label Apr 19, 2023
@ghost

Deleted user (ghost) commented Apr 19, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw Dongbo Wang (daxian-dbw) added WG-Engine core PowerShell engine, interpreter, and runtime Needs-Triage The issue is new and needs to be triaged by a work group. CommunityDay-Large A large PR that the PS team has identified to prioritize to review labels May 1, 2023
SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

PaulHigin
Paul Higinbotham (PaulHigin) suggested changes May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/regex.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/regex.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels May 8, 2023
SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) reviewed May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 9, 2023
@MartinGC94 @SteveL-MSFT
Update src/System.Management.Automation/engine/CommandCompletion/Comp…
fafcc24
…letionCompleters.cs

Co-authored-by: Steve Lee <[email protected]>
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Large label May 9, 2023
MartinGC94 and others added 2 commits May 9, 2023 18:24
@MartinGC94
Address initial feedback from Steve and Paul
75e79a8
@MartinGC94 @PaulHigin
Apply suggestions from code review
483e110
Co-authored-by: Paul Higinbotham <[email protected]>
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes May 9, 2023
View reviewed changes

@PaulHigin Paul Higinbotham (PaulHigin) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
iSazonov
Ilya (iSazonov) reviewed May 10, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/regex.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

MartinGC94 and others added 4 commits May 10, 2023 09:29
@MartinGC94 @iSazonov
Apply suggestions from code review
c839089
Co-authored-by: Ilya <[email protected]>
@MartinGC94
Apply suggestions from iSazonov.
c2ad38c
@MartinGC94
Merge branch 'ImprovePathCompletion' of https://github.com/MartinGC94…
a28ecfe
…/PowerShell into ImprovePathCompletion
@MartinGC94
Add missing period to comment.
228c669
iSazonov
Ilya (iSazonov) reviewed May 11, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
return sb.ToString();
}

private static void EscapeCharIfNeeded(

@iSazonov Ilya (iSazonov) May 11, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Not for the PR. Maybe useful .Net implementation pattern https://source.dot.net/#System.Text.RegularExpressions/System/Text/RegularExpressions/RegexParser.cs,151

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@MartinGC94
Add comment explaining limitations of current approach.
0f2683f
SteveL-MSFT
Steve Lee (SteveL-MSFT) requested changes May 15, 2023
View reviewed changes
Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 15, 2023
@MartinGC94
Correct some escaping issues and add tests
9cecc59
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 16, 2023
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented May 16, 2023

Copy link
Copy Markdown

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


Quantification details

Label      : Extra Large
Size       : +411 -177
Percentile : 86.27%

Total files changed: 4

Change summary by file extension:
.cs : +375 -174
.ps1 : +36 -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 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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) approved these changes May 22, 2023
View reviewed changes

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@PaulHigin
Paul Higinbotham (PaulHigin) merged commit 06ab3b1 into PowerShell:master May 22, 2023
@PaulHigin

Paul Higinbotham (PaulHigin) commented May 22, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

MartinGC94 Thanks for your contribution!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw Dongbo Wang (daxian-dbw) added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels May 22, 2023
@ghost

Deleted user (ghost) commented Jun 29, 2023

Copy link
Copy Markdown

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

Handy links:

  • Release Notes
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost mentioned this pull request Jun 29, 2023
Tab completion in large folders is very slow #4797
Closed
@reaching-for-libra reaching-for-libra mentioned this pull request Jul 10, 2023
PSDrive Tab completion not retaining the PSDrive name #19918
Closed
5 tasks done
@MartinGC94 MartinGC94 mentioned this pull request Jul 10, 2023
Fix completion regression for filesystem paths with custom PSDrives #19921
Merged
8 of 22 tasks
This was referenced Jul 27, 2023
Tab completion replaces tilde with full path #20033
Closed
bug(?): tab completing [ causes an error to be logged #17542
Closed
@bradwilson

Brad Wilson (bradwilson) commented Nov 22, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Also stopped it from replacing ~ when referring to home so this: ~\Downloads no longer turns into: C:\Users\Martin\Downloads\

This is an unfortunate change. It's broken me a lot because those tildes not being replaced means that applications no longer understand paths with it in it. I got a suggestion to use Enable-ExperimentalFeature PSNativePSPathResolution but that is apparently no longer an option.

Is there a way for me to turn this back on? I'm getting super tired of having to retype C:\Users\bradwilson. 😢

(If not, I may have to roll back to 7.3.9 indefinitely to preserve my sanity)

jaredpar, JoeSalmeri, and acottis reacted with thumbs up emoji masterflitzer reacted with thumbs down emoji
All reactions
  • 👍 3 reactions
  • 👎 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov

Ilya (iSazonov) commented Nov 22, 2023

Copy link
Copy Markdown
Collaborator

Brad Wilson (@bradwilson) Please open new issue to discuss your scenario(s).

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bradwilson Brad Wilson (bradwilson) mentioned this pull request Nov 22, 2023
7.4.0 Breaking Change: Tab expansion no longer converts tildes to full paths, breaking path passing to executables on Windows #20750
Closed
5 tasks done
@MartinGC94 MartinGC94 mentioned this pull request Nov 28, 2023
Function & Cmdlet Name Tab Completion Broken in the ConfigManager (CMSITE) Provider #20803
Closed
5 tasks done
@SteveL-MSFT Steve Lee (SteveL-MSFT) mentioned this pull request Apr 24, 2024
Expand ~ to $home on Windows with tab completion #21529
Merged
8 of 22 tasks
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@MartinGC94 @SteveL-MSFT
@PaulHigin @iSazonov
Improve path completion (PowerShell#19489)
a6267f2
* Improve path completion

* Update src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

Co-authored-by: Steve Lee <[email protected]>

* Address initial feedback from Steve and Paul

* Apply suggestions from code review

Co-authored-by: Paul Higinbotham <[email protected]>

* Apply suggestions from code review

Co-authored-by: Ilya <[email protected]>

* Apply suggestions from iSazonov.

* Add missing period to comment.

* Add comment explaining limitations of current approach.

* Correct some escaping issues and add tests

---------

Co-authored-by: Steve Lee <[email protected]>
Co-authored-by: Paul Higinbotham <[email protected]>
Co-authored-by: Ilya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov left review comments
@SteveL-MSFT Steve Lee (SteveL-MSFT) SteveL-MSFT approved these changes
+1 more reviewer
@PaulHigin Paul Higinbotham (PaulHigin) PaulHigin approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@PaulHigin Paul Higinbotham (PaulHigin)

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log CommunityDay-Large A large PR that the PS team has identified to prioritize to review Extra Large WG-Engine core PowerShell engine, interpreter, and runtime

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tab completion in large folders is very slow

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@MartinGC94 @PaulHigin @bradwilson @iSazonov @SteveL-MSFT @daxian-dbw
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.