Added a local const analyzer

This commit is contained in:
Thorsten Sommer 2025-02-25 19:54:18 +01:00
parent ed1e8493cd
commit 6897e73035
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
3 changed files with 66 additions and 1 deletions

View File

@ -10,4 +10,5 @@
MWAIS0004 | Usage | Error | RandomInstantiationAnalyzer
MWAIS0005 | Usage | Error | ThisUsageAnalyzer
MWAIS0006 | Style | Error | SwitchExpressionMethodAnalyzer
MWAIS0007 | Usage | Error | EmptyStringAnalyzer
MWAIS0007 | Usage | Error | EmptyStringAnalyzer
MWAIS0008 | Naming | Error | LocalConstantsAnalyzer

View File

@ -9,4 +9,5 @@ public static class Identifier
public const string THIS_USAGE_ANALYZER = $"{Tools.ID_PREFIX}0005";
public const string SWITCH_EXPRESSION_METHOD_ANALYZER = $"{Tools.ID_PREFIX}0006";
public const string EMPTY_STRING_ANALYZER = $"{Tools.ID_PREFIX}0007";
public const string LOCAL_CONSTANTS_ANALYZER = $"{Tools.ID_PREFIX}0008";
}

View File

@ -0,0 +1,63 @@
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
namespace SourceCodeRules.NamingAnalyzers;
#pragma warning disable RS1038
[DiagnosticAnalyzer(LanguageNames.CSharp)]
#pragma warning restore RS1038
public sealed class LocalConstantsAnalyzer : DiagnosticAnalyzer
{
private const string DIAGNOSTIC_ID = Identifier.LOCAL_CONSTANTS_ANALYZER;
private static readonly string TITLE = "Local constant variables must be in UPPER_CASE";
private static readonly string MESSAGE_FORMAT = "Local constant variable '{0}' must be in UPPER_CASE";
private static readonly string DESCRIPTION = "All local constant variables should be named using UPPER_CASE with words separated by underscores.";
private const string CATEGORY = "Naming";
private static readonly DiagnosticDescriptor RULE = new(
DIAGNOSTIC_ID,
TITLE,
MESSAGE_FORMAT,
CATEGORY,
DiagnosticSeverity.Error,
isEnabledByDefault: true,
description: DESCRIPTION);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => [RULE];
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.EnableConcurrentExecution();
context.RegisterSyntaxNodeAction(AnalyzeLocalDeclaration, SyntaxKind.LocalDeclarationStatement);
}
private static void AnalyzeLocalDeclaration(SyntaxNodeAnalysisContext context)
{
var localDeclaration = (LocalDeclarationStatementSyntax)context.Node;
if (!localDeclaration.Modifiers.Any(m => m.IsKind(SyntaxKind.ConstKeyword)))
return;
foreach (var variable in localDeclaration.Declaration.Variables)
{
var variableName = variable.Identifier.Text;
if (!IsUpperCase(variableName))
{
var diagnostic = Diagnostic.Create(RULE, variable.Identifier.GetLocation(), variableName);
context.ReportDiagnostic(diagnostic);
}
}
}
private static bool IsUpperCase(string name) => name.All(c => char.IsUpper(c) || char.IsDigit(c) || c == '_') &&
!string.IsNullOrEmpty(name) && name.Any(char.IsLetter);
}