Support forward slashes in network share (UNC path) completion (#17111) by sba923 · Pull Request #17117 · PowerShell/PowerShell · GitHub
Skip to content

Support forward slashes in network share (UNC path) completion (#17111)#17117

Merged
iSazonov merged 4 commits intoPowerShell:masterfrom
sba923:sba923/17111
Apr 12, 2022
Merged

Support forward slashes in network share (UNC path) completion (#17111)#17117
iSazonov merged 4 commits intoPowerShell:masterfrom
sba923:sba923/17111

Conversation

@sba923
Copy link
Copy Markdown
Contributor

@sba923 sba923 commented Apr 6, 2022

PR Summary

This PR implements support for forward slashes in partial network share (UNC paths) names when performing tab completion (Close #17111)

PR Context

This makes tab completion easier to use e.g. when using French layout keyboards, where entering a forward slash (Shift+:) is way easier than entering a backslash (AltGr+8).

PR Checklist

@sba923
Copy link
Copy Markdown
Contributor Author

sba923 commented Apr 7, 2022

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Apr 8, 2022

@sba923 Please add test(s).

@sba923
Copy link
Copy Markdown
Contributor Author

sba923 commented Apr 8, 2022

@sba923 Please add test(s).

This is an interactive feature, how can I possibly add (CI) tests?

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Apr 8, 2022

@sba923 See TabCompletion.Tests.ps1 file for examples.

@sba923
Copy link
Copy Markdown
Contributor Author

sba923 commented Apr 8, 2022

@sba923 See TabCompletion.Tests.ps1 file for examples.

Sorry, I'd missed that.

Now I need to find out how to locally run the tests with the one I've just added, but that is probably documented somewhere.

@sba923
Copy link
Copy Markdown
Contributor Author

sba923 commented Apr 8, 2022

Now I need to find out how to locally run the tests with the one I've just added, but that is probably documented somewhere.

https://github.com/PowerShell/PowerShell/blob/master/docs/testing-guidelines/testing-guidelines.md#running-tests-outside-of-ci

😉

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@sba923
Copy link
Copy Markdown
Contributor Author

sba923 commented Apr 8, 2022

@sba923 Please add test(s).

Done.

Comment thread test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Outdated
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Apr 8, 2022
}

It "Tab completion UNC path with forward slashes" -Skip:(!$IsWindows) {
$homeDrive = $env:HOMEDRIVE.Replace(":", "$")
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.

It is not used now and can be removed, yes?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Correct. The test case is needed to validate the PR's change, but $homeDrive is not needed anymore. My bad. Removing that.

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

This PR has 9 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       : +8 -1
Percentile : 3.6%

Total files changed: 2

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

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

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Apr 12, 2022
@iSazonov iSazonov merged commit 4acf6b3 into PowerShell:master Apr 12, 2022
@ghost
Copy link
Copy Markdown

ghost commented May 23, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Network share path expansion should support forward slashes

3 participants