Skip to content

Fix tab completion for unlocalized about* topics #15265

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 5 commits into from
May 5, 2021
+39 −48
Merged

Fix tab completion for unlocalized about* topics #15265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
06d85f6
Fix tab completion for unlocalized about* topics
MartinGC94 Apr 18, 2021
f364ebc
Add missing whitespace
MartinGC94 Apr 18, 2021
2c01200
Use DirectoryInfo to check if folder exists.
MartinGC94 Apr 19, 2021
b2fe121
Remove unnecessary iteration over foundTopics.
MartinGC94 Apr 19, 2021
1246353
Apply suggested changes.
MartinGC94 Apr 20, 2021
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
70 changes: 22 additions & 48 deletions src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6270,69 +6270,43 @@ private static string GetNamespaceToRemove(CompletionContext context, TypeComple
internal static List<CompletionResult> CompleteHelpTopics(CompletionContext context)
{
var results = new List<CompletionResult>();
var searchPaths = new List<string>();
var currentCulture = CultureInfo.CurrentCulture.Name;

// Add the user scope path first, since it is searched in order.
var userHelpRoot = Path.Combine(HelpUtils.GetUserHomeHelpSearchPath(), currentCulture);

if (Directory.Exists(userHelpRoot))
{
searchPaths.Add(userHelpRoot);
}

var dirPath = Path.Combine(Utils.GetApplicationBase(Utils.DefaultPowerShellShellID), currentCulture);
searchPaths.Add(dirPath);

var wordToComplete = context.WordToComplete + "*";
var topicPattern = WildcardPattern.Get("about_*.help.txt", WildcardOptions.IgnoreCase);
List<string> files = new List<string>();

string userHelpDir = HelpUtils.GetUserHomeHelpSearchPath();
string appHelpDir = Utils.GetApplicationBase(Utils.DefaultPowerShellShellID);
string currentCulture = CultureInfo.CurrentCulture.Name;

//search for help files for the current culture + en-US as fallback
var searchPaths = new string[]
{
Path.Combine(userHelpDir, currentCulture),
Path.Combine(appHelpDir, currentCulture),
Path.Combine(userHelpDir, "en-US"),
Path.Combine(appHelpDir, "en-US")
}.Distinct();

string wordToComplete = context.WordToComplete + "*";
try
{
var wildcardPattern = WildcardPattern.Get(wordToComplete, WildcardOptions.IgnoreCase);

foreach (var dir in searchPaths)
{
foreach (var file in Directory.EnumerateFiles(dir))
var currentDir = new DirectoryInfo(dir);
if (currentDir.Exists)
{
if (wildcardPattern.IsMatch(Path.GetFileName(file)))
foreach (var file in currentDir.EnumerateFiles("about_*.help.txt"))
{
files.Add(file);
if (wildcardPattern.IsMatch(file.Name))
{
string topicName = file.Name.Substring(0, file.Name.LastIndexOf(".help.txt"));
results.Add(new CompletionResult(topicName));
}
}
}
}
}
catch (Exception)
{
}

if (files != null)
{
foreach (string file in files)
{
if (file == null)
{
continue;
}

try
{
var fileName = Path.GetFileName(file);
if (fileName == null || !topicPattern.IsMatch(fileName))
continue;

// All topic files are ending with ".help.txt"
var completionText = fileName.Substring(0, fileName.Length - 9);
results.Add(new CompletionResult(completionText));
}
catch (Exception)
{
continue;
}
}
}

return results;
}

Expand Down
17 changes: 17 additions & 0 deletions test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1371,6 +1371,23 @@ dir -Recurse `
$res.CompletionMatches | Should -HaveCount $expectedCompletions
$res.CompletionMatches[0].CompletionText | Should -BeExactly 'about_Splatting'
}

It 'Should complete about help topic regardless of culture' {
try
{
## Save original culture and temporarily set it to da-DK because there's no localized help for da-DK.
$OriginalCulture = [cultureinfo]::CurrentCulture
[cultureinfo]::CurrentCulture="da-DK"

$res = TabExpansion2 -inputScript 'get-help about_spla' -cursorColumn 'get-help about_spla'.Length
$res.CompletionMatches | Should -HaveCount 1
$res.CompletionMatches[0].CompletionText | Should -BeExactly 'about_Splatting'
}
finally
{
[cultureinfo]::CurrentCulture = $OriginalCulture
}
}
}
}

Expand Down