Skip to content
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

Jump to bottom

Use SyntaxGenerator and leave trivia handling up to it #590

Merged
merged 2 commits into from
Jan 28, 2023
Merged

Use SyntaxGenerator and leave trivia handling up to it #590

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cdf53b
Use SyntaxGenerator and leave trivia handling up to it
Youssef1313 Jan 28, 2023
e1c9bcf
Remove unused parameter
Youssef1313 Jan 28, 2023
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
42 changes: 8 additions & 34 deletions src/CommunityToolkit.Mvvm.CodeFixers/ClassUsingAttributeInsteadOfInheritanceCodeFixer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
using Microsoft.CodeAnalysis.CodeActions;
using Microsoft.CodeAnalysis.CodeFixes;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Editing;
using Microsoft.CodeAnalysis.Text;
using static CommunityToolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
Expand Down Expand Up @@ -63,7 +64,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
context.RegisterCodeFix(
CodeAction.Create(
title: "Inherit from ObservableObject",
createChangedDocument: token => UpdateReference(context.Document, classDeclaration, attributeTypeName, token),
createChangedDocument: token => UpdateReference(context.Document, root, classDeclaration, attributeTypeName),
equivalenceKey: "Inherit from ObservableObject"),
diagnostic);

Expand All @@ -76,21 +77,16 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
/// Applies the code fix to a target class declaration and returns an updated document.
/// </summary>
/// <param name="document">The original document being fixed.</param>
/// <param name="root">The original tree root belonging to the current document.</param>
/// <param name="classDeclaration">The <see cref="ClassDeclarationSyntax"/> to update.</param>
/// <param name="attributeTypeName">The name of the attribute that should be removed.</param>
/// <param name="cancellationToken">The cancellation token for the operation.</param>
/// <returns>An updated document with the applied code fix, and <paramref name="classDeclaration"/> inheriting from <c>ObservableObject</c>.</returns>
private static async Task<Document> UpdateReference(Document document, ClassDeclarationSyntax classDeclaration, string attributeTypeName, CancellationToken cancellationToken)
private static Task<Document> UpdateReference(Document document, SyntaxNode root, ClassDeclarationSyntax classDeclaration, string attributeTypeName)
{
// Insert ObservableObject always in first position in the base list. The type might have
// some interfaces in the base list, so we just copy them back after ObservableObject.
ClassDeclarationSyntax updatedClassDeclaration =
classDeclaration.WithBaseList(BaseList(SingletonSeparatedList(
(BaseTypeSyntax)SimpleBaseType(IdentifierName("ObservableObject"))))
.AddTypes(classDeclaration.BaseList?.Types.ToArray() ?? Array.Empty<BaseTypeSyntax>()));

AttributeListSyntax? targetAttributeList = null;
AttributeSyntax? targetAttribute = null;
SyntaxGenerator generator = SyntaxGenerator.GetGenerator(document);
ClassDeclarationSyntax updatedClassDeclaration = (ClassDeclarationSyntax)generator.AddBaseType(classDeclaration, IdentifierName("ObservableObject"));
Sergio0694 marked this conversation as resolved.
Show resolved Hide resolved

// Find the attribute list and attribute to remove
foreach (AttributeListSyntax attributeList in updatedClassDeclaration.AttributeLists)
Expand All @@ -101,35 +97,13 @@ private static async Task<Document> UpdateReference(Document document, ClassDecl
(identifierName == attributeTypeName || (identifierName + "Attribute") == attributeTypeName))
{
// We found the attribute to remove and the list to update
targetAttributeList = attributeList;
targetAttribute = attribute;
updatedClassDeclaration = (ClassDeclarationSyntax)generator.RemoveNode(updatedClassDeclaration, attribute);
Sergio0694 marked this conversation as resolved.
Show resolved Hide resolved

break;
}
}
}

// If we found an attribute to remove, do that
if (targetAttribute is not null)
{
// If the target list has more than one attribute, keep it and just remove the target one
if (targetAttributeList!.Attributes.Count > 1)
{
updatedClassDeclaration =
updatedClassDeclaration.ReplaceNode(
targetAttributeList,
targetAttributeList.RemoveNode(targetAttribute, SyntaxRemoveOptions.KeepNoTrivia)!);
}
else
{
// Otherwise, remove the entire attribute list
updatedClassDeclaration = updatedClassDeclaration.RemoveNode(targetAttributeList, SyntaxRemoveOptions.KeepExteriorTrivia)!;
}
}

SyntaxNode originalRoot = await classDeclaration.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false);
SyntaxTree updatedTree = originalRoot.ReplaceNode(classDeclaration, updatedClassDeclaration).SyntaxTree;

return document.WithSyntaxRoot(await updatedTree.GetRootAsync(cancellationToken).ConfigureAwait(false));
return Task.FromResult(document.WithSyntaxRoot(root.ReplaceNode(classDeclaration, updatedClassDeclaration)));
}
}