Skip to content

Better handle attribute snippet completion in components #12281

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
ToddGrun merged 3 commits into from
Oct 6, 2025
Merged

Better handle attribute snippet completion in components #12281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cff3d34
1) Clean up some formatting
ToddGrun Sep 29, 2025
57bbc4c
1) Switch to using IA instead of HashSet for building up entries
ToddGrun Sep 29, 2025
b839f4f
1) Pass inSnippetContext down to code creating completion, and use it…
ToddGrun Sep 29, 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
143 changes: 87 additions & 56 deletions ...soft.CodeAnalysis.Razor.Workspaces/Completion/DirectiveAttributeCompletionItemProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ internal class DirectiveAttributeCompletionItemProvider : DirectiveAttributeComp
private static ReadOnlyMemory<char> QuotedAttributeValueSnippet => "=\"$0\"".AsMemory();
private static ReadOnlyMemory<char> UnquotedAttributeValueSnippet => "=$0".AsMemory();

private static readonly ImmutableArray<RazorCommitCharacter> EqualsCommitCharacters = [new("=")];
private static readonly ImmutableArray<RazorCommitCharacter> EqualsAndColonCommitCharacters = [new("="), new(":")];
private static readonly ImmutableArray<RazorCommitCharacter> SnippetEqualsCommitCharacters = [new("=", Insert: false)];
private static readonly ImmutableArray<RazorCommitCharacter> SnippetEqualsAndColonCommitCharacters = [new("=", Insert: false), new(":")];

public override ImmutableArray<RazorCompletionItem> GetCompletionItems(RazorCompletionContext context)
{
if (!context.SyntaxTree.Options.FileKind.IsComponent())
Expand Down Expand Up @@ -83,7 +88,8 @@ internal static ImmutableArray<RazorCompletionItem> GetAttributeCompletions(
}

// Use ordinal dictionary because attributes are case sensitive when matching
using var _ = StringDictionaryPool<(HashSet<BoundAttributeDescriptionInfo>, HashSet<string>)>.Ordinal.GetPooledObject(out var attributeCompletions);
using var _ = StringDictionaryPool<(ImmutableArray<BoundAttributeDescriptionInfo>, ImmutableArray<RazorCommitCharacter>)>.Ordinal.GetPooledObject(out var attributeCompletions);
var inSnippetContext = InSnippetContext(containingAttribute, razorCompletionOptions);

foreach (var descriptor in descriptorsForTag)
{
Expand All @@ -95,7 +101,7 @@ internal static ImmutableArray<RazorCompletionItem> GetAttributeCompletions(
continue;
}

if (!TryAddCompletion(attributeDescriptor.Name, attributeDescriptor, descriptor, razorCompletionOptions) && attributeDescriptor.Parameters.Length > 0)
if (!TryAddCompletion(attributeDescriptor.Name, attributeDescriptor, descriptor, razorCompletionOptions, selectedAttributeName, attributes, inSnippetContext, attributeCompletions) && attributeDescriptor.Parameters.Length > 0)
{
// This attribute has parameters and the base attribute name (@bind) is already satisfied. We need to check if there are any valid
// parameters left to be provided, if so, we need to still represent the base attribute name in the completion list.
Expand All @@ -105,15 +111,15 @@ internal static ImmutableArray<RazorCompletionItem> GetAttributeCompletions(
if (!attributes.Any(name => TagHelperMatchingConventions.SatisfiesBoundAttributeWithParameter(parameterDescriptor, name, attributeDescriptor)))
{
// This bound attribute parameter has not had a completion entry added for it, re-represent the base attribute name in the completion list
AddCompletion(attributeDescriptor.Name, attributeDescriptor, descriptor, razorCompletionOptions);
AddCompletion(attributeDescriptor.Name, attributeDescriptor, descriptor, razorCompletionOptions, inSnippetContext, attributeCompletions);
break;
}
}
}

if (!attributeDescriptor.IndexerNamePrefix.IsNullOrEmpty())
{
TryAddCompletion(attributeDescriptor.IndexerNamePrefix + "...", attributeDescriptor, descriptor, razorCompletionOptions);
TryAddCompletion(attributeDescriptor.IndexerNamePrefix + "...", attributeDescriptor, descriptor, razorCompletionOptions, selectedAttributeName, attributes, inSnippetContext, attributeCompletions);
}
}
}
Expand Down Expand Up @@ -142,62 +148,62 @@ internal static ImmutableArray<RazorCompletionItem> GetAttributeCompletions(
else
{
// We are trying for snippet text only for non-indexer attributes, e.g. *not* something like "@bind-..."
if (TryGetSnippetText(containingAttribute, insertTextSpan, razorCompletionOptions, out var snippetTextSpan))
if (inSnippetContext)
{
insertTextSpan = snippetTextSpan;
GetSnippetText(insertTextSpan, razorCompletionOptions, out insertTextSpan);
isSnippet = true;
}
}

// Don't create another string annecessarily, even thouth ReadOnlySpan.ToString() special-cases the string to avoid allocation
// Don't create another string unnecessarily, even though ReadOnlySpan.ToString() special-cases the string to avoid allocation
var insertText = insertTextSpan == originalInsertTextSpan ? displayText : insertTextSpan.ToString();

using var razorCommitCharacters = new PooledArrayBuilder<RazorCommitCharacter>(capacity: commitCharacters.Count);

foreach (var c in commitCharacters)
{
razorCommitCharacters.Add(new(c));
}

var razorCompletionItem = RazorCompletionItem.CreateDirectiveAttribute(
displayText,
insertText,
descriptionInfo: new([.. attributeDescriptions]),
commitCharacters: razorCommitCharacters.ToImmutableAndClear(),
descriptionInfo: new(attributeDescriptions),
commitCharacters,
isSnippet);

completionItems.Add(razorCompletionItem);
}

return completionItems.ToImmutableAndClear();

static bool TryGetSnippetText(
static bool InSnippetContext(
RazorSyntaxNode owner,
ReadOnlySpan<char> baseTextSpan,
RazorCompletionOptions razorCompletionOptions,
out ReadOnlySpan<char> snippetTextSpan)
RazorCompletionOptions razorCompletionOptions)
{
if (razorCompletionOptions.SnippetsSupported
return razorCompletionOptions.SnippetsSupported
// Don't create snippet text when attribute is already in the tag and we are trying to replace it
// Otherwise you could have something like @onabort=""=""
&& owner is not (MarkupTagHelperDirectiveAttributeSyntax or MarkupAttributeBlockSyntax)
&& owner.Parent is not (MarkupTagHelperDirectiveAttributeSyntax or MarkupAttributeBlockSyntax))
{
var suffixTextSpan = razorCompletionOptions.AutoInsertAttributeQuotes ? QuotedAttributeValueSnippet : UnquotedAttributeValueSnippet;
&& owner.Parent is not (MarkupTagHelperDirectiveAttributeSyntax or MarkupAttributeBlockSyntax);
}

var buffer = new char[baseTextSpan.Length + suffixTextSpan.Length];
baseTextSpan.CopyTo(buffer);
suffixTextSpan.CopyTo(buffer.AsMemory()[baseTextSpan.Length..]);
static void GetSnippetText(
ReadOnlySpan<char> baseTextSpan,
RazorCompletionOptions razorCompletionOptions,
out ReadOnlySpan<char> snippetTextSpan)
{
var suffixTextSpan = razorCompletionOptions.AutoInsertAttributeQuotes ? QuotedAttributeValueSnippet : UnquotedAttributeValueSnippet;

snippetTextSpan = buffer.AsSpan();
return true;
}
var buffer = new char[baseTextSpan.Length + suffixTextSpan.Length];
baseTextSpan.CopyTo(buffer);
suffixTextSpan.CopyTo(buffer.AsMemory()[baseTextSpan.Length..]);

snippetTextSpan = [];
return false;
snippetTextSpan = buffer.AsSpan();
}

bool TryAddCompletion(string attributeName, BoundAttributeDescriptor boundAttributeDescriptor, TagHelperDescriptor tagHelperDescriptor, RazorCompletionOptions razorCompletionOptions)
static bool TryAddCompletion(
string attributeName,
BoundAttributeDescriptor boundAttributeDescriptor,
TagHelperDescriptor tagHelperDescriptor,
RazorCompletionOptions razorCompletionOptions,
string selectedAttributeName,
ImmutableArray<string> attributes,
bool inSnippetContext,
Dictionary<string, (ImmutableArray<BoundAttributeDescriptionInfo>, ImmutableArray<RazorCommitCharacter>)> attributeCompletions)
{
if (selectedAttributeName != attributeName &&
attributes.Any(attributeName, static (name, attributeName) => name == attributeName))
Expand All @@ -207,60 +213,85 @@ bool TryAddCompletion(string attributeName, BoundAttributeDescriptor boundAttrib
return false;
}

AddCompletion(attributeName, boundAttributeDescriptor, tagHelperDescriptor, razorCompletionOptions);
AddCompletion(attributeName, boundAttributeDescriptor, tagHelperDescriptor, razorCompletionOptions, inSnippetContext, attributeCompletions);
return true;
}

void AddCompletion(string attributeName, BoundAttributeDescriptor boundAttributeDescriptor, TagHelperDescriptor tagHelperDescriptor, RazorCompletionOptions razorCompletionOptions)
static void AddCompletion(
string attributeName,
BoundAttributeDescriptor boundAttributeDescriptor,
TagHelperDescriptor tagHelperDescriptor,
RazorCompletionOptions razorCompletionOptions,
bool inSnippetContext,
Dictionary<string, (ImmutableArray<BoundAttributeDescriptionInfo>, ImmutableArray<RazorCommitCharacter>)> attributeCompletions)
{
if (!attributeCompletions.TryGetValue(attributeName, out var attributeDetails))
{
attributeDetails = ([], []);
attributeCompletions[attributeName] = attributeDetails;
}

(var attributeDescriptions, var commitCharacters) = attributeDetails;

var indexerCompletion = attributeName.EndsWith("...", StringComparison.Ordinal);
var tagHelperTypeName = tagHelperDescriptor.TypeName;
var descriptionInfo = BoundAttributeDescriptionInfo.From(boundAttributeDescriptor, isIndexer: indexerCompletion, tagHelperTypeName);
attributeDescriptions.Add(descriptionInfo);

if (indexerCompletion)
if (!attributeDescriptions.Contains(descriptionInfo))
{
// Indexer attribute, we don't want to commit with standard chars
return;
attributeDescriptions = attributeDescriptions.Add(descriptionInfo);
}

if (!razorCompletionOptions.UseVsCodeCompletionCommitCharacters)
// Verify not an indexer attribute, as those don't commit with standard chars
if (!indexerCompletion)
{
// We don't add "=" as a commit character when using VSCode trigger characters.
commitCharacters.Add("=");
}
var equalsAdded = commitCharacters.Any(static c => c.Character == "=");
var spaceAdded = commitCharacters.Any(static c => c.Character == " ");
var colonAdded = commitCharacters.Any(static c => c.Character == ":");

var spaceAdded = commitCharacters.Contains(" ");
var colonAdded = commitCharacters.Contains(":");
// We don't add "=" as a commit character when using VSCode trigger characters.
equalsAdded |= !razorCompletionOptions.UseVsCodeCompletionCommitCharacters;

if (!spaceAdded || !colonAdded)
{
foreach (var boundAttribute in tagHelperDescriptor.BoundAttributes)
{
if (!spaceAdded && boundAttribute.IsBooleanProperty)
spaceAdded |= boundAttribute.IsBooleanProperty;
colonAdded |= boundAttribute.Parameters.Length > 0;

if (spaceAdded && colonAdded)
{
break;
}
}

// Determine if we have a common commit character set
commitCharacters = (equalsAdded, spaceAdded, colonAdded, inSnippetContext) switch
{
(true, false, false, false) => EqualsCommitCharacters,
(true, false, true, false) => EqualsAndColonCommitCharacters,
(true, false, false, true) => SnippetEqualsCommitCharacters,
(true, false, true, true) => SnippetEqualsAndColonCommitCharacters,
_ => []
};

if (commitCharacters.IsEmpty)
{
if (equalsAdded)
{
commitCharacters.Add(" ");
spaceAdded = true;
commitCharacters = commitCharacters.Add(new("=", Insert: !inSnippetContext));
}
else if (!colonAdded && boundAttribute.Parameters.Length > 0)

if (spaceAdded)
{
commitCharacters.Add(":");
colonAdded = true;
commitCharacters = commitCharacters.Add(new(" "));
}
else if (spaceAdded && colonAdded)

if (colonAdded)
{
break;
commitCharacters = commitCharacters.Add(new(":"));
}
}
}

attributeCompletions[attributeName] = (attributeDescriptions, commitCharacters);
}
}
}
26 changes: 25 additions & 1 deletion ...Analysis.Razor.Workspaces.Test/Completion/DirectiveAttributeCompletionItemProviderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,19 @@ public void GetAttributeCompletions_NonIndexer_ReturnsCompletion()
AssertContains(completions, "bind=\"$0\"", "@bind", ["=", ":"]);
}

[Fact]
public void GetAttributeCompletions_NonIndexer_ReturnsCompletionWithEqualsCommitInsertFalse()
{
// Arrange
var owner = GetOwner("<input @$$></input>");

// Act
var completions = DirectiveAttributeCompletionItemProvider.GetAttributeCompletions(owner, "@", "input", [], _defaultTagHelperContext, _defaultRazorCompletionOptions);

// Assert
AssertContains(completions, "bind=\"$0\"", "@bind", [new RazorCommitCharacter("=", Insert: false), new RazorCommitCharacter(":")]);
}

[Fact]
public void GetAttributeCompletions_WithNoAutoQuotesOption_ReturnsNonQuotedSnippet()
{
Expand Down Expand Up @@ -271,7 +284,7 @@ public void GetAttributeCompletions_Indexer_ReturnsCompletion()
var completions = DirectiveAttributeCompletionItemProvider.GetAttributeCompletions(owner, "@", "input", [], _defaultTagHelperContext, _defaultRazorCompletionOptions);

// Assert
AssertContains(completions, "bind-", "@bind-...", []);
AssertContains(completions, "bind-", "@bind-...", ImmutableArray<string>.Empty);
}

[Fact]
Expand Down Expand Up @@ -321,6 +334,17 @@ private static void AssertContains(ImmutableArray<RazorCompletionItem> completio
RazorCompletionItemKind.DirectiveAttribute == completion.Kind);
}

private static void AssertContains(ImmutableArray<RazorCompletionItem> completions, string insertText, string displayText, ImmutableArray<RazorCommitCharacter> commitCharacters)
{
displayText ??= insertText;

Assert.Contains(completions, completion =>
insertText == completion.InsertText &&
displayText == completion.DisplayText &&
commitCharacters.SequenceEqual(completion.CommitCharacters) &&
RazorCompletionItemKind.DirectiveAttribute == completion.Kind);
}

private static void AssertDoesNotContain(IReadOnlyList<RazorCompletionItem> completions, string insertText, string displayText)
{
displayText ??= insertText;
Expand Down