Skip to content

Do not report SA1516 for two consecutive single line properties #3936

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Do not report SA1516 for two consecutive single line properties #3936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1516UnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ public class Bar
public string Test3;

public string TestProperty1 { get; set; }

public string TestProperty2 { get; set; }
/// <summary>
/// A summary.
Expand Down Expand Up @@ -149,7 +148,6 @@ class Foo { }
Diagnostic().WithLocation(2, 1),
Diagnostic().WithLocation(5, 1),
Diagnostic().WithLocation(12, 1),
Diagnostic().WithLocation(13, 1),
Diagnostic().WithLocation(18, 1),
Diagnostic().WithLocation(24, 1),
Diagnostic().WithLocation(29, 1),
Expand Down
42 changes: 28 additions & 14 deletions ...eCop.Analyzers/StyleCop.Analyzers/LayoutRules/SA1516ElementsMustBeSeparatedByBlankLine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,34 +345,48 @@ private static void HandleMemberList(SyntaxNodeAnalysisContext context, SyntaxLi

if (!members[i - 1].ContainsDiagnostics && !members[i].ContainsDiagnostics)
{
// Report if
// the current declaration is not a field declaration
// or the previous declaration is of different type
// or the previous declaration spans across multiple lines
//
// Note that the order of checking is important, as the call to IsMultiLine requires a FieldDeclarationSyntax,
// something that can only be guaranteed if the first two checks fail.
if (!members[i].IsKind(SyntaxKind.FieldDeclaration)
|| !members[i - 1].IsKind(members[i].Kind())
|| IsMultiline((FieldDeclarationSyntax)members[i - 1]))
// Don't report if
// the previous declaration is of the same type
// AND it is either
// - a single line field declaration where the previous field is single line
// or
// - a single line property declaration where the previous property is single line
if (members[i - 1].IsKind(members[i].Kind())
&& ((members[i].IsKind(SyntaxKind.FieldDeclaration)
&& !IsMultiline((FieldDeclarationSyntax)members[i])
&& !IsMultiline((FieldDeclarationSyntax)members[i - 1]))
|| (members[i].IsKind(SyntaxKind.PropertyDeclaration)
&& !IsMultiline((PropertyDeclarationSyntax)members[i])
&& !IsMultiline((PropertyDeclarationSyntax)members[i - 1]))))
{
ReportIfThereIsNoBlankLine(context, members[i - 1], members[i]);
continue;
}

ReportIfThereIsNoBlankLine(context, members[i - 1], members[i]);
}
}
}

private static bool IsMultiline(FieldDeclarationSyntax fieldDeclaration)
{
var lineSpan = fieldDeclaration.GetLineSpan();
var attributeLists = fieldDeclaration.AttributeLists;
return IsMultiline(fieldDeclaration, fieldDeclaration.AttributeLists);
}

private static bool IsMultiline(PropertyDeclarationSyntax propertyDeclaration)
{
return IsMultiline(propertyDeclaration, propertyDeclaration.AttributeLists);
}

private static bool IsMultiline(MemberDeclarationSyntax memberDeclaration, SyntaxList<AttributeListSyntax> attributeLists)
{
var lineSpan = memberDeclaration.GetLineSpan();

int startLine;

// Exclude attributes when determining if a field declaration spans multiple lines
if (attributeLists.Count > 0)
{
var lastAttributeSpan = fieldDeclaration.SyntaxTree.GetLineSpan(attributeLists.Last().FullSpan);
var lastAttributeSpan = memberDeclaration.SyntaxTree.GetLineSpan(attributeLists.Last().FullSpan);
startLine = lastAttributeSpan.EndLinePosition.Line;
}
else
Expand Down
Loading