no-identical-functions: provide secondary issue locations (#101)

Author: andrea-guarino-sonarsource

src/rules/no-identical-functions.ts

@@ -22,12 +22,20 @@
 import { Rule } from "eslint";
 import * as estree from "estree";
 import { areEquivalent } from "../utils/equivalence";
-import { getMainFunctionTokenLocation } from "../utils/locations";
+import { getMainFunctionTokenLocation, report, issueLocation } from "../utils/locations";
 import { getParent } from "../utils/nodes";
 
-const MESSAGE = "Update this function so that its implementation is not identical to the one on line {{line}}.";
+const message = (line: string) =>
+  `Update this function so that its implementation is not identical to the one on line ${line}.`;
 
 const rule: Rule.RuleModule = {
+  meta: {
+    schema: [
+      {
+        enum: ["sonar-runtime"],
+      },
+    ],
+  },
   create(context: Rule.RuleContext) {
     const functions: Array<{ function: estree.Function; parent: estree.Node | undefined }> = [];
 
@@ -67,11 +75,18 @@ const rule: Rule.RuleModule = {
             originalFunction.loc
           ) {
             const loc = getMainFunctionTokenLocation(duplicatingFunction, functions[i].parent, context);
-            context.report({
-              message: MESSAGE,
-              data: { line: String(originalFunction.loc.start.line) },
-              loc,
-            });
+            const originalFunctionLoc = getMainFunctionTokenLocation(originalFunction, functions[j].parent, context);
+            const secondaryLocations = [
+              issueLocation(originalFunctionLoc, originalFunctionLoc, "Original implementation"),
+            ];
+            report(
+              context,
+              {
+                message: message(String(originalFunction.loc.start.line)),
+                loc,
+              },
+              secondaryLocations,
+            );
             break;
           }
         }

tests/rules/no-identical-functions.test.ts

@@ -18,6 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import { RuleTester } from "eslint";
+import { IssueLocation } from "../../src/utils/locations";
 
 const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 2018 } });
 import rule = require("../../src/rules/no-identical-functions");
@@ -225,6 +226,48 @@ ruleTester.run("no-identical-functions", rule, {
       };`,
       errors: [{ line: 9, column: 9, endColumn: 12 }],
     },
+    {
+      code: `
+      const x = {
+        foo() {
+      //^^^>
+          console.log("Hello");
+          console.log("World");
+          return 42;
+        },
+      
+        bar() {
+      //^^^
+          console.log("Hello");
+          console.log("World");
+          return 42;
+        },
+      };`,
+      options: ["sonar-runtime"],
+      errors: [
+        encodedMessage(3, 10, [{ line: 3, column: 8, endLine: 3, endColumn: 11, message: "Original implementation" }]),
+      ],
+    },
+    {
+      // few nodes, but many lines
+      code: `
+      function foo1() {
+        //     ^^^^>
+        return [
+          1,
+        ];
+      }
+      function bar1() {
+    //         ^^^^
+        return [
+          1,
+        ];
+      }`,
+      options: ["sonar-runtime"],
+      errors: [
+        encodedMessage(2, 8, [{ line: 2, column: 15, endLine: 2, endColumn: 19, message: "Original implementation" }]),
+      ],
+    },
   ],
 });
 
@@ -235,3 +278,18 @@ function message(originalLine: number, duplicationLine: number): RuleTester.Test
     endLine: duplicationLine,
   };
 }
+
+function encodedMessage(
+  originalLine: number,
+  duplicationLine: number,
+  secondaries: IssueLocation[],
+): RuleTester.TestCaseError {
+  return {
+    message: JSON.stringify({
+      secondaryLocations: secondaries,
+      message: `Update this function so that its implementation is not identical to the one on line ${originalLine}.`,
+    }),
+    line: duplicationLine,
+    endLine: duplicationLine,
+  };
+}