no-element-overwrite: provide secondary issue locations (#99)

Author: andrea-guarino-sonarsource

src/rules/no-element-overwrite.ts

@@ -30,8 +30,20 @@ import {
   isIdentifier,
   isCallExpression,
 } from "../utils/nodes";
+import { report, issueLocation } from "../utils/locations";
+
+const message = (index: string, line: string) =>
+  `Verify this is the index that was intended; "${index}" was already set on line ${line}.`;
 
 const rule: Rule.RuleModule = {
+  meta: {
+    schema: [
+      {
+        // internal parameter
+        enum: ["sonar-runtime"],
+      },
+    ],
+  },
   create(context: Rule.RuleContext) {
     return {
       SwitchCase(node: estree.Node) {
@@ -61,14 +73,16 @@ const rule: Rule.RuleModule = {
           }
           const sameKeyWriteUsage = usedKeys.get(keyWriteUsage.indexOrKey);
           if (sameKeyWriteUsage && sameKeyWriteUsage.node.loc) {
-            context.report({
-              node: keyWriteUsage.node,
-              message: 'Verify this is the index that was intended; "{{index}}" was already set on line {{line}}.',
-              data: {
-                index: keyWriteUsage.indexOrKey,
-                line: String(sameKeyWriteUsage.node.loc.start.line),
+            const sameKeyWriteUsageLoc = sameKeyWriteUsage.node.loc;
+            const secondaryLocations = [issueLocation(sameKeyWriteUsageLoc, sameKeyWriteUsageLoc, "Original value")];
+            report(
+              context,
+              {
+                node: keyWriteUsage.node,
+                message: message(keyWriteUsage.indexOrKey, String(sameKeyWriteUsage.node.loc.start.line)),
               },
-            });
+              secondaryLocations,
+            );
           }
           usedKeys.set(keyWriteUsage.indexOrKey, keyWriteUsage);
           collection = keyWriteUsage.collectionNode;

tests/rules/no-element-overwrite.test.ts

@@ -105,6 +105,20 @@ ruleTester.run("no-element-overwrite", rule, {
         },
       ],
     },
+    {
+      code: `
+      fruits[1] = "banana";
+    //^^^^^^^^^^^^^^^^^^^^>
+      fruits[1] = "apple";
+    //^^^^^^^^^^^^^^^^^^^`,
+      options: ["sonar-runtime"],
+      errors: [
+        JSON.stringify({
+          secondaryLocations: [{ line: 2, column: 6, endLine: 2, endColumn: 26, message: "Original value" }],
+          message: `Verify this is the index that was intended; "1" was already set on line 2.`,
+        }),
+      ],
+    },
     {
       code: `
       fruits[1] = "banana";