Skip to content

Improve path completion - #19489

Merged
Paul Higinbotham (PaulHigin) merged 10 commits into
PowerShell:masterfrom
MartinGC94:ImprovePathCompletion
May 22, 2023
Merged

Improve path completion#19489
Paul Higinbotham (PaulHigin) merged 10 commits into
PowerShell:masterfrom
MartinGC94:ImprovePathCompletion

Conversation

@MartinGC94

@MartinGC94 MartinGC94 commented Apr 11, 2023 •
edited
Loading

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

@MartinGC94 MartinGC94 mentioned this pull request Apr 12, 2023
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

@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
PaulHigin
Paul Higinbotham (PaulHigin) suggested changes May 8, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/regex.cs
Comment thread src/System.Management.Automation/engine/regex.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
@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
@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 <slee@microsoft.com>
MartinGC94 and others added 2 commits May 9, 2023 18:24
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

Choose a reason for hiding this comment

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

LGTM

iSazonov
Ilya (iSazonov) reviewed May 10, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated
Comment thread src/System.Management.Automation/engine/regex.cs
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

Copy link
Copy Markdown
Collaborator

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

SteveL-MSFT
Steve Lee (SteveL-MSFT) requested changes May 15, 2023
View reviewed changes
Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Outdated
Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
@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
@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.

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

Choose a reason for hiding this comment

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

LGTM

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

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

Copy link
Copy Markdown
Contributor

MartinGC94 Thanks for your contribution!

@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:

@ghost ghost mentioned this pull request Jun 29, 2023
Closed
@reaching-for-libra reaching-for-libra mentioned this pull request Jul 10, 2023
Closed
5 tasks
@MartinGC94 MartinGC94 mentioned this pull request Jul 10, 2023
Merged
22 tasks
This was referenced Jul 27, 2023
Closed
Closed
@bradwilson

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

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)

@iSazonov

Ilya (iSazonov) commented Nov 22, 2023

Copy link
Copy Markdown
Collaborator

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

@bradwilson Brad Wilson (bradwilson) mentioned this pull request Nov 22, 2023
Closed
5 tasks
@MartinGC94 MartinGC94 mentioned this pull request Nov 28, 2023
Closed
5 tasks
@SteveL-MSFT Steve Lee (SteveL-MSFT) mentioned this pull request Apr 24, 2024
Merged
22 tasks
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/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 <slee@microsoft.com>

* Address initial feedback from Steve and Paul

* Apply suggestions from code review

Co-authored-by: Paul Higinbotham <paulhi@microsoft.com>

* Apply suggestions from code review

Co-authored-by: Ilya <darpa@yandex.ru>

* 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 <slee@microsoft.com>
Co-authored-by: Paul Higinbotham <paulhi@microsoft.com>
Co-authored-by: Ilya <darpa@yandex.ru>
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

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

6 participants

@MartinGC94 @PaulHigin @bradwilson @iSazonov @SteveL-MSFT @daxian-dbw