no-duplicated-branches: provide secondary issue locations (#112)

Author: andrea-guarino-sonarsource

src/rules/no-duplicated-branches.ts

@@ -24,10 +24,19 @@ import * as estree from "estree";
 import { getParent, isIfStatement, isBlockStatement } from "../utils/nodes";
 import { areEquivalent } from "../utils/equivalence";
 import { collectIfBranches, takeWithoutBreak, collectSwitchBranches } from "../utils/conditions";
+import { report, issueLocation } from "../utils/locations";
 
 const MESSAGE = "This {{type}}'s code block is the same as the block for the {{type}} on line {{line}}.";
 
 const rule: Rule.RuleModule = {
+  meta: {
+    schema: [
+      {
+        // internal parameter
+        enum: ["sonar-runtime"],
+      },
+    ],
+  },
   create(context: Rule.RuleContext) {
     return {
       IfStatement(node: estree.Node) {
@@ -126,14 +135,10 @@ const rule: Rule.RuleModule = {
     }
 
     function reportIssue(node: estree.Node, equivalentNode: estree.Node, type: string) {
-      context.report({
-        message: MESSAGE,
-        data: {
-          type,
-          line: String(equivalentNode.loc!.start.line),
-        },
-        node,
-      });
+      const equivalentNodeLoc = equivalentNode.loc as estree.SourceLocation;
+      report(context, { message: MESSAGE, data: { type, line: String(equivalentNode.loc!.start.line) }, node }, [
+        issueLocation(equivalentNodeLoc, equivalentNodeLoc, "Original"),
+      ]);
     }
   },
 };

tests/rules/no-duplicated-branches.test.ts

@@ -122,7 +122,24 @@ ruleTester.run("no-duplicated-branches if", rule, {
         first();
         second();
       }`,
-      errors: [{ line: 5 }],
+      options: ["sonar-runtime"],
+      errors: [
+        {
+          line: 5,
+          message: JSON.stringify({
+            secondaryLocations: [
+              {
+                line: 2,
+                column: 13,
+                endLine: 5,
+                endColumn: 7,
+                message: "Original",
+              },
+            ],
+            message: "This branch's code block is the same as the block for the branch on line 2.",
+          }),
+        },
+      ],
     },
     {
       code: `
@@ -249,7 +266,24 @@ ruleTester.run("no-duplicated-branches switch", rule, {
           second();
           break;
       }`,
-      errors: [{ line: 7 }],
+      options: ["sonar-runtime"],
+      errors: [
+        {
+          line: 7,
+          message: JSON.stringify({
+            secondaryLocations: [
+              {
+                line: 3,
+                column: 8,
+                endLine: 6,
+                endColumn: 16,
+                message: "Original",
+              },
+            ],
+            message: `This case's code block is the same as the block for the case on line 3.`,
+          }),
+        },
+      ],
     },
     {
       code: `