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.

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

Fix S2094 FP: Documentation using the DefaultDocumentation package #9083

Merged
merged 3 commits into from
Apr 12, 2024
+7 −1
Merged

Fix S2094 FP: Documentation using the DefaultDocumentation package #9083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d68c6ed
Add UTs
Tim-Pohlmann Apr 12, 2024
aeba10f
Add exception for "AssemblyDoc" and "NamespaceDoc"
Tim-Pohlmann Apr 12, 2024
52e9e46
Update UTs
Tim-Pohlmann Apr 12, 2024
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
5 changes: 4 additions & 1 deletion analyzers/src/SonarAnalyzer.Common/Rules/ClassShouldNotBeEmptyBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public abstract class ClassShouldNotBeEmptyBase<TSyntaxKind, TDeclarationSyntax>
KnownType.System_Attribute,
KnownType.System_Exception);

private static readonly IEnumerable<string> IgnoredNames = ["AssemblyDoc", "NamespaceDoc"]; // https://github.com/Doraku/DefaultDocumentation

private static readonly IEnumerable<string> IgnoredSuffixes = ["Command", "Event", "Message"];

protected abstract bool IsEmptyAndNotPartial(SyntaxNode node);
Expand Down Expand Up @@ -62,7 +64,8 @@ protected override void Initialize(SonarAnalysisContext context) =>
Language.SyntaxKind.ClassAndRecordClassDeclarations);

private static bool ShouldIgnoreBecauseOfName(SyntaxToken identifier) =>
IgnoredSuffixes.Any(identifier.ValueText.EndsWith);
IgnoredNames.Contains(identifier.ValueText)
|| IgnoredSuffixes.Any(identifier.ValueText.EndsWith);

private bool ShouldIgnoreBecauseOfBaseClassOrInterface(SyntaxNode node, SemanticModel model) =>
GetIfHasDeclaredBaseClassOrInterface(node) is { } declaration
Expand Down
3 changes: 3 additions & 0 deletions analyzers/tests/SonarAnalyzer.Test/TestCases/ClassShouldNotBeEmpty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ class Command { } // Compliant, ignored because of th
class Event { } // Compliant, ignored because of the suffix
class Message { } // Compliant, ignored because of the suffix

class AssemblyDoc { } // Compliant, used for DefaultDocumentation tool
class NamespaceDoc { } // compliant, used for DefaultDocumentation tool

class BaseWithProtectedConstructor
{
protected BaseWithProtectedConstructor() { }
Expand Down