Skip to content

Commit 63b3b59

Browse files
committed
Merge remote-tracking branch 'DotNetAnalyzers/master' into testing-library
2 parents 49b26d0 + a5a4d17 commit 63b3b59

4 files changed

Lines changed: 50 additions & 5 deletions

File tree

NuGet.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<?xml version="1.0" encoding="utf-8"?>
1+
<?xml version="1.0" encoding="utf-8"?>
22
<configuration>
33
<packageSources>
44
<add key="roslyn" value="https://dotnet.myget.org/F/roslyn/api/v3/index.json" />

StyleCop.Analyzers/Directory.Build.props

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
<Copyright>Copyright © Tunnel Vision Laboratories, LLC 2015</Copyright>
99
<NeutralLanguage>en-US</NeutralLanguage>
1010

11-
<Version>1.1.0.39</Version>
12-
<FileVersion>1.1.0.39</FileVersion>
11+
<Version>1.1.0.40</Version>
12+
<FileVersion>1.1.0.40</FileVersion>
1313
<InformationalVersion>1.1.0-dev</InformationalVersion>
1414
</PropertyGroup>
1515

@@ -42,7 +42,7 @@
4242

4343
<ItemGroup>
4444
<PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
45-
<PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta008" PrivateAssets="all" />
45+
<PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta009" PrivateAssets="all" />
4646
</ItemGroup>
4747

4848
<ItemGroup>

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1629UnitTests.cs

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,49 @@ public interface ITest
433433
await VerifyCSharpFixAsync(testCode, expected, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
434434
}
435435

436+
[Theory]
437+
[WorkItem(2744, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2744")]
438+
[InlineData("Summary. (For example.)")]
439+
[InlineData("Summary (for example).")]
440+
public async Task TestSentenceEndingWithParenthesesAsync(string allowedSummary)
441+
{
442+
var testCode = $@"
443+
/// <summary>
444+
/// {allowedSummary}
445+
/// </summary>
446+
public interface ITest
447+
{{
448+
}}
449+
";
450+
451+
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
452+
}
453+
454+
[Fact]
455+
[WorkItem(2744, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2744")]
456+
public async Task TestSentenceEndingWithParenthesesWithoutPeriodAsync()
457+
{
458+
var testCode = @"
459+
/// <summary>
460+
/// Summary (for example)
461+
/// </summary>
462+
public interface ITest
463+
{
464+
}
465+
";
466+
var fixedTestCode = $@"
467+
/// <summary>
468+
/// Summary (for example).
469+
/// </summary>
470+
public interface ITest
471+
{{
472+
}}
473+
";
474+
475+
DiagnosticResult expected = Diagnostic().WithLocation(3, 26);
476+
await VerifyCSharpFixAsync(testCode, expected, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
477+
}
478+
436479
[Fact]
437480
public async Task TestMultipleParagraphBlocksAsync()
438481
{

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
9191
var textWithoutTrailingWhitespace = node.Value.TrimEnd(' ', '\r', '\n');
9292
if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
9393
{
94-
if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal))
94+
if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
95+
&& !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal))
9596
{
9697
context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocations[0], NoCodeFixProperties));
9798

@@ -123,6 +124,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
123124
if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
124125
{
125126
if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
127+
&& !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal)
126128
&& (startingWithFinalParagraph || !textWithoutTrailingWhitespace.EndsWith(":", StringComparison.Ordinal))
127129
&& !textWithoutTrailingWhitespace.EndsWith("-or-", StringComparison.Ordinal))
128130
{

0 commit comments

Comments
 (0)