Skip to content

Improve hashtable completion #16498

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
daxian-dbw merged 14 commits into from
Mar 4, 2022
Merged

Improve hashtable completion #16498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6276e7f
Fix some hashtable completion issues. Prevent completion of keys alre…
MartinGC94 Nov 21, 2021
4012271
Remove some leading space
MartinGC94 Nov 21, 2021
8a54574
Skip Get-WinEvent test on non-Windows platforms
MartinGC94 Nov 21, 2021
e6ab314
Add missing test and additional details to the Cim method parameter t…
MartinGC94 Nov 23, 2021
a4807c4
Add completion for hashtables used for splatting and the Property par…
MartinGC94 Dec 5, 2021
dd059fe
Apply suggestions from code review
MartinGC94 Dec 6, 2021
cb71343
Add comments, move test and replace alias with the proper command nam…
MartinGC94 Dec 6, 2021
f7911d0
Add empty line before return statement.
MartinGC94 Dec 6, 2021
4c332e2
Apply suggestions from code review
MartinGC94 Jan 3, 2022
848a1d4
Maybe fix merge conflict?
MartinGC94 Feb 16, 2022
c65d3b5
Merge branch 'master' into ImprovedHashtableCompletion
MartinGC94 Feb 16, 2022
4abd93c
Apply suggestions from code review
MartinGC94 Mar 1, 2022
5c7be2d
Apply changes suggested by daxian-dbw
MartinGC94 Mar 1, 2022
6ff02f5
Break up the code a little to avoid CodeFactor issues
daxian-dbw Mar 1, 2022
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
81 changes: 42 additions & 39 deletions src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,6 +928,12 @@ internal List<CompletionResult> GetResultHelper(CompletionContext completionCont
if (result == null || result.Count == 0)
{
result = GetResultForHashtable(completionContext);
// Handles the following scenario: [ipaddress]@{Address=""; <Tab> }
if (result?.Count > 0)
{
replacementIndex = completionContext.CursorPosition.Offset;
replacementLength = 0;
}
}

if (result == null || result.Count == 0)
Expand All @@ -950,59 +956,56 @@ internal List<CompletionResult> GetResultHelper(CompletionContext completionCont
// Helper method to auto complete hashtable key
private static List<CompletionResult> GetResultForHashtable(CompletionContext completionContext)
{
var lastAst = completionContext.RelatedAsts.Last();
HashtableAst tempHashtableAst = null;
IScriptPosition cursor = completionContext.CursorPosition;
var hashTableAst = lastAst as HashtableAst;
if (hashTableAst != null)
Ast lastRelatedAst = null;
var cursorPosition = completionContext.CursorPosition;

// Enumeration is used over the LastAst pattern because empty lines following a key-value pair will set LastAst to the value.
// Example:
// @{
// Key1="Value1"
// <Tab>
// }
// In this case the last 3 Asts will be StringConstantExpression, CommandExpression, and Pipeline instead of the expected Hashtable
for (int i = completionContext.RelatedAsts.Count - 1; i >= 0; i--)
{
Ast ast = completionContext.RelatedAsts[i];
if (cursorPosition.Offset >= ast.Extent.StartOffset && cursorPosition.Offset <= ast.Extent.EndOffset)
{
lastRelatedAst = ast;
break;
}
}

if (lastRelatedAst is HashtableAst hashtableAst)
{
// Check if the cursor within the hashtable
if (cursor.Offset < hashTableAst.Extent.EndOffset)
// Cursor is just after the hashtable: @{}<Tab>
if (completionContext.TokenAtCursor is not null && completionContext.TokenAtCursor.Kind == TokenKind.RCurly)
{
tempHashtableAst = hashTableAst;
return null;
}
else if (cursor.Offset == hashTableAst.Extent.EndOffset)

bool cursorIsWithinOrOnSameLineAsKeypair = false;
foreach (var pair in hashtableAst.KeyValuePairs)
{
// Exclude the scenario that cursor at the end of hashtable, i.e. after '}'
if (completionContext.TokenAtCursor == null ||
completionContext.TokenAtCursor.Kind != TokenKind.RCurly)
if (cursorPosition.Offset >= pair.Item1.Extent.StartOffset
&& (cursorPosition.Offset <= pair.Item2.Extent.EndOffset || cursorPosition.LineNumber == pair.Item2.Extent.EndLineNumber))
{
tempHashtableAst = hashTableAst;
cursorIsWithinOrOnSameLineAsKeypair = true;
break;
}
}
}
else
{
// Handle property completion on a blank line for DynamicKeyword statement
Ast lastChildofHashtableAst;
hashTableAst = Ast.GetAncestorHashtableAst(lastAst, out lastChildofHashtableAst);

// Check if the hashtable within a DynamicKeyword statement
if (hashTableAst != null)
if (cursorIsWithinOrOnSameLineAsKeypair)
{
var keywordAst = Ast.GetAncestorAst<DynamicKeywordStatementAst>(hashTableAst);
if (keywordAst != null)
var tokenBeforeOrAtCursor = completionContext.TokenBeforeCursor ?? completionContext.TokenAtCursor;
if (tokenBeforeOrAtCursor.Kind != TokenKind.Semi)
{
// Handle only empty line
if (string.IsNullOrWhiteSpace(cursor.Line))
{
// Check if the cursor outside of last child of hashtable and within the hashtable
if (cursor.Offset > lastChildofHashtableAst.Extent.EndOffset &&
cursor.Offset <= hashTableAst.Extent.EndOffset)
{
tempHashtableAst = hashTableAst;
}
}
return null;
}
}
}

hashTableAst = tempHashtableAst;
if (hashTableAst != null)
{
completionContext.ReplacementIndex = completionContext.CursorPosition.Offset;
completionContext.ReplacementLength = 0;
return CompletionCompleters.CompleteHashtableKey(completionContext, hashTableAst);
return CompletionCompleters.CompleteHashtableKey(completionContext, hashtableAst);
}

return null;
Expand Down
Loading