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.

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

SA1629 should allow full-sentence links instead of forcing the period to glow white #3371

Merged
merged 3 commits into from
Jun 21, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,23 @@ public interface ITest
await VerifyCSharpFixAsync(testCode, expected, fixedTestCode, default).ConfigureAwait(false);
}

[Theory]
[InlineData("a")]
[InlineData("see")]
[InlineData("seealso")]
jnm2 marked this conversation as resolved.
Show resolved Hide resolved
public async Task TestFullSentenceLinkAsync(string tag)
{
var testCode = $@"
/// <summary>
/// <{tag} href=""someurl"">Periods aren't required to glow white at the end of a full-sentence link.</{tag}>
/// </summary>
public interface ITest
{{
}}
";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, default).ConfigureAwait(false);
}

[Theory]
[InlineData(",")]
[InlineData(";")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con

if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
{
if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
&& !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal)
&& (startingWithFinalParagraph || !textWithoutTrailingWhitespace.EndsWith(":", StringComparison.Ordinal))
&& !textWithoutTrailingWhitespace.EndsWith("-or-", StringComparison.Ordinal))
if (IsMissingRequiredPeriod(textWithoutTrailingWhitespace, startingWithFinalParagraph))
{
int spanStart = textToken.SpanStart + textWithoutTrailingWhitespace.Length;
ImmutableDictionary<string, string> properties = null;
Expand Down Expand Up @@ -162,10 +159,15 @@ void SetReplaceChar()
}
else if (xmlElement.Content[i].IsInlineElement() && !currentParagraphDone)
{
// Treat empty XML elements as a "word not ending with a period"
var location = Location.Create(xmlElement.SyntaxTree, new TextSpan(xmlElement.Content[i].Span.End, 1));
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
currentParagraphDone = true;
var lastTextElement = XmlCommentHelper.TryGetLastTextElementWithContent(xmlElement.Content[i]);

if (lastTextElement is null // Treat empty XML elements as a "word not ending with a period"
|| IsMissingRequiredPeriod(lastTextElement.TextTokens.Last().Text.TrimEnd(' ', '\r', '\n'), startingWithFinalParagraph))
{
var location = Location.Create(xmlElement.SyntaxTree, new TextSpan(xmlElement.Content[i].Span.End, 1));
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
currentParagraphDone = true;
}
}
else if (xmlElement.Content[i] is XmlElementSyntax childXmlElement)
{
Expand Down Expand Up @@ -198,5 +200,13 @@ void SetReplaceChar()
}
}
}

private static bool IsMissingRequiredPeriod(string textWithoutTrailingWhitespace, bool startingWithFinalParagraph)
{
return !textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
&& !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal)
&& (startingWithFinalParagraph || !textWithoutTrailingWhitespace.EndsWith(":", StringComparison.Ordinal))
&& !textWithoutTrailingWhitespace.EndsWith("-or-", StringComparison.Ordinal);
}
}
}
31 changes: 31 additions & 0 deletions StyleCop.Analyzers/StyleCop.Analyzers/Helpers/XmlCommentHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,37 @@ internal static XmlTextSyntax TryGetFirstTextElementWithContent(XmlNodeSyntax no
return null;
}

/// <summary>
/// Returns the last <see cref="XmlTextSyntax"/> which is not simply empty or whitespace.
/// </summary>
/// <param name="node">The XML content to search.</param>
/// <returns>The last <see cref="XmlTextSyntax"/> which is not simply empty or whitespace, or
/// <see langword="null"/> if no such element exists.</returns>
internal static XmlTextSyntax TryGetLastTextElementWithContent(XmlNodeSyntax node)
{
if (node is XmlEmptyElementSyntax)
{
return null;
}
else if (node is XmlTextSyntax xmlText)
{
return !IsConsideredEmpty(node) ? xmlText : null;
}
else if (node is XmlElementSyntax xmlElement)
{
for (var i = xmlElement.Content.Count - 1; i >= 0; i--)
{
var nestedContent = TryGetFirstTextElementWithContent(xmlElement.Content[i]);
if (nestedContent != null)
{
return nestedContent;
}
}
}

return null;
}

/// <summary>
/// Checks if a <see cref="SyntaxTrivia"/> contains a <see cref="DocumentationCommentTriviaSyntax"/> and returns
/// <see langword="true"/> if it is considered empty.
Expand Down