Skip to content

Enable case-insensitive tab completion for files and folders on case-sensitive filesystem #8128

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
iSazonov merged 6 commits into from
Oct 28, 2018
Merged

Enable case-insensitive tab completion for files and folders on case-sensitive filesystem #8128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b7e328
enable case-insensitive tab completion for files and folders
SteveL-MSFT Oct 26, 2018
97e83dd
sort the completions before validation as the order isn't guaranteed
SteveL-MSFT Oct 26, 2018
5db5590
[feature]
Oct 26, 2018
07b18e4
address Ilya's feedback
SteveL-MSFT Oct 26, 2018
a5b5889
added comment for AttributesToSkip and added test mixing files and fo…
SteveL-MSFT Oct 26, 2018
9d75e2f
Update test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
iSazonov Oct 27, 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
7 changes: 6 additions & 1 deletion 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 @@ -4174,7 +4174,7 @@ internal static IEnumerable<CompletionResult> CompleteFilename(CompletionContext
string[] entries = null;
try
{
entries = Directory.GetFileSystemEntries(parentPath, leaf);
entries = Directory.GetFileSystemEntries(parentPath, leaf, _enumerationOptions);
}
catch (Exception)
{
Expand Down Expand Up @@ -4404,6 +4404,11 @@ private struct SHARE_INFO_1
private const int ERROR_MORE_DATA = 234;
private const int STYPE_DISKTREE = 0;
private const int STYPE_MASK = 0x000000FF;
private static System.IO.EnumerationOptions _enumerationOptions = new System.IO.EnumerationOptions
{
MatchCasing = MatchCasing.CaseInsensitive,
AttributesToSkip = 0 // Default is to skip Hidden and System files, so we clear this to retain existing behavior
};

[DllImport("Netapi32.dll", CharSet = CharSet.Unicode)]
private static extern int NetShareEnum(string serverName, int level, out IntPtr bufptr, int prefMaxLen,
Expand Down
9 changes: 7 additions & 2 deletions src/System.Management.Automation/namespaces/FileSystemProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@ public FileSystemProvider()
}

private Collection<WildcardPattern> _excludeMatcher = null;
private static System.IO.EnumerationOptions _enumerationOptions = new System.IO.EnumerationOptions
{
MatchCasing = MatchCasing.CaseInsensitive,
AttributesToSkip = 0 // Default is to skip Hidden and System files, so we clear this to retain existing behavior
};

/// <summary>
/// Converts all / in the path to \
Expand Down Expand Up @@ -1569,7 +1574,7 @@ private void Dir(
else
{
// Filter the directories
target.Add(directory.EnumerateDirectories(Filter));
target.Add(directory.EnumerateDirectories(Filter, _enumerationOptions));
}

// Making sure to obey the StopProcessing.
Expand All @@ -1580,7 +1585,7 @@ private void Dir(

// Use the specified filter when retrieving the
// children
target.Add(directory.EnumerateFiles(Filter));
target.Add(directory.EnumerateFiles(Filter, _enumerationOptions));
}
else
{
Expand Down
48 changes: 48 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 @@ -222,6 +222,7 @@ Describe "TabCompletion" -Tags CI {
$oneSubDir = Join-Path -Path $tempDir -ChildPath "oneSubDir"
$oneSubDirPrime = Join-Path -Path $tempDir -ChildPath "prime"
$twoSubDir = Join-Path -Path $oneSubDir -ChildPath "twoSubDir"
$caseTestPath = Join-Path $testdrive "CaseTest"

New-Item -Path $tempDir -ItemType Directory -Force > $null
New-Item -Path $oneSubDir -ItemType Directory -Force > $null
Expand Down Expand Up @@ -254,12 +255,17 @@ Describe "TabCompletion" -Tags CI {
}
}

BeforeEach {
New-Item -ItemType Directory -Path $caseTestPath > $null
}

AfterAll {
Remove-Item -Path $tempDir -Recurse -Force -ErrorAction SilentlyContinue
}

AfterEach {
Pop-Location
Remove-Item -Path $caseTestPath -Recurse -Force -ErrorAction SilentlyContinue
}

It "Input '<inputStr>' should successfully complete" -TestCases $testCases {
Expand Down Expand Up @@ -318,6 +324,48 @@ Describe "TabCompletion" -Tags CI {
$res.CompletionMatches | Should -HaveCount 1
$res.CompletionMatches[0].CompletionText | Should -BeExactly $afterTab
}

It "Test case insensitive <type> path" -Skip:(!$IsLinux) -TestCases @(
@{ type = "File" ; beforeTab = "Get-Content f" },
@{ type = "Directory"; beforeTab = "cd f" }
) {
param ($type, $beforeTab)

$testItems = "foo", "Foo", "fOO"
$testItems | ForEach-Object {
$itemPath = Join-Path $caseTestPath $_
New-Item -ItemType $type -Path $itemPath
}
Push-Location $caseTestPath
$res = TabExpansion2 -inputScript $beforeTab -cursorColumn $beforeTab.Length
$res.CompletionMatches | Should -HaveCount $testItems.Count

# order isn't guaranteed so we'll sort them first
$completions = ($res.CompletionMatches | Sort-Object CompletionText -CaseSensitive).CompletionText -join ":"
$expected = ($testItems | Sort-Object -CaseSensitive | ForEach-Object { "./$_" }) -join ":"

$completions | Should -BeExactly $expected
}

It "Test case insensitive file and folder path completing for <type>" -Skip:(!$IsLinux) -TestCases @(
@{ type = "File" ; beforeTab = "Get-Content f"; expected = "foo","Foo" }, # Get-Content passes thru to provider
@{ type = "Directory"; beforeTab = "cd f" ; expected = "Foo" } # Set-Location is aware of Files vs Folders
) {
param ($beforeTab, $expected)

$filePath = Join-Path $caseTestPath "foo"
$folderPath = Join-Path $caseTestPath "Foo"
New-Item -ItemType File -Path $filePath
New-Item -ItemType Directory -Path $folderPath
Push-Location $caseTestPath
$res = TabExpansion2 -inputScript $beforeTab -cursorColumn $beforeTab.Length
$res.CompletionMatches | Should -HaveCount $expected.Count

# order isn't guaranteed so we'll sort them first
$completions = ($res.CompletionMatches | Sort-Object CompletionText -CaseSensitive).CompletionText -join ":"
$expected = ($expected | Sort-Object -CaseSensitive | ForEach-Object { "./$_" }) -join ":"

}
}

Context "Cmdlet name completion" {
Expand Down