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

Pass options to FixAllAsync, simplify CodeAction registration #60665

Merged
merged 2 commits into from
Apr 10, 2022
Merged

Pass options to FixAllAsync, simplify CodeAction registration #60665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4282ca1
Pass options to FixAllAsync, simplify fix registration
tmat Apr 9, 2022
d1f4fd9
Fix formatting
tmat Apr 9, 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
10 changes: 2 additions & 8 deletions src/Analyzers/CSharp/CodeFixes/AddBraces/CSharpAddBracesCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,13 @@ public override ImmutableArray<string> FixableDiagnosticIds

public sealed override Task RegisterCodeFixesAsync(CodeFixContext context)
{
context.RegisterCodeFix(
CodeAction.Create(
CSharpAnalyzersResources.Add_braces,
c => FixAsync(context.Document, context.Diagnostics.First(), c),
nameof(CSharpAnalyzersResources.Add_braces)),
context.Diagnostics);

RegisterCodeFix(context, CSharpAnalyzersResources.Add_braces, nameof(CSharpAnalyzersResources.Add_braces));
return Task.CompletedTask;
}

protected override Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
var root = editor.OriginalRoot;
foreach (var diagnostic in diagnostics)
Expand Down
19 changes: 5 additions & 14 deletions src/Analyzers/CSharp/CodeFixes/AddInheritdoc/AddInheritdocCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,13 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
if (symbol.IsOverride ||
symbol.ImplicitInterfaceImplementations().Any())
{
context.RegisterCodeFix(new MyCodeAction(CSharpCodeFixesResources.Explicitly_inherit_documentation,
c => FixAsync(context.Document, diagnostic, c)), context.Diagnostics);
RegisterCodeFix(context, CSharpCodeFixesResources.Explicitly_inherit_documentation, nameof(CSharpCodeFixesResources.Explicitly_inherit_documentation), diagnostic);
}
}
}
}

protected override async Task FixAllAsync(Document document, ImmutableArray<Diagnostic> diagnostics, SyntaxEditor editor, CancellationToken cancellationToken)
protected override async Task FixAllAsync(Document document, ImmutableArray<Diagnostic> diagnostics, SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
string? newLine = null;
SourceText? sourceText = null;
Expand All @@ -99,11 +98,11 @@ protected override async Task FixAllAsync(Document document, ImmutableArray<Diag
}

#if CODE_STYLE
var options = document.Project.AnalyzerOptions.GetAnalyzerOptionSet(node.SyntaxTree, cancellationToken);
var optionSet = document.Project.AnalyzerOptions.GetAnalyzerOptionSet(node.SyntaxTree, cancellationToken);
#else
var options = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);
var optionSet = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);
#endif
newLine ??= options.GetOption(FormattingOptions2.NewLine);
newLine ??= optionSet.GetOption(FormattingOptions2.NewLine);
// We can safely assume, that there is no leading doc comment, because that is what CS1591 is telling us.
// So we create a new /// <inheritdoc/> comment.
var xmlSpaceAfterTripleSlash = Token(leading: TriviaList(DocumentationCommentExterior("///")), SyntaxKind.XmlTextLiteralToken, text: " ", valueText: " ", trailing: default);
Expand Down Expand Up @@ -131,13 +130,5 @@ protected override async Task FixAllAsync(Document document, ImmutableArray<Diag
editor.ReplaceNode(node, node.WithPrependedLeadingTrivia(newLeadingTrivia));
}
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(string title, Func<CancellationToken, Task<Document>> createChangedDocument)
: base(title, createChangedDocument, equivalenceKey: nameof(CSharpCodeFixesResources.Explicitly_inherit_documentation))
{
}
}
}
}
10 changes: 5 additions & 5 deletions src/Analyzers/CSharp/CodeFixes/ConvertNamespace/ConvertNamespaceCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,27 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
});

context.RegisterCodeFix(
CodeAction.Create(title, c => FixAsync(context.Document, diagnostic, c), equivalenceKey),
CodeAction.Create(title, GetDocumentUpdater(context), equivalenceKey),
context.Diagnostics);

return Task.CompletedTask;
}

protected override async Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
var diagnostic = diagnostics.First();

var namespaceDecl = (BaseNamespaceDeclarationSyntax)diagnostic.AdditionalLocations[0].FindNode(cancellationToken);

#if CODE_STYLE
var configOptions = document.Project.AnalyzerOptions.GetAnalyzerOptionSet(namespaceDecl.SyntaxTree, cancellationToken);
var options = CSharpSyntaxFormattingOptions.Create(configOptions);
var formattingOptions = CSharpSyntaxFormattingOptions.Create(configOptions);
#else
var options = await SyntaxFormattingOptions.FromDocumentAsync(document, cancellationToken).ConfigureAwait(false);
var formattingOptions = await SyntaxFormattingOptions.FromDocumentAsync(document, cancellationToken).ConfigureAwait(false);
#endif
var converted = await ConvertAsync(document, namespaceDecl, options, cancellationToken).ConfigureAwait(false);
var converted = await ConvertAsync(document, namespaceDecl, formattingOptions, cancellationToken).ConfigureAwait(false);

editor.ReplaceNode(
editor.OriginalRoot,
Expand Down
9 changes: 2 additions & 7 deletions ...s/ConvertSwitchStatementToExpression/ConvertSwitchStatementToExpressionCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,13 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
return Task.CompletedTask;
}

context.RegisterCodeFix(
CodeAction.Create(
CSharpAnalyzersResources.Convert_switch_statement_to_expression,
c => FixAsync(context.Document, context.Diagnostics.First(), c),
nameof(CSharpAnalyzersResources.Convert_switch_statement_to_expression)),
context.Diagnostics);
RegisterCodeFix(context, CSharpAnalyzersResources.Convert_switch_statement_to_expression, nameof(CSharpAnalyzersResources.Convert_switch_statement_to_expression));
return Task.CompletedTask;
}

protected override async Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
using var spansDisposer = ArrayBuilder<TextSpan>.GetInstance(diagnostics.Length, out var spans);
foreach (var diagnostic in diagnostics)
Expand Down
19 changes: 3 additions & 16 deletions ...Sharp/CodeFixes/DisambiguateSameVariable/CSharpDisambiguateSameVariableCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,9 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
var cancellationToken = context.CancellationToken;

var semanticModel = await document.GetRequiredSemanticModelAsync(cancellationToken).ConfigureAwait(false);
if (CanFix(
semanticModel, diagnostic, cancellationToken,
out _, out _, out var title))
if (CanFix(semanticModel, diagnostic, cancellationToken, out _, out _, out var title))
{
context.RegisterCodeFix(new MyCodeAction(
title,
c => FixAsync(document, diagnostic, c)),
context.Diagnostics);
RegisterCodeFix(context, title, nameof(CSharpDisambiguateSameVariableCodeFixProvider));
}
}

Expand Down Expand Up @@ -141,7 +136,7 @@ where m.IsAccessibleWithin(enclosingType)

protected override async Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
var syntaxFacts = CSharpSyntaxFacts.Instance;
var semanticModel = await document.GetRequiredSemanticModelAsync(cancellationToken).ConfigureAwait(false);
Expand All @@ -167,13 +162,5 @@ protected override async Task FixAllAsync(
editor.ReplaceNode(nameNode, newExpr);
}
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(string title, Func<CancellationToken, Task<Document>> createChangedDocument)
: base(title, createChangedDocument, nameof(CSharpDisambiguateSameVariableCodeFixProvider))
{
}
}
}
}
16 changes: 2 additions & 14 deletions ...rs/CSharp/CodeFixes/FixIncorrectConstraint/CSharpFixIncorrectConstraintCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,23 +68,20 @@ private static bool TryGetConstraint(

public override Task RegisterCodeFixesAsync(CodeFixContext context)
{
var document = context.Document;
var cancellationToken = context.CancellationToken;

var diagnostic = context.Diagnostics.First();
if (TryGetConstraint(diagnostic, cancellationToken, out _, out _))
{
context.RegisterCodeFix(
new MyCodeAction(c => this.FixAsync(document, diagnostic, c)),
diagnostic);
RegisterCodeFix(context, CSharpCodeFixesResources.Fix_constraint, nameof(CSharpFixIncorrectConstraintCodeFixProvider));
}

return Task.CompletedTask;
}

protected override async Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
var generator = SyntaxGenerator.GetGenerator(document);
var compilation = await document.Project.GetRequiredCompilationAsync(cancellationToken).ConfigureAwait(false);
Expand Down Expand Up @@ -118,14 +115,5 @@ protected override async Task FixAllAsync(
}
}
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(
Func<CancellationToken, Task<Document>> createChangedDocument)
: base(CSharpCodeFixesResources.Fix_constraint, createChangedDocument, nameof(CSharpFixIncorrectConstraintCodeFixProvider))
{
}
}
}
}
14 changes: 2 additions & 12 deletions src/Analyzers/CSharp/CodeFixes/FixReturnType/CSharpFixReturnTypeCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
return;
}

context.RegisterCodeFix(
new MyCodeAction(c => FixAsync(document, diagnostics.First(), c)),
diagnostics);
RegisterCodeFix(context, CSharpCodeFixesResources.Fix_return_type, nameof(CSharpCodeFixesResources.Fix_return_type));

return;

Expand Down Expand Up @@ -103,7 +101,7 @@ static bool IsVoid(TypeSyntax typeSyntax)
return (declarationTypeToFix, fixedDeclaration);
}

protected override async Task FixAllAsync(Document document, ImmutableArray<Diagnostic> diagnostics, SyntaxEditor editor, CancellationToken cancellationToken)
protected override async Task FixAllAsync(Document document, ImmutableArray<Diagnostic> diagnostics, SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
var (declarationTypeToFix, fixedDeclaration) =
await TryGetOldAndNewReturnTypeAsync(document, diagnostics, cancellationToken).ConfigureAwait(false);
Expand All @@ -129,13 +127,5 @@ private static (TypeSyntax type, bool useTask) TryGetDeclarationTypeToFix(Syntax
};
}
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(Func<CancellationToken, Task<Document>> createChangedDocument)
: base(CSharpCodeFixesResources.Fix_return_type, createChangedDocument, nameof(CSharpCodeFixesResources.Fix_return_type))
{
}
}
}
}
14 changes: 5 additions & 9 deletions src/Analyzers/CSharp/CodeFixes/InlineDeclaration/CSharpInlineDeclarationCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,18 @@ public override ImmutableArray<string> FixableDiagnosticIds

public override Task RegisterCodeFixesAsync(CodeFixContext context)
{
context.RegisterCodeFix(CodeAction.Create(
CSharpAnalyzersResources.Inline_variable_declaration,
c => FixAsync(context.Document, context.Diagnostics.First(), c),
nameof(CSharpAnalyzersResources.Inline_variable_declaration)),
context.Diagnostics);
RegisterCodeFix(context, CSharpAnalyzersResources.Inline_variable_declaration, nameof(CSharpAnalyzersResources.Inline_variable_declaration));
return Task.CompletedTask;
}

protected override async Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
#if CODE_STYLE
var options = document.Project.AnalyzerOptions.GetAnalyzerOptionSet(editor.OriginalRoot.SyntaxTree, cancellationToken);
var optionSet = document.Project.AnalyzerOptions.GetAnalyzerOptionSet(editor.OriginalRoot.SyntaxTree, cancellationToken);
#else
var options = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);
var optionSet = await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false);
#endif

// Gather all statements to be removed
Expand Down Expand Up @@ -97,7 +93,7 @@ await editor.ApplyExpressionLevelSemanticEditsAsync(
(_1, _2, _3) => true,
(semanticModel, currentRoot, t, currentNode)
=> ReplaceIdentifierWithInlineDeclaration(
options, semanticModel, currentRoot, t.declarator,
optionSet, semanticModel, currentRoot, t.declarator,
t.identifier, currentNode, declarationsToRemove, document.Project.Solution.Workspace.Services,
cancellationToken),
cancellationToken).ConfigureAwait(false);
Expand Down
8 changes: 2 additions & 6 deletions ...InvokeDelegateWithConditionalAccess/InvokeDelegateWithConditionalAccessCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,13 @@ protected override bool IncludeDiagnosticDuringFixAll(Diagnostic diagnostic)

public override Task RegisterCodeFixesAsync(CodeFixContext context)
{
context.RegisterCodeFix(CodeAction.Create(
CSharpAnalyzersResources.Simplify_delegate_invocation,
c => FixAsync(context.Document, context.Diagnostics.First(), c),
nameof(CSharpAnalyzersResources.Simplify_delegate_invocation)),
context.Diagnostics);
RegisterCodeFix(context, CSharpAnalyzersResources.Simplify_delegate_invocation, nameof(CSharpAnalyzersResources.Simplify_delegate_invocation));
return Task.CompletedTask;
}

protected override Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
foreach (var diagnostic in diagnostics)
{
Expand Down
14 changes: 5 additions & 9 deletions src/Analyzers/CSharp/CodeFixes/Iterator/CSharpAddYieldCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,11 @@ public override ImmutableArray<string> FixableDiagnosticIds
.WithAdditionalAnnotations(Formatter.Annotation);

root = root.ReplaceNode(returnStatement, yieldStatement);
return new MyCodeAction(document.WithSyntaxRoot(root));

return CodeAction.Create(
CSharpCodeFixesResources.Replace_return_with_yield_return,
_ => Task.FromResult(document.WithSyntaxRoot(root)),
nameof(CSharpCodeFixesResources.Replace_return_with_yield_return));
}

private static bool TryGetExpressionType(
Expand Down Expand Up @@ -219,13 +223,5 @@ protected override bool TryGetNode(
node = ancestors.FirstOrDefault(n => n.Span.Contains(span) && n != root && n.IsKind(SyntaxKind.ReturnStatement));
return node != null;
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(Document newDocument)
: base(CSharpCodeFixesResources.Replace_return_with_yield_return, c => Task.FromResult(newDocument), nameof(CSharpCodeFixesResources.Replace_return_with_yield_return))
{
}
}
}
}
17 changes: 5 additions & 12 deletions src/Analyzers/CSharp/CodeFixes/Iterator/CSharpChangeToIEnumerableCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,11 @@ protected override async Task<CodeAction> GetCodeFixAsync(SyntaxNode root, Synta
return null;
}

return new MyCodeAction(
string.Format(CSharpCodeFixesResources.Change_return_type_from_0_to_1,
type.ToMinimalDisplayString(model, node.SpanStart),
ienumerableGenericSymbol.ToMinimalDisplayString(model, node.SpanStart)), newDocument);
var title = string.Format(CSharpCodeFixesResources.Change_return_type_from_0_to_1,
type.ToMinimalDisplayString(model, node.SpanStart),
ienumerableGenericSymbol.ToMinimalDisplayString(model, node.SpanStart));

return CodeAction.Create(title, _ => Task.FromResult(newDocument), title);
}

private static bool TryGetIEnumerableSymbols(SemanticModel model, out INamedTypeSymbol ienumerableSymbol, out INamedTypeSymbol ienumerableGenericSymbol)
Expand All @@ -129,13 +130,5 @@ private static bool TryGetIEnumerableSymbols(SemanticModel model, out INamedType

return true;
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(string title, Document newDocument)
: base(title, c => Task.FromResult(newDocument), title)
{
}
}
}
}
16 changes: 2 additions & 14 deletions ...arp/CodeFixes/MakeStatementAsynchronous/CSharpMakeStatementAsynchronousCodeFixProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,12 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
return;
}

context.RegisterCodeFix(new MyCodeAction(
c => FixAsync(context.Document, diagnostic, c)),
context.Diagnostics);
RegisterCodeFix(context, CSharpCodeFixesResources.Add_await, nameof(CSharpCodeFixesResources.Add_await));
}

protected override Task FixAllAsync(
Document document, ImmutableArray<Diagnostic> diagnostics,
SyntaxEditor editor, CancellationToken cancellationToken)
SyntaxEditor editor, CodeActionOptionsProvider options, CancellationToken cancellationToken)
{
foreach (var diagnostic in diagnostics)
{
Expand Down Expand Up @@ -114,15 +112,5 @@ private static SyntaxNode TryGetStatementToFix(SyntaxNode node)

return null;
}

private class MyCodeAction : CustomCodeActions.DocumentChangeAction
{
public MyCodeAction(Func<CancellationToken, Task<Document>> createChangedDocument)
: base(CSharpCodeFixesResources.Add_await,
createChangedDocument,
CSharpCodeFixesResources.Add_await)
{
}
}
}
}
Loading