Handle trailing comments (#857)

StefanMaron · Jan 7, 2025 · 655949a · 655949a
1 parent bd3e29e
commit 655949a
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 3 deletions.
diff --git a/BusinessCentral.LinterCop.Test/Rule0017.cs b/BusinessCentral.LinterCop.Test/Rule0017.cs
@@ -24,8 +24,11 @@ public async Task HasDiagnostic(string testCase)
     }
 
     [Test]
-    [TestCase("Assignment")]
-    [TestCase("Validate")]
+    [TestCase("AssignmentWithLeadingComment")]
+    [TestCase("AssignmentWithTrailingComment")]
+    [TestCase("ValidateWithLeadingComment")]
+    //TODO: The HasExplainingComment method in the Rule0017WriteToFlowField class doesn't support this scenario currently
+    // [TestCase("ValidateWithTrailingComment")]
     public async Task NoDiagnostic(string testCase)
     {
         var code = await File.ReadAllTextAsync(Path.Combine(_testCaseDir, "NoDiagnostic", $"{testCase}.al"))

diff --git a/...Cases/Rule0017/NoDiagnostic/Assignment.al → ...iagnostic/AssignmentWithLeadingComment.al b/...Cases/Rule0017/NoDiagnostic/Assignment.al → ...iagnostic/AssignmentWithLeadingComment.al
diff --git a/...ssCentral.LinterCop.Test/TestCases/Rule0017/NoDiagnostic/AssignmentWithTrailingComment.al b/...ssCentral.LinterCop.Test/TestCases/Rule0017/NoDiagnostic/AssignmentWithTrailingComment.al
@@ -0,0 +1,16 @@
+table 50100 MyTable
+{
+    fields
+    {
+        field(1; MyField; Integer) { }
+        field(2; MyField2; Boolean)
+        {
+            FieldClass = FlowField;
+        }
+    }
+
+    procedure MyProcedure();
+    begin
+        [|Rec.MyField2|] := false; // Comment
+    end;
+}
diff --git a/...stCases/Rule0017/NoDiagnostic/Validate.al → ...oDiagnostic/ValidateWithLeadingComment.al b/...stCases/Rule0017/NoDiagnostic/Validate.al → ...oDiagnostic/ValidateWithLeadingComment.al
diff --git a/...nessCentral.LinterCop.Test/TestCases/Rule0017/NoDiagnostic/ValidateWithTrailingComment.al b/...nessCentral.LinterCop.Test/TestCases/Rule0017/NoDiagnostic/ValidateWithTrailingComment.al
@@ -0,0 +1,17 @@
+
+table 50100 MyTable
+{
+    fields
+    {
+        field(1; MyField; Integer) { }
+        field(2; MyField2; Boolean)
+        {
+            FieldClass = FlowField;
+        }
+    }
+
+    procedure MyProcedure();
+    begin
+        Rec.Validate([|MyField2|], false); // Comment
+    end;
+}
diff --git a/BusinessCentral.LinterCop/Design/Rule0017WriteToFlowField.cs b/BusinessCentral.LinterCop/Design/Rule0017WriteToFlowField.cs
@@ -76,5 +76,6 @@ operation.Target is ITextIndexAccess textIndexAccess &&
     }
 
     private bool HasExplainingComment(IOperation operation) =>
-        operation.Syntax.GetLeadingTrivia().Any(trivia => trivia.IsKind(SyntaxKind.LineCommentTrivia));
+        operation.Syntax.GetLeadingTrivia().Any(trivia => trivia.IsKind(SyntaxKind.LineCommentTrivia)) ||
+        operation.Syntax.GetTrailingTrivia().Any(trivia => trivia.IsKind(SyntaxKind.LineCommentTrivia));
 }