-
-
Notifications
You must be signed in to change notification settings - Fork 261
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f15e244
commit 9fe4dc0
Showing
8 changed files
with
234 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
158 changes: 158 additions & 0 deletions
158
...nalyzers.CodeFixes/CSharp/CodeFixes/RemoveElementInDocumentationCommentCodeFixProvider.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| // Copyright (c) .NET Foundation and Contributors. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Immutable; | ||
| using System.Composition; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CodeActions; | ||
| using Microsoft.CodeAnalysis.CodeFixes; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Microsoft.CodeAnalysis.Text; | ||
| using Roslynator.CodeFixes; | ||
| using Roslynator.CSharp.Syntax; | ||
|
|
||
| namespace Roslynator.CSharp.CodeFixes; | ||
|
|
||
| [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(RemoveElementInDocumentationCommentCodeFixProvider))] | ||
| [Shared] | ||
| public sealed class RemoveElementInDocumentationCommentCodeFixProvider : BaseCodeFixProvider | ||
| { | ||
| public override ImmutableArray<string> FixableDiagnosticIds | ||
| { | ||
| get | ||
| { | ||
| return ImmutableArray.Create( | ||
| DiagnosticIdentifiers.UnusedElementInDocumentationComment, | ||
| DiagnosticIdentifiers.InvalidReferenceInDocumentationComment); | ||
| } | ||
| } | ||
|
|
||
| #if ROSLYN_4_0 | ||
| public override FixAllProvider GetFixAllProvider() | ||
| { | ||
| return FixAllProvider.Create(async (context, document, diagnostics) => await FixAllAsync(document, diagnostics, context.CancellationToken).ConfigureAwait(false)); | ||
|
|
||
| static async Task<Document> FixAllAsync( | ||
| Document document, | ||
| ImmutableArray<Diagnostic> diagnostics, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| foreach (Diagnostic diagnostic in diagnostics.OrderByDescending(d => d.Location.SourceSpan.Start)) | ||
| { | ||
| (Func<CancellationToken, Task<Document>> CreateChangedDocument, string) result | ||
| = await GetChangedDocumentAsync(document, diagnostic, cancellationToken).ConfigureAwait(false); | ||
|
|
||
| document = await result.CreateChangedDocument(cancellationToken).ConfigureAwait(false); | ||
| } | ||
|
|
||
| return document; | ||
| } | ||
| } | ||
| #endif | ||
|
|
||
| public override async Task RegisterCodeFixesAsync(CodeFixContext context) | ||
| { | ||
| SyntaxNode root = await context.GetSyntaxRootAsync().ConfigureAwait(false); | ||
|
|
||
| if (!TryFindFirstAncestorOrSelf(root, context.Span, out XmlNodeSyntax xmlNode, findInsideTrivia: true)) | ||
| return; | ||
|
|
||
| Document document = context.Document; | ||
| Diagnostic diagnostic = context.Diagnostics[0]; | ||
|
|
||
| (Func<CancellationToken, Task<Document>> createChangedDocument, string name) | ||
| = await GetChangedDocumentAsync(document, diagnostic, context.CancellationToken).ConfigureAwait(false); | ||
|
|
||
| CodeAction codeAction = CodeAction.Create( | ||
| $"Remove '{name}' element", | ||
| ct => createChangedDocument(ct), | ||
| GetEquivalenceKey(diagnostic, name)); | ||
|
|
||
| context.RegisterCodeFix(codeAction, diagnostic); | ||
| } | ||
|
|
||
| private static async Task<(Func<CancellationToken, Task<Document>>, string)> GetChangedDocumentAsync( | ||
| Document document, | ||
| Diagnostic diagnostic, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| SyntaxNode root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); | ||
|
|
||
| if (!TryFindFirstAncestorOrSelf(root, diagnostic.Location.SourceSpan, out XmlNodeSyntax xmlNode, findInsideTrivia: true)) | ||
| throw new InvalidOperationException(); | ||
|
|
||
| XmlElementInfo elementInfo = SyntaxInfo.XmlElementInfo(xmlNode); | ||
| string name = elementInfo.LocalName; | ||
|
|
||
| return (ct => RemoveElementAsync(document, elementInfo, ct), name); | ||
| } | ||
|
|
||
| private static Task<Document> RemoveElementAsync( | ||
| Document document, | ||
| in XmlElementInfo elementInfo, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| cancellationToken.ThrowIfCancellationRequested(); | ||
|
|
||
| XmlNodeSyntax element = elementInfo.Element; | ||
|
|
||
| var documentationComment = (DocumentationCommentTriviaSyntax)element.Parent; | ||
|
|
||
| SyntaxList<XmlNodeSyntax> content = documentationComment.Content; | ||
|
|
||
| if (content.Count(f => f.IsKind(SyntaxKind.XmlElement, SyntaxKind.XmlEmptyElement)) == 1) | ||
| { | ||
| SyntaxNode declaration = documentationComment | ||
| .GetParent(ascendOutOfTrivia: true) | ||
| .FirstAncestorOrSelf(f => f is MemberDeclarationSyntax or LocalFunctionStatementSyntax); | ||
|
|
||
| SyntaxNode newNode = SyntaxRefactorings.RemoveSingleLineDocumentationComment(declaration, documentationComment); | ||
| return document.ReplaceNodeAsync(declaration, newNode, cancellationToken); | ||
| } | ||
|
|
||
| int start = element.FullSpan.Start; | ||
| int end = element.FullSpan.End; | ||
|
|
||
| int index = content.IndexOf(element); | ||
|
|
||
| if (index > 0 | ||
| && content[index - 1].IsKind(SyntaxKind.XmlText)) | ||
| { | ||
| start = content[index - 1].FullSpan.Start; | ||
|
|
||
| if (index == 1) | ||
| { | ||
| SyntaxNode parent = documentationComment.GetParent(ascendOutOfTrivia: true); | ||
| SyntaxTriviaList leadingTrivia = parent.GetLeadingTrivia(); | ||
|
|
||
| index = leadingTrivia.IndexOf(documentationComment.ParentTrivia); | ||
|
|
||
| if (index > 0 | ||
| && leadingTrivia[index - 1].IsKind(SyntaxKind.WhitespaceTrivia)) | ||
| { | ||
| start = leadingTrivia[index - 1].FullSpan.Start; | ||
| } | ||
|
|
||
| SyntaxToken token = parent.GetFirstToken().GetPreviousToken(includeDirectives: true); | ||
| parent = parent.FirstAncestorOrSelf(f => f.FullSpan.Contains(token.FullSpan)); | ||
|
|
||
| if (start > 0) | ||
| { | ||
| SyntaxTrivia trivia = parent.FindTrivia(start - 1, findInsideTrivia: true); | ||
|
|
||
| if (trivia.IsKind(SyntaxKind.EndOfLineTrivia) | ||
| && start == trivia.FullSpan.End) | ||
| { | ||
| start = trivia.FullSpan.Start; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return document.WithTextChangeAsync(new TextChange(TextSpan.FromBounds(start, end), ""), cancellationToken); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.