Chore: avoid using legacy report API in no-irregular-whitespace (#11013)

not-an-aardvark · web-flow · commit 3d88b388aaa9 · 2018-10-24T17:37:25.000-04:00
This updates the no-irregular-whitespace rule to avoid using the legacy multi-argument `context.report` API. We have a linting rule to enforce against using the API, but the rule wasn't enforcing it in this case. This was originally found by Aladdin-ADD in eslint-community/eslint-plugin-eslint-plugin#64.
diff --git a/lib/rules/no-irregular-whitespace.js b/lib/rules/no-irregular-whitespace.js
@@ -81,9 +81,7 @@ module.exports = {
             const locStart = node.loc.start;
             const locEnd = node.loc.end;
 
-            errors = errors.filter(error => {
-                const errorLoc = error[1];
-
+            errors = errors.filter(({ loc: errorLoc }) => {
                 if (errorLoc.line >= locStart.line && errorLoc.line <= locEnd.line) {
                     if (errorLoc.column >= locStart.column && (errorLoc.column <= locEnd.column || errorLoc.line < locEnd.line)) {
                         return false;
@@ -157,7 +155,7 @@ module.exports = {
                         column: match.index
                     };
 
-                    errors.push([node, location, "Irregular whitespace not allowed."]);
+                    errors.push({ node, message: "Irregular whitespace not allowed.", loc: location });
                 }
             });
         }
@@ -182,7 +180,7 @@ module.exports = {
                     column: sourceLines[lineIndex].length
                 };
 
-                errors.push([node, location, "Irregular whitespace not allowed."]);
+                errors.push({ node, message: "Irregular whitespace not allowed.", loc: location });
                 lastLineIndex = lineIndex;
             }
         }
@@ -224,9 +222,7 @@ module.exports = {
                 }
 
                 // If we have any errors remaining report on them
-                errors.forEach(error => {
-                    context.report(...error);
-                });
+                errors.forEach(error => context.report(error));
             };
         } else {
             nodes.Program = noop;
