Improve path completion by MartinGC94 · Pull Request #19489 · PowerShell/PowerShell

MartinGC94 · Apr 11, 2023

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

ghost · Apr 19, 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

…letionCompleters.cs Co-authored-by: Steve Lee <slee@microsoft.com>

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

PaulHigin

LGTM

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

…/PowerShell into ImprovePathCompletion

iSazonov · May 11, 2023

+            return sb.ToString();
+        }
+
+        private static void EscapeCharIfNeeded(


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

pull-request-quantifier-deprecated · May 16, 2023

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

LGTM

PaulHigin · May 22, 2023

@MartinGC94 Thanks for your contribution!

ghost · Jun 29, 2023

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

Handy links:

Release Notes

bradwilson · Nov 22, 2023

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 · Nov 22, 2023

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

Improve path completion

b680be2

ghost assigned PaulHigin Apr 11, 2023

MartinGC94 mentioned this pull request Apr 12, 2023

Auto-completion doesn't work for non build-in commands and path with [] #14015

Closed

ghost added the Review - Needed The PR is being reviewed label Apr 19, 2023

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