Added `-Module` completion for `Save-Help`/`Update-Help` commands #20678

ArmaanMcleod · 2023-11-12T08:35:18Z

PR Summary

Fixes #20431.

Added -Module completion for Save-Help/Update-Help commands.

PR Context

Currently if you try to tab complete modules with Save-Help -Module or Update-Help -Module there is no tab completion.

This PR adds native completion to both commands. It wraps the existing completion code from Get-Command -Module into void CompleteModule(CompletionContext context, List<CompletionResult> result) method so it can also be used for the two help commands.

PR Checklist

iSazonov · 2023-12-19T16:21:47Z

test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1

+            $utilityModule = 'Microsoft.PowerShell.Utility'
+            $managementModule = 'Microsoft.PowerShell.Management'
+            $allPowerShellModules = ((Get-Module -Name Microsoft.Power* -ListAvailable).Name | Sort-Object -Unique) -join ' '
+        }


To make the tests more stable I think we should explicitly load modules we use in the tests.

I feel like this is not needed since all the modules are fetched using wildcard and should be auto loaded in the test before we use Get-Module -ListAvailable. We would need to keep the list of module names if we wanted to import modules beforehand explicitly, which gets more complicated because some assemblies are windows only.

Best practice is any test shouldn't depend on another test or its order.

[-] Error occurred in Context block 0ms RuntimeException: The following error occurred while loading the extended type data file: Error in TypeData "Microsoft.PowerShell.Commands.GetCounter.PerformanceCounterSampleSet": The member Readings is already present. Error in TypeData "Microsoft.PowerShell.Commands.GetCounter.PerformanceCounterSampleSet": The member DefaultDisplayPropertySet is already present. Error in TypeData "Microsoft.PowerShell.Commands.GetCounter.PerformanceCounterSample": The member DefaultDisplayPropertySet is already present. Error in TypeData "Microsoft.PowerShell.Commands.GetCounter.CounterSet": The member Counter is already present. Error in TypeData "System.Diagnostics.Eventing.Reader.ProviderMetadata": The member DefaultDisplayPropertySet is already present. Error in TypeData "System.Diagnostics.Eventing.Reader.ProviderMetadata": The member ProviderName is already present. Error in TypeData "System.Diagnostics.Eventing.Reader.EventLogRecord": The member DefaultDisplayPropertySet is already present. Error in TypeData "System.Diagnostics.Eventing.Reader.EventLogConfiguration": The member DefaultDisplayPropertySet is already present. at <ScriptBlock>, C:\Users\armaa\Documents\git-repos\PowerShell\test\powershell\Host\TabCompletion\TabCompletion.Tests.ps1: line 893 at Invoke-Blocks, C:\Users\armaa\OneDrive\Documents\PowerShell\Modules\Pester\4.10.1\Functions\SetupTeardown.ps1: line 135 at Invoke-TestGroupSetupBlocks, C:\Users\armaa\OneDrive\Documents\PowerShell\Modules\Pester\4.10.1\Functions\SetupTeardown.ps1: line 121 at DescribeImpl, C:\Users\armaa\OneDrive\Documents\PowerShell\Modules\Pester\4.10.1\Functions\Describe.ps1: line 209

Above is what happens in test if you try to import all microsoft powershell modules.

Is it after you added Import-Module Microsoft.PowerShell.Diagnostics?

Yep that is correct.

I included -ErrorAction SilentlyContinue so test doesn't fail here. It seems to fail only for diagnostics module.

This just shows a side effect of the other tests. It shouldn't be. But that's not the subject of this PR.

We can probably raise a separate issue to cover it but agree it shouldn't be fixed in this PR.

iSazonov · 2023-12-19T16:23:21Z

@MartinGC94 Could you please review?

MartinGC94 · 2023-12-20T15:28:10Z

@iSazonov LGTM

pull-request-quantifier · 2023-12-21T07:13:42Z

This PR has 61 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Small
Size       : +46 -15
Percentile : 24.4%

Total files changed: 2

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

microsoft-github-policy-service · 2023-12-21T08:06:31Z

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

🔗 https://aka.ms/PSRepoFeedback

Microsoft Forms

…werShell#20678)

ArmaanMcleod added 2 commits November 12, 2023 19:30

Added module completion to Save-Help & Update-Help commands

72a77c1

Add tests

1fd33f9

pull-request-quantifier bot added the Small label Nov 12, 2023

microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Nov 19, 2023

iSazonov reviewed Dec 19, 2023

View reviewed changes

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Dec 19, 2023

Merge branch 'master' into save-update-help-module-completers

d7992b9

Import all MS powershell modules in test

6d776d0

ArmaanMcleod requested a review from iSazonov December 21, 2023 07:14

iSazonov added CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update labels Dec 21, 2023

iSazonov self-assigned this Dec 21, 2023

iSazonov approved these changes Dec 21, 2023

View reviewed changes

iSazonov merged commit 1b98bb0 into PowerShell:master Dec 21, 2023
34 checks passed

ArmaanMcleod deleted the save-update-help-module-completers branch December 21, 2023 08:23

VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023

Added -Module completion for Save-Help/Update-Help commands (Po…

e97eced

…werShell#20678)

Dec	JAN	Feb
	10
2023	2024	2025

Added `-Module` completion for `Save-Help`/`Update-Help` commands #20678

Added `-Module` completion for `Save-Help`/`Update-Help` commands #20678

ArmaanMcleod commented Nov 12, 2023

iSazonov Dec 19, 2023 •

edited

ArmaanMcleod Dec 20, 2023

iSazonov Dec 20, 2023

ArmaanMcleod Dec 20, 2023

iSazonov Dec 21, 2023

ArmaanMcleod Dec 21, 2023

ArmaanMcleod Dec 21, 2023

iSazonov Dec 21, 2023

ArmaanMcleod Dec 21, 2023

iSazonov commented Dec 19, 2023

MartinGC94 commented Dec 20, 2023

pull-request-quantifier bot commented Dec 21, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

microsoft-github-policy-service bot commented Dec 21, 2023 •

edited by unfurl-links bot

Added -Module completion for Save-Help/Update-Help commands #20678

Added -Module completion for Save-Help/Update-Help commands #20678

Conversation

ArmaanMcleod commented Nov 12, 2023

PR Summary

PR Context

PR Checklist

iSazonov Dec 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iSazonov commented Dec 19, 2023

MartinGC94 commented Dec 20, 2023

pull-request-quantifier bot commented Dec 21, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

microsoft-github-policy-service bot commented Dec 21, 2023 • edited by unfurl-links bot

Added `-Module` completion for `Save-Help`/`Update-Help` commands #20678

Added `-Module` completion for `Save-Help`/`Update-Help` commands #20678

iSazonov Dec 19, 2023 •

edited

microsoft-github-policy-service bot commented Dec 21, 2023 •

edited by unfurl-links bot