8000 Add completion of modules by their shortname by MartinGC94 · Pull Request #20330 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Add completion of modules by their shortname #20330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Dec 28, 2024
Merged

Add completion of modules by their shortname #20330

merged 4 commits into from
Dec 28, 2024

Conversation

MartinGC94
Copy link
Contributor
@MartinGC94 MartinGC94 commented Sep 22, 2023 •
edited
Loading

PR Summary

Adds completion of modules by their shortname (defined as the substring after the last period in a module name, eg Archive in Microsoft.PowerShell.Archive).
Meaning that users can now type: Archi<Tab> and get Microsoft.PowerShell.Archive.

PR Context

Fixes #20281

PR Checklist

@StevenBucher98 StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label Sep 25, 2023
@kilasuit
Copy link
Collaborator
kilasuit commented Sep 26, 2023 •
edited
Loading

I have downloaded the build output for this PR & can confirm that as from the ask in the linked issue of I want to be able to Import-Module PSR{Tab} this works as expected,

However for any search like

Import-Module Power

This doesn't bring up any Microsoft.PowerShell.* entries at all but does get PowerShellGet, Az.PowerBIEmbedded & PowerShellHumanizer in my test

So perhaps this would need a minor change to return all wildcard matches like I've suggested in the linked issue

@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Oct 6, 2023
@kilasuit kilasuit added the WG-Interactive-IntelliSense tab completion label Oct 11, 2023
@pull-request-quantifier-deprecated Pull Request Quantifier (deprecated)
Copy link

This PR has 39 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       : +28 -11
Percentile : 15.6%

Total files changed: 2

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

@theJasonHelmick theJasonHelmick added the WG-Reviewed A Working Group has reviewed this and made a recommendation label Dec 4, 2024
@SeeminglyScience
Copy link
Collaborator

The Interactive WG discussed this, and agree with the change.

This doesn't bring up any Microsoft.PowerShell.* entries at all but does get PowerShellGet, Az.PowerBIEmbedded & PowerShellHumanizer in my test

The interactive WG decided that the current behavior is better than wildcards on both ends. One change we would like to see is following type completion more closely, like Microsoft.Pow<tab> completing Microsoft.PowerShell. That is out of scope for this PR though, I will open a separate issue.

@MartinGC94 @iSazonov
Update src/System.Management.Automation/engine/CommandCompletion/Comp…
bf2d856 
…letionCompleters.cs

Co-authored-by: Ilya <darpa@yandex.ru>
@iSazonov iSazonov self-assigned this Dec 28, 2024
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 28, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Dec 28, 2024
@iSazonov iSazonov merged commit 8cdb728 into PowerShell:master Dec 28, 2024
37 of 38 checks passed
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link
Contributor
microsoft-github-policy-service bot commented Dec 28, 2024 •
edited by unfurl-links bot
Loading

📣 Hey @MartinGC94, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

@iSazonov iSazonov mentioned this pull request Feb 1, 2025
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov iSazonov approved these changes

@ThomasNieto ThomasNieto ThomasNieto approved these changes

Assignees

@iSazonov iSazonov

Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update WG-Interactive-IntelliSense tab completion WG-Reviewed A Working Group has reviewed this and made a recommendation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Import-Module TabCompletion should let me type just the last part of the name
7 participants
@MartinGC94 @kilasuit @SeeminglyScience @iSazonov @ThomasNieto @theJasonHelmick @StevenBucher98
0