Member tab completion fails to quote member names not directly acceptable

Continuing my investigation of tab completion quoting/escaping failures:

Steps to reproduce

$a = @{ '3hello' = 'a'}

$a.<TAB> # select `3hello` property from list, then execute.

Expected behavior

the finished completion to be:

$a.'3hello'

Actual behavior

$a.3hello

Which causes an error 'missing property name'.

Environment data

Name                           Value
----                           -----
PSVersion                      6.2.2
PSEdition                      Core
GitCommitId                    6.2.2
OS                             Microsoft Windows 10.0.18941
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Additionally

Tab completion after $a.' switches to file name completion.

The code that handles this appears to be at:

PowerShell/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

Lines 6586 to 6591 in 48c7e11

    
           // Handle scenarios like this: $aa | add-member 'a b' 23; $aa.a<tab> 
        
           if (completionText.IndexOfAny(s_charactersRequiringQuotes) != -1) 
        
           { 
        
               completionText = completionText.Replace("'", "''"); 
        
               completionText = "'" + completionText + "'"; 
        
           }

The field s_charactersRequiringQuotes is used mostly for variable name checks, but is also inadequate for that purpose (see #10006), but fails here because it doesn't handle the condition of numeric digits in the first character require quoting.

PowerShell/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

Lines 4565 to 4567 in 48c7e11

    
           private static readonly char[] s_charactersRequiringQuotes = new char[] { 
        
               '-', '`', '&', '@', '\'', '"', '#', '{', '}', '(', ')', '$', ',', ';', '|', '<', '>', ' ', '.', '\\', '/', '\t', '^', 
        
           };

In PowerShell code, I would use REGEX: ^[\p{L}_][\w]*$. If this regex fails on a non-empty name, the property name must be quoted. However there is probably a quicker method in C# using the [CharExtensions] class using IsIdentifierStart() (first character) and IsIdentifierFollow() (subsequent characters), and quote the property if the response is FALSE.

I have a start to a PR for this issue. I've created a new member of CodeGeneration to check for and quote member names when they need it.

Use QuoteMemberName to fix PowerShell#10198

Utilize QuoteMemberName codegenerator

This issue has not had any activity in 6 months, if this is a bug please try to reproduce on the latest version of PowerShell and reopen a new issue and reference this issue if this is still a blocker for you.

This issue has been marked as "No Activity" as there has been no activity for 6 months. It has been closed for housekeeping purposes.

Navigation Menu

Repository navigation

Member tab completion fails to quote member names not directly acceptable #10198

Steps to reproduce

Expected behavior

Actual behavior

Environment data

Additionally

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	// Handle scenarios like this: $aa \| add-member 'a b' 23; $aa.a<tab>
	if (completionText.IndexOfAny(s_charactersRequiringQuotes) != -1)
	{
	completionText = completionText.Replace("'", "''");
	completionText = "'" + completionText + "'";
	}

	private static readonly char[] s_charactersRequiringQuotes = new char[] {
	'-', '`', '&', '@', '\'', '"', '#', '{', '}', '(', ')', '$', ',', ';', '\|', '<', '>', ' ', '.', '\\', '/', '\t', '^',
	};

Member tab completion fails to quote member names not directly acceptable #10198

Description

Steps to reproduce

Expected behavior

Actual behavior

Environment data

Additionally

Activity

msftrncs commented on Jul 22, 2019

microsoft-github-policy-service commented on Nov 16, 2023

microsoft-github-policy-service commented on Nov 16, 2023

microsoft-github-policy-service commented on Nov 16, 2023

microsoft-github-policy-service commented on Nov 23, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions