Skip to content
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.

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

Add ExcludeModule parameter to Get-Command #18955

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

MartinGC94
Copy link
Contributor

@MartinGC94 MartinGC94 commented Jan 17, 2023

PR Summary

Adds the ExcludeModule parameter to Get-Command so you can exclude commands from specified modules like this: Get-Command *disk* -ExcludeModule Storage.

PR Context

The main purpose is to contribute towards: #16747 but like the previous example shows it can also be useful when manually searching for commands.

PR Checklist

@ThomasNieto
Copy link
Contributor

The parameter name should be ExcludeModule to match existing cmdlets that use Exclude not Excluded.

@MartinGC94 MartinGC94 changed the title Add ExcludedModule parameter to Get-Command Add ExcludeModule parameter to Get-Command Jan 17, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label Jan 25, 2023
@ghost
Copy link

ghost commented Jan 25, 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

@SteveL-MSFT SteveL-MSFT added the WG-Cmdlets general cmdlet issues label Jan 30, 2023
@SteveL-MSFT
Copy link
Member

Queued this up for the WG-Cmdlets to discuss

@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 30, 2023
@SteveL-MSFT
Copy link
Member

The Cmdlet WG reviewed this and agree with adding this parameter to Get-Command. We're not making any statement on the quality of this PR.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Feb 2, 2023
@pull-request-quantifier-deprecated

This PR has 29 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 -1
Percentile : 11.6%

Total files changed: 3

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

@ghost ghost added the Review - Needed The PR is being reviewed label Feb 11, 2023
@ghost
Copy link

ghost commented Feb 11, 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

@daxian-dbw daxian-dbw added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023
@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 15, 2023
@doctordns
Copy link
Contributor

What is the status of this PR?

@alanlivio
Copy link

Hi all. What is the status of this PR?

@alanlivio
Copy link

Hi all again. Just following up. What is the status of this PR?

@alanlivio
Copy link

Sorry to ask again, but what is the status of this PR @iSazonov and @daxian-dbw?

@MartinGC94
Copy link
Contributor Author

MartinGC94 commented Feb 7, 2024

@alanlivio Good news, according to the PS team blogpost: https://devblogs.microsoft.com/powershell/powershell-and-openssh-team-investments-for-2024/ one of the goals for 2024 is to focus on getting community PRs merged. Obviously they haven't started doing that yet, but it would be very weird if they didn't start within the next couple of weeks after making a blog post like that.

PowerShell Team
Planned team investments for 2024 for PowerShell, OpenSSH, and related tooling.

@alanlivio
Copy link

Good news. I hope that they can merge your PR soon.

@microsoft-github-policy-service microsoft-github-policy-service bot 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 13, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 18, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label May 26, 2024
Copy link
Contributor

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

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 Needs-Triage The issue is new and needs to be triaged by a work group. PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed Review - Needed The PR is being reviewed WG-Cmdlets general cmdlet issues WG-Reviewed A Working Group has reviewed this and made a recommendation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants