RegexShouldNotContainMultipleSpacesBase.cs

/*
 * SonarAnalyzer for .NET
 * Copyright (C) 2015-2023 SonarSource SA
 * mailto: contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

using System.Text.RegularExpressions;
using SonarAnalyzer.RegularExpressions;

namespace SonarAnalyzer.Rules;

public abstract class RegexShouldNotContainMultipleSpacesBase<TSyntaxKind> : RegexAnalyzerBase<TSyntaxKind>
    where TSyntaxKind : struct
{
    private const string DiagnosticId = "S101";

    protected sealed override string MessageFormat => "Regular expressions should not contain multiple spaces.";

    protected RegexShouldNotContainMultipleSpacesBase() : base(DiagnosticId) { }

    protected sealed override void Analyze(SonarSyntaxNodeReportingContext context, RegexContext regexContext)
    {
        if (regexContext?.Regex is not null
            && !IgnoresPatternWhitespace(regexContext)
            && regexContext.Pattern.Contains("  "))
        {
            context.ReportIssue(Diagnostic.Create(Rule, regexContext.PatternNode.GetLocation()));
        }
    }

    private bool IgnoresPatternWhitespace(RegexContext context) =>
        context.Options is { } options
        && options.HasFlag(RegexOptions.IgnorePatternWhitespace);
}