Skip to content

Fix Get-Help for advanced functions with MAML help content #8353

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

Merged
adityapatwardhan merged 8 commits into from
Nov 30, 2018
Merged

Fix Get-Help for advanced functions with MAML help content #8353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
573aa3d
Update the static test content for PSReadline v2
adityapatwardhan Nov 28, 2018
7344142
Fix tests to expect the new file name
adityapatwardhan Nov 28, 2018
9b30c87
[Feature] Add the about help file to the list of expected help files
adityapatwardhan Nov 29, 2018
d264e0d
[Feature] Remove PSReadLine module from help tests
adityapatwardhan Nov 29, 2018
e04fdbc
Update help content for Microsoft.PowerShell.Archive and update tests
adityapatwardhan Nov 29, 2018
5916e8d
[Feature] Fix issue in Get-Help where MAML help for advanced function…
adityapatwardhan Nov 29, 2018
c2707ca
[Feature] CodeFactor fixes
adityapatwardhan Nov 29, 2018
4d139c1
[Feature] Added null check for moduleName
adityapatwardhan Nov 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/System.Management.Automation/help/CommandHelpProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,13 +313,20 @@ private HelpInfo GetHelpInfo(CommandInfo commandInfo, bool reportErrors, bool se
// and the nested module that implements the command
GetModulePaths(commandInfo, out moduleName, out moduleDir, out nestedModulePath);

Collection<String> searchPaths = new Collection<String>(){ HelpUtils.GetUserHomeHelpSearchPath() };
var userHomeHelpPath = HelpUtils.GetUserHomeHelpSearchPath();

Collection<string> searchPaths = new Collection<string>() { userHomeHelpPath };

if (!String.IsNullOrEmpty(moduleDir))
{
searchPaths.Add(moduleDir);
}

if (!String.IsNullOrEmpty(userHomeHelpPath) && !String.IsNullOrEmpty(moduleName))
{
searchPaths.Add(Path.Combine(userHomeHelpPath, moduleName));
}

if (!String.IsNullOrEmpty(moduleName) && !String.IsNullOrEmpty(moduleDir))
{
// Search for <ModuleName>-Help.xml under ModuleBase folder
Expand Down
20 changes: 10 additions & 10 deletions test/powershell/engine/Help/HelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ Describe 'help can be found for CurrentUser Scope' -Tags 'CI' {
Remove-Item $userHelpRoot -Force -ErrorAction SilentlyContinue -Recurse
UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Core' -Scope 'CurrentUser'
UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Management' -Scope 'CurrentUser'
UpdateHelpFromLocalContentPath -ModuleName 'PSReadLine' -Scope CurrentUser -Force
UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Archive' -Scope 'CurrentUser' -Force
UpdateHelpFromLocalContentPath -ModuleName 'PackageManagement' -Scope CurrentUser -Force

## Delete help from global scope if it exists.
Expand All @@ -401,15 +401,15 @@ Describe 'help can be found for CurrentUser Scope' -Tags 'CI' {
Remove-Item $coreHelpFilePath -Force -ErrorAction SilentlyContinue
}

$psreadlineHelpFilePath = Join-Path (Get-Module PSReadLine -ListAvailable).ModuleBase -ChildPath $currentCulture -AdditionalChildPath 'Microsoft.PowerShell.PSReadLine.dll-Help.xml'
if (Test-Path $psreadlineHelpFilePath) {
Remove-Item $psreadlineHelpFilePath -Force -ErrorAction SilentlyContinue
$archiveHelpFilePath = Join-Path (Get-Module Microsoft.PowerShell.Archive -ListAvailable).ModuleBase -ChildPath $currentCulture -AdditionalChildPath 'Microsoft.PowerShell.Archive-help.xml'
if (Test-Path $archiveHelpFilePath) {
Remove-Item $archiveHelpFilePath -Force -ErrorAction SilentlyContinue
}

$TestCases = @(
@{TestName = 'module under $PSHOME'; CmdletName = 'Add-Content'}
@{TestName = 'module is a PSSnapin'; CmdletName = 'Get-Command' }
@{TestName = 'module is under $PSHOME\Modules'; CmdletName = 'Get-PSReadlineOption' }
@{TestName = 'module is under $PSHOME\Modules'; CmdletName = 'Compress-Archive' }
@{TestName = 'module has a version folder'; CmdletName = 'Find-Package' }
)
}
Expand Down Expand Up @@ -442,20 +442,20 @@ Describe 'help can be found for AllUsers Scope' -Tags @('Feature', 'RequireAdmin
Remove-Item $coreHelpFilePath -Force -ErrorAction SilentlyContinue
}

$psreadlineHelpFilePath = Join-Path (Get-Module PSReadLine -ListAvailable).ModuleBase -ChildPath $currentCulture -AdditionalChildPath 'Microsoft.PowerShell.PSReadLine.dll-Help.xml'
if (Test-Path $psreadlineHelpFilePath) {
Remove-Item $psreadlineHelpFilePath -Force -ErrorAction SilentlyContinue
$archiveHelpFilePath = Join-Path (Get-Module Microsoft.PowerShell.Archive -ListAvailable).ModuleBase -ChildPath $currentCulture -AdditionalChildPath 'Microsoft.PowerShell.Archive-help.xml'
if (Test-Path $archiveHelpFilePath) {
Remove-Item $archiveHelpFilePath -Force -ErrorAction SilentlyContinue
}

UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Core' -Scope 'AllUsers'
UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Management' -Scope 'AllUsers'
UpdateHelpFromLocalContentPath -ModuleName 'PSReadLine' -Scope 'AllUsers' -Force
UpdateHelpFromLocalContentPath -ModuleName 'Microsoft.PowerShell.Archive' -Scope 'AllUsers' -Force
UpdateHelpFromLocalContentPath -ModuleName 'PackageManagement' -Scope 'AllUsers' -Force

$TestCases = @(
@{TestName = 'module under $PSHOME'; CmdletName = 'Add-Content'}
@{TestName = 'module is a PSSnapin'; CmdletName = 'Get-Command' }
@{TestName = 'module is under $PSHOME\Modules'; CmdletName = 'Get-PSReadlineOption' }
@{TestName = 'module is under $PSHOME\Modules'; CmdletName = 'Compress-Archive' }
@{TestName = 'module has a version folder'; CmdletName = 'Find-Package' }
)
}
Expand Down
15 changes: 1 addition & 14 deletions test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ $powershellCoreModules = @(
"Microsoft.WsMan.Management"
"PackageManagement"
# "PowershellGet"
"PSReadline"
)

# The file extension for the help content on the Download Center.
Expand Down Expand Up @@ -53,16 +52,12 @@ $testCases = @{
HelpInstallationPathHome = "$userHelpRoot\CimCmdlets\en-US"
}

<#
This scenario is broken due to issue # https://github.com/PowerShell/platyPS/issues/241
Re-enable when issue is fixed.
"Microsoft.PowerShell.Archive" = @{
HelpFiles = "Microsoft.PowerShell.Archive.psm1-help.xml"
HelpFiles = "Microsoft.PowerShell.Archive-help.xml"
HelpInfoFiles = "Microsoft.PowerShell.Archive_eb74e8da-9ae2-482a-a648-e96550fb8733_HelpInfo.xml"
CompressedFiles = "Microsoft.PowerShell.Archive_eb74e8da-9ae2-482a-a648-e96550fb8733_en-US_HelpContent$extension"
HelpInstallationPath = "$pshome\Modules\Microsoft.PowerShell.Archive\en-US"
}
#>

"Microsoft.PowerShell.Core" = @{
HelpFiles = "System.Management.Automation.dll-help.xml"
Expand Down Expand Up @@ -143,14 +138,6 @@ $testCases = @{
HelpInstallationPath = "$pshome\Modules\PowershellGet\en-US"
HelpInstallationPathHome = "$userHelpRoot\PackageManagement\en-US"
}

"PSReadline" = @{
HelpFiles = "Microsoft.PowerShell.PSReadLine.dll-help.xml"
HelpInfoFiles = "PSReadline_5714753b-2afd-4492-a5fd-01d9e2cff8b5_HelpInfo.xml"
CompressedFiles = "PSReadline_5714753b-2afd-4492-a5fd-01d9e2cff8b5_en-US_helpcontent$extension"
HelpInstallationPath = "$pshome\Modules\PSReadLine\en-US"
HelpInstallationPathHome = "$userHelpRoot\PSReadLine\en-US"
}
}

# These are the inbox modules.
Expand Down
2 changes: 1 addition & 1 deletion ...elp/assets/Microsoft.PowerShell.Archive_eb74e8da-9ae2-482a-a648-e96550fb8733_HelpInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>5.0.2.0</UICultureVersion>
<UICultureVersion>6.1.0.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
Binary file modified ...s/Microsoft.PowerShell.Archive_eb74e8da-9ae2-482a-a648-e96550fb8733_en-US_HelpContent.cab
View file
Open in desktop
Binary file not shown.
Binary file modified ...s/Microsoft.PowerShell.Archive_eb74e8da-9ae2-482a-a648-e96550fb8733_en-US_HelpContent.zip
View file
Open in desktop
Binary file not shown.
10 changes: 0 additions & 10 deletions ...owershell/engine/Help/assets/PSReadline_5714753b-2afd-4492-a5fd-01d9e2cff8b5_HelpInfo.xml
View file
Open in desktop

This file was deleted.

Binary file removed .../engine/Help/assets/PSReadline_5714753b-2afd-4492-a5fd-01d9e2cff8b5_en-US_helpcontent.cab
View file
Open in desktop
Binary file not shown.
Binary file removed .../engine/Help/assets/PSReadline_5714753b-2afd-4492-a5fd-01d9e2cff8b5_en-US_helpcontent.zip
View file
Open in desktop
Binary file not shown.