Skip to content

Improve [Validate] codefixer behavior #309

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
viceroypenguin merged 4 commits into from
Aug 12, 2026
Merged

Improve [Validate] codefixer behavior #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
172d974
Improve `[Validate]` codefixer behavior
viceroypenguin Aug 12, 2026
4a315b7
Verify and fix codefixer works with other existing attributes
viceroypenguin Aug 12, 2026
34045b1
Fix line-endings
viceroypenguin Aug 12, 2026
77fbc4d
Limit formatting to new syntax node
viceroypenguin Aug 12, 2026
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
75 changes: 61 additions & 14 deletions src/Immediate.Validations.CodeFixes/AddValidateAttributeCodefixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeActions;
using Microsoft.CodeAnalysis.CodeFixes;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Formatting;
using Microsoft.CodeAnalysis.Simplification;
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;

namespace Immediate.Validations.CodeFixes;
Expand All @@ -30,26 +33,70 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
context.RegisterCodeFix(
CodeAction.Create(
"Add `[Validate]`",
createChangedDocument: _ =>
AddValidateAttribute(context.Document, root, typeDeclaration),
createChangedDocument: token =>
AddValidateAttribute(context.Document, root, typeDeclaration, token),
equivalenceKey: nameof(AddValidateAttributeCodefixProvider)
),
diagnostic
);
}

private static Task<Document> AddValidateAttribute(Document document, CompilationUnitSyntax root, TypeDeclarationSyntax typeDeclaration)
private static async Task<Document> AddValidateAttribute(Document document, CompilationUnitSyntax root, TypeDeclarationSyntax typeDeclaration, CancellationToken token)
{
var newDecl = typeDeclaration
.WithAttributeLists(
typeDeclaration.AttributeLists
.Add(AttributeList(
SingletonSeparatedList(
Attribute(
IdentifierName("Validate"))))));

var newRoot = root.ReplaceNode(typeDeclaration, newDecl);
var newDocument = document.WithSyntaxRoot(newRoot);
return Task.FromResult(newDocument);
var model = await document.GetSemanticModelAsync(token);

var validateSymbol = model?.Compilation
.GetTypeByMetadataName("Immediate.Validations.Shared.ValidateAttribute")!;

var referenceId = DocumentationCommentId.CreateReferenceId(validateSymbol);
var annotation = new SyntaxAnnotation("SymbolId", referenceId);

var newLineSyntax = typeDeclaration.DescendantTrivia()
.FirstOrDefault(t => t.IsKind(SyntaxKind.EndOfLineTrivia));

if (newLineSyntax == default)
newLineSyntax = ElasticLineFeed;

var validateAttribute = AttributeList(
SingletonSeparatedList(
Attribute(
IdentifierName("Validate")
)
)
)
.WithAdditionalAnnotations(Simplifier.AddImportsAnnotation, annotation)
.WithTrailingTrivia(newLineSyntax);

var newDecl = typeDeclaration.AttributeLists switch
{
[] =>
typeDeclaration
.WithoutLeadingTrivia()
.WithAttributeLists(
typeDeclaration.AttributeLists
.Add(
validateAttribute
.WithLeadingTrivia(typeDeclaration.GetLeadingTrivia())
.WithAdditionalAnnotations(Formatter.Annotation)
)
),

_ =>
typeDeclaration
.WithAttributeLists(
typeDeclaration.AttributeLists
.Add(
validateAttribute
.WithAdditionalAnnotations(Formatter.Annotation)
)
),
};

var newRoot = root.ReplaceNode(
typeDeclaration,
newDecl
);

return document.WithSyntaxRoot(newRoot);
}
}
114 changes: 114 additions & 0 deletions tests/Immediate.Validations.Tests/CodeFixTests/AddValidateAttributeCodefixProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,81 @@ public sealed class AddValidateAttributeCodefixProviderTests
{
[Fact]
public async Task AddValidateAttribute() =>
await CodeFixTestHelper.CreateCodeFixTest<ValidateClassAnalyzer, AddValidateAttributeCodefixProvider>(
"""
namespace Immediate.Validations.Testing;

public sealed record {|IV0012:Data|} : Immediate.Validations.Shared.IValidationTarget<Data>
{
public Immediate.Validations.Shared.ValidationResult Validate() => [];
public Immediate.Validations.Shared.ValidationResult Validate(Immediate.Validations.Shared.ValidationResult errors) => [];
public static Immediate.Validations.Shared.ValidationResult Validate(Data target) => [];
public static Immediate.Validations.Shared.ValidationResult Validate(Data target, Immediate.Validations.Shared.ValidationResult errors) => [];
}
""",
"""
using Immediate.Validations.Shared;

namespace Immediate.Validations.Testing;

[Validate]
public sealed record Data : Immediate.Validations.Shared.IValidationTarget<Data>
{
public Immediate.Validations.Shared.ValidationResult Validate() => [];
public Immediate.Validations.Shared.ValidationResult Validate(Immediate.Validations.Shared.ValidationResult errors) => [];
public static Immediate.Validations.Shared.ValidationResult Validate(Data target) => [];
public static Immediate.Validations.Shared.ValidationResult Validate(Data target, Immediate.Validations.Shared.ValidationResult errors) => [];
}
"""
).RunAsync(TestContext.Current.CancellationToken);

[Fact]
public async Task AddValidateAttributeWorksCorrectlyWithOtherAttributes() =>
await CodeFixTestHelper.CreateCodeFixTest<ValidateClassAnalyzer, AddValidateAttributeCodefixProvider>(
"""
using System;

namespace Immediate.Validations.Shared;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface)]
public sealed class MyStuffAttribute : Attribute;

[MyStuff]
public sealed record {|IV0012:Data|} : IValidationTarget<Data>
{
public ValidationResult Validate() => [];
public ValidationResult Validate(ValidationResult errors) => [];
public static ValidationResult Validate(Data target) => [];
public static ValidationResult Validate(Data target, ValidationResult errors) => [];
}
""",
"""
using System;

namespace Immediate.Validations.Shared;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface)]
public sealed class MyStuffAttribute : Attribute;

[MyStuff]
[Validate]
public sealed record {|IV0012:Data|} : IValidationTarget<Data>
{
public ValidationResult Validate() => [];
public ValidationResult Validate(ValidationResult errors) => [];
public static ValidationResult Validate(Data target) => [];
public static ValidationResult Validate(Data target, ValidationResult errors) => [];
}
"""
).RunAsync(TestContext.Current.CancellationToken);

[Fact]
public async Task AddValidateAttributeWorksCorrectlyWithXmlDocs() =>
await CodeFixTestHelper.CreateCodeFixTest<ValidateClassAnalyzer, AddValidateAttributeCodefixProvider>(
"""
namespace Immediate.Validations.Shared;

/// <summary>documentation</summary>
public sealed record {|IV0012:Data|} : IValidationTarget<Data>
{
public ValidationResult Validate() => [];
Expand All @@ -22,6 +93,7 @@ public sealed record {|IV0012:Data|} : IValidationTarget<Data>
"""
namespace Immediate.Validations.Shared;

/// <summary>documentation</summary>
[Validate]
public sealed record Data : IValidationTarget<Data>
{
Expand All @@ -32,4 +104,46 @@ public sealed record Data : IValidationTarget<Data>
}
"""
).RunAsync(TestContext.Current.CancellationToken);

[Fact]
public async Task AddValidateAttributeWorksCorrectlyWithXmlDocsAndOtherAttributes() =>
await CodeFixTestHelper.CreateCodeFixTest<ValidateClassAnalyzer, AddValidateAttributeCodefixProvider>(
"""
using System;

namespace Immediate.Validations.Shared;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface)]
public sealed class MyStuffAttribute : Attribute;

/// <summary>documentation</summary>
[MyStuff]
public sealed record {|IV0012:Data|} : IValidationTarget<Data>
{
public ValidationResult Validate() => [];
public ValidationResult Validate(ValidationResult errors) => [];
public static ValidationResult Validate(Data target) => [];
public static ValidationResult Validate(Data target, ValidationResult errors) => [];
}
""",
"""
using System;

namespace Immediate.Validations.Shared;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface)]
public sealed class MyStuffAttribute : Attribute;

/// <summary>documentation</summary>
[MyStuff]
[Validate]
public sealed record {|IV0012:Data|} : IValidationTarget<Data>
{
public ValidationResult Validate() => [];
public ValidationResult Validate(ValidationResult errors) => [];
public static ValidationResult Validate(Data target) => [];
public static ValidationResult Validate(Data target, ValidationResult errors) => [];
}
"""
).RunAsync(TestContext.Current.CancellationToken);
}