Implement S6326 for both C# and VB.NET #7345
Conversation
Corniel
force-pushed
the
corniel/regex-white-space
branch
from
b1d2709
to
f6f7b82
Compare
|
@pavel-mikula-sonarsource Any ETA on this? |
Corniel
force-pushed
the
corniel/regex-white-space
branch
from
f6f7b82
to
7c64d8a
Compare
| protected override void Initialize(SonarAnalysisContext context) | ||
| { | ||
| context.RegisterNodeAction( | ||
| Language.GeneratedCodeRecognizer, | ||
| c => Analyze(c, RegexContext.FromCtor(Language, c.SemanticModel, c.Node)), | ||
| Language.SyntaxKind.ObjectCreationExpressions); | ||
|
|
||
| context.RegisterNodeAction( | ||
| Language.GeneratedCodeRecognizer, | ||
| c => Analyze(c, RegexContext.FromMethod(Language, c.SemanticModel, c.Node)), | ||
| Language.SyntaxKind.InvocationExpression); | ||
|
|
||
| context.RegisterNodeAction( | ||
| Language.GeneratedCodeRecognizer, | ||
| c => Analyze(c, RegexContext.FromAttribute(Language, c.SemanticModel, c.Node)), | ||
| Language.SyntaxKind.Attribute); | ||
| } | ||
|
|
There was a problem hiding this comment.
This whole thing will repeat in every single Regex rule and will be hard to change for new APIs.
Please create a new abstract base class RegexBase or RegexAnalyzerBase that will override and seal Initialize and will provide abstract Analyze method to override by this, and the other rule.
| protected override void Initialize(SonarAnalysisContext context) | |
| { | |
| context.RegisterNodeAction( | |
| Language.GeneratedCodeRecognizer, | |
| c => Analyze(c, RegexContext.FromCtor(Language, c.SemanticModel, c.Node)), | |
| Language.SyntaxKind.ObjectCreationExpressions); | |
| context.RegisterNodeAction( | |
| Language.GeneratedCodeRecognizer, | |
| c => Analyze(c, RegexContext.FromMethod(Language, c.SemanticModel, c.Node)), | |
| Language.SyntaxKind.InvocationExpression); | |
| context.RegisterNodeAction( | |
| Language.GeneratedCodeRecognizer, | |
| c => Analyze(c, RegexContext.FromAttribute(Language, c.SemanticModel, c.Node)), | |
| Language.SyntaxKind.Attribute); | |
| } |
There was a problem hiding this comment.
I fully agree. But I was only repeating myself once. And some people say you should only start to refactor when you repeat yourself twice. ;)
Nevertheless, the setup so far was with a base class in mind, I now added it.
|
|
||
| private void Analyze(SonarSyntaxNodeReportingContext c, RegexContext context) | ||
| { | ||
| if (context?.Regex is { } |
There was a problem hiding this comment.
Nitpick
| if (context?.Regex is { } | |
| if (context?.Regex is not null |
| @@ -0,0 +1,124 @@ | |||
| using System; | |||
There was a problem hiding this comment.
Let's add a test case with regex comment (?# comment with spaces), mark it as FP and leave it like that
|
|
||
| void Unknown(string unknown) | ||
| { | ||
| var regex = new NoRegex(unknown + "multiple white spaces"); // Compliant |
There was a problem hiding this comment.
This should be a FN, because no matter what the unknown part does, there are multiple spaces
...s/SonarAnalyzer.UnitTest/TestCases/RegularExpressions/RegexShouldNotContainMultipleSpaces.cs
Outdated
Show resolved
Hide resolved
| || Regex.IsMatch(input, "ignore pattern white space", RegexOptions.IgnorePatternWhitespace); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Let's document other white-spacing characters? Like hardspace, no-break space and others from UnicodeCategory.SpaceSeparator?
See https://learn.microsoft.com/en-us/dotnet/api/system.char.iswhitespace?view=net-7.0#remarks
I guess 0x09, 0xA0, 0xD0 should not be checked.
| @@ -44,3 +44,23 @@ public interface ILanguageFacade<TSyntaxKind> : ILanguageFacade | |||
| ISyntaxKindFacade<TSyntaxKind> SyntaxKind { get; } | |||
| ITrackerFacade<TSyntaxKind> Tracker { get; } | |||
| } | |||
|
|
|||
| public static class LanguageFacadeExtensions | |||
There was a problem hiding this comment.
The concept of extensions of LangaugeFacade doesn't feel right. It's like dependencies going in both directions.
Why not change just is RegexOptions to is int and then cast it?
There was a problem hiding this comment.
I added (and rebased) a set of whitespaces that are fine in regexes.
Corniel
force-pushed
the
corniel/regex-white-space
branch
from
06c9b7e
to
990ac77
Compare
Corniel
force-pushed
the
corniel/regex-white-space
branch
from
4b57451
to
8c2714d
Compare
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
|
|
…sions/RegexShouldNotContainMultipleSpaces.cs Co-authored-by: Pavel Mikula <57188685+pavel-mikula-sonarsource@users.noreply.github.com>
Corniel
force-pushed
the
corniel/regex-white-space
branch
from
8c2714d
to
51b6b16
Compare
|
Failing test has been fixed. |
The rule already exists for Java, and with the work done for S5856 it not that much work.