Skip to content

Fix analyzer RCS1206 #1685

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
josefpihrt merged 6 commits into from
Aug 31, 2025
Merged

Fix analyzer RCS1206 #1685

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d977d06
fix
josefpihrt Aug 31, 2025
ec37fbf
changelog
josefpihrt Aug 31, 2025
0557b55
fix
josefpihrt Aug 31, 2025
f60276b
changelog
josefpihrt Aug 31, 2025
bb6b1cc
changelog
josefpihrt Aug 31, 2025
3967a3d
Merge branch 'main' into fix/analyzers/rcs1206
josefpihrt Aug 31, 2025
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
Next Next commit
fix
  • Loading branch information
@josefpihrt
josefpihrt committed Aug 31, 2025
commit d977d06a0296237b5d481f93b0bbb0685f4db101
40 changes: 22 additions & 18 deletions src/Analyzers/CSharp/Analysis/AddOrRemoveTrailingCommaAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ private static void AnalyzeInitializerExpression(SyntaxNodeAnalysisContext conte
ReportRemove(context, expressions.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& expressions.IsSingleLine(cancellationToken: context.CancellationToken))
&& initializer.IsSingleLine(cancellationToken: context.CancellationToken))
{
ReportRemove(context, expressions.GetSeparator(count - 1));
}
Expand All @@ -81,7 +81,7 @@ private static void AnalyzeInitializerExpression(SyntaxNodeAnalysisContext conte
ReportAdd(context, expressions.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !expressions.IsSingleLine(cancellationToken: context.CancellationToken))
&& !initializer.IsSingleLine(cancellationToken: context.CancellationToken))
{
ReportAdd(context, expressions.Last());
}
Expand Down Expand Up @@ -112,7 +112,7 @@ private static void AnalyzeEnumDeclaration(SyntaxNodeAnalysisContext context)
ReportRemove(context, members.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& members.IsSingleLine(cancellationToken: context.CancellationToken))
&& enumDeclaration.IsSingleLine(cancellationToken: context.CancellationToken))
{
ReportRemove(context, members.GetSeparator(count - 1));
}
Expand All @@ -124,7 +124,7 @@ private static void AnalyzeEnumDeclaration(SyntaxNodeAnalysisContext context)
ReportAdd(context, members.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !members.IsSingleLine(cancellationToken: context.CancellationToken))
&& !enumDeclaration.IsSingleLine(cancellationToken: context.CancellationToken))
{
ReportAdd(context, members.Last());
}
Expand All @@ -147,6 +147,7 @@ private static void AnalyzeAnonymousObjectCreationExpression(SyntaxNodeAnalysisC

int count = initializers.Count;
int separatorCount = initializers.SeparatorCount;
TextSpan bracesSpan = TextSpan.FromBounds(objectCreation.OpenBraceToken.SpanStart, objectCreation.CloseBraceToken.Span.End);

if (count == separatorCount)
{
Expand All @@ -155,7 +156,7 @@ private static void AnalyzeAnonymousObjectCreationExpression(SyntaxNodeAnalysisC
ReportRemove(context, initializers.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& initializers.IsSingleLine(cancellationToken: context.CancellationToken))
&& bracesSpan.IsSingleLine(objectCreation.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportRemove(context, initializers.GetSeparator(count - 1));
}
Expand All @@ -167,7 +168,7 @@ private static void AnalyzeAnonymousObjectCreationExpression(SyntaxNodeAnalysisC
ReportAdd(context, initializers.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !initializers.IsSingleLine(cancellationToken: context.CancellationToken))
&& !bracesSpan.IsSingleLine(objectCreation.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportAdd(context, initializers.Last());
}
Expand All @@ -181,15 +182,16 @@ private static void AnalyzeSwitchExpression(SyntaxNodeAnalysisContext context)
if (style == TrailingCommaStyle.None)
return;

var objectCreation = (SwitchExpressionSyntax)context.Node;
var switchExpression = (SwitchExpressionSyntax)context.Node;

SeparatedSyntaxList<SwitchExpressionArmSyntax> arms = objectCreation.Arms;
SeparatedSyntaxList<SwitchExpressionArmSyntax> arms = switchExpression.Arms;

if (!arms.Any())
return;

int count = arms.Count;
int separatorCount = arms.SeparatorCount;
TextSpan bracesSpan = TextSpan.FromBounds(switchExpression.OpenBraceToken.SpanStart, switchExpression.CloseBraceToken.Span.End);

if (count == separatorCount)
{
Expand All @@ -198,7 +200,7 @@ private static void AnalyzeSwitchExpression(SyntaxNodeAnalysisContext context)
ReportRemove(context, arms.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& arms.IsSingleLine(cancellationToken: context.CancellationToken))
&& bracesSpan.IsSingleLine(switchExpression.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportRemove(context, arms.GetSeparator(count - 1));
}
Expand All @@ -210,7 +212,7 @@ private static void AnalyzeSwitchExpression(SyntaxNodeAnalysisContext context)
ReportAdd(context, arms.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !arms.IsSingleLine(cancellationToken: context.CancellationToken))
&& !bracesSpan.IsSingleLine(switchExpression.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportAdd(context, arms.Last());
}
Expand All @@ -224,15 +226,16 @@ private static void AnalyzePropertyPatternClause(SyntaxNodeAnalysisContext conte
if (style == TrailingCommaStyle.None)
return;

var objectCreation = (PropertyPatternClauseSyntax)context.Node;
var patternClause = (PropertyPatternClauseSyntax)context.Node;

SeparatedSyntaxList<SubpatternSyntax> subpatterns = objectCreation.Subpatterns;
SeparatedSyntaxList<SubpatternSyntax> subpatterns = patternClause.Subpatterns;

if (!subpatterns.Any())
return;

int count = subpatterns.Count;
int separatorCount = subpatterns.SeparatorCount;
TextSpan bracesSpan = TextSpan.FromBounds(patternClause.OpenBraceToken.SpanStart, patternClause.CloseBraceToken.Span.End);

if (count == separatorCount)
{
Expand All @@ -241,7 +244,7 @@ private static void AnalyzePropertyPatternClause(SyntaxNodeAnalysisContext conte
ReportRemove(context, subpatterns.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& subpatterns.IsSingleLine(cancellationToken: context.CancellationToken))
&& bracesSpan.IsSingleLine(patternClause.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportRemove(context, subpatterns.GetSeparator(count - 1));
}
Expand All @@ -253,7 +256,7 @@ private static void AnalyzePropertyPatternClause(SyntaxNodeAnalysisContext conte
ReportAdd(context, subpatterns.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !subpatterns.IsSingleLine(cancellationToken: context.CancellationToken))
&& !bracesSpan.IsSingleLine(patternClause.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportAdd(context, subpatterns.Last());
}
Expand All @@ -268,15 +271,16 @@ private static void AnalyzeCollectionExpression(SyntaxNodeAnalysisContext contex
if (style == TrailingCommaStyle.None)
return;

var objectCreation = (CollectionExpressionSyntax)context.Node;
var collectionExpression = (CollectionExpressionSyntax)context.Node;

SeparatedSyntaxList<CollectionElementSyntax> elements = objectCreation.Elements;
SeparatedSyntaxList<CollectionElementSyntax> elements = collectionExpression.Elements;

if (!elements.Any())
return;

int count = elements.Count;
int separatorCount = elements.SeparatorCount;
TextSpan bracesSpan = TextSpan.FromBounds(collectionExpression.OpenBracketToken.SpanStart, collectionExpression.CloseBracketToken.Span.End);

if (count == separatorCount)
{
Expand All @@ -285,7 +289,7 @@ private static void AnalyzeCollectionExpression(SyntaxNodeAnalysisContext contex
ReportRemove(context, elements.GetSeparator(count - 1));
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& elements.IsSingleLine(cancellationToken: context.CancellationToken))
&& bracesSpan.IsSingleLine(collectionExpression.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportRemove(context, elements.GetSeparator(count - 1));
}
Expand All @@ -297,7 +301,7 @@ private static void AnalyzeCollectionExpression(SyntaxNodeAnalysisContext contex
ReportAdd(context, elements.Last());
}
else if (style == TrailingCommaStyle.OmitWhenSingleLine
&& !elements.IsSingleLine(cancellationToken: context.CancellationToken))
&& !bracesSpan.IsSingleLine(collectionExpression.SyntaxTree, cancellationToken: context.CancellationToken))
{
ReportAdd(context, elements.Last());
}
Expand Down
50 changes: 50 additions & 0 deletions src/Tests/Analyzers.Tests/RCS1260AddOrRemoveTrailingCommaTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,56 @@ void M()
""", options: Options.AddConfigOption(ConfigOptionKeys.TrailingCommaStyle, ConfigOptionValues.TrailingCommaStyle_Include));
}

[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddOrRemoveTrailingComma)]
public async Task Test_ArrayInitializer_OmitWhenSingleLine()
{
await VerifyDiagnosticAndFixAsync("""
class C
{
void M()
{
var arr = new[]
{
""[||]
};
}
}
""", """
class C
{
void M()
{
var arr = new[]
{
"",
};
}
}
""", options: Options.AddConfigOption(ConfigOptionKeys.TrailingCommaStyle, ConfigOptionValues.TrailingCommaStyle_OmitWhenSingleLine));
}

[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddOrRemoveTrailingComma)]
public async Task Test_ArrayInitializer_OmitWhenSingleLine2()
{
await VerifyDiagnosticAndFixAsync("""
class C
{
void M()
{
var arr = new[] { ""[|,|] };
}
}
""", """
class C
{
void M()
{
var arr = new[] { "" };
}
}
""", options: Options.AddConfigOption(ConfigOptionKeys.TrailingCommaStyle, ConfigOptionValues.TrailingCommaStyle_OmitWhenSingleLine));
}

[Fact, Trait(Traits.Analyzer, DiagnosticIdentifiers.AddOrRemoveTrailingComma)]
public async Task Test_ArrayInitializer_Omit()
{
Expand Down
Loading