Skip to content

Fix tooltip for variable expansion and include description #25112

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 2 commits into from
Mar 3, 2025
Merged

Fix tooltip for variable expansion and include description #25112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
340ef5e
Fix tooltip for var expansion and include desc
jborean93 Mar 2, 2025
9e5a5ec
Apply suggestions from code review
jborean93 Mar 2, 2025
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
12 changes: 11 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 @@ -5384,10 +5384,15 @@ internal static List<CompletionResult> CompleteVariable(CompletionContext contex
var toolTip = value is null
? key
: StringUtil.Format("[{0}]${1}", ToStringCodeMethods.Type(value.GetType(), dropNamespaces: true), key);
if (!string.IsNullOrEmpty(variable.Description))
{
toolTip += $" - {variable.Description}";
}

var completionText = !tokenAtCursorUsedBraces && !ContainsCharactersRequiringQuotes(name)
? prefix + name
: prefix + "{" + name + "}";
AddUniqueVariable(hashedResults, tempResults, completionText, key, key);
AddUniqueVariable(hashedResults, tempResults, completionText, key, toolTip);
}
}

Expand Down Expand Up @@ -5436,6 +5441,11 @@ internal static List<CompletionResult> CompleteVariable(CompletionContext contex
}
}

if (!string.IsNullOrEmpty(variable.Description))
{
tooltip += $" - {variable.Description}";
}

var completedName = !tokenAtCursorUsedBraces && !ContainsCharactersRequiringQuotes(name)
? prefix + scopePrefix + name
: prefix + "{" + scopePrefix + name + "}";
Expand Down
28 changes: 28 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 @@ -104,6 +104,34 @@ Describe "TabCompletion" -Tags CI {
$res = TabExpansion2 -inputScript 'param($PS = $P'
$res.CompletionMatches.Count | Should -BeGreaterThan 0
}

It 'Should complete variable with description and value <Value>' -TestCases @(
@{ Value = 1; Expected = '[int]$VariableWithDescription - Variable description' }
@{ Value = 'string'; Expected = '[string]$VariableWithDescription - Variable description' }
@{ Value = $null; Expected = 'VariableWithDescription - Variable description' }
) {
param ($Value, $Expected)

New-Variable -Name VariableWithDescription -Value $Value -Description 'Variable description' -Force
$res = TabExpansion2 -inputScript '$VariableWithDescription'
$res.CompletionMatches.Count | Should -Be 1
$res.CompletionMatches[0].CompletionText | Should -BeExactly '$VariableWithDescription'
$res.CompletionMatches[0].ToolTip | Should -BeExactly $Expected
}

It 'Should complete scoped variable with description and value <Value>' -TestCases @(
@{ Value = 1; Expected = '[int]$VariableWithDescription - Variable description' }
@{ Value = 'string'; Expected = '[string]$VariableWithDescription - Variable description' }
@{ Value = $null; Expected = 'VariableWithDescription - Variable description' }
) {
param ($Value, $Expected)

New-Variable -Name VariableWithDescription -Value $Value -Description 'Variable description' -Force
$res = TabExpansion2 -inputScript '$local:VariableWithDescription'
$res.CompletionMatches.Count | Should -Be 1
$res.CompletionMatches[0].CompletionText | Should -BeExactly '$local:VariableWithDescription'
$res.CompletionMatches[0].ToolTip | Should -BeExactly $Expected
}

It 'Should not complete property name in class definition' {
$res = TabExpansion2 -inputScript 'class X {$P'
Expand Down
Loading