Fix: check the type of the first arg of the old context.report() API

Author: not-an-aardvark

Diff for: lib/rules/no-deprecated-report-api.js

@@ -47,9 +47,28 @@ module.exports = {
             fix (fixer) {
               const openingParen = sourceCode.getTokenBefore(node.arguments[0]);
               const closingParen = sourceCode.getLastToken(node);
-              const keys = node.arguments.length >= 5
-                ? ['node', 'loc', 'message', 'data', 'fix']
-                : ['node', 'message', 'data', 'fix'];
+
+              // If there is exactly one argument, the API expects an object.
+              // Otherwise, if the second argument is a string, the arguments are interpreted as
+              // ['node', 'message', 'data', 'fix'].
+              // Otherwise, the arguments are interpreted as ['node', 'loc', 'message', 'data', 'fix'].
+
+              let keys;
+              if (
+                (node.arguments[1].type === 'Literal' && typeof node.arguments[1].value === 'string') ||
+                node.arguments[1].type === 'TemplateLiteral'
+              ) {
+                keys = ['node', 'message', 'data', 'fix'];
+              } else if (
+                node.arguments[1].type === 'ObjectExpression' ||
+                node.arguments[1].type === 'ArrayExpression' ||
+                (node.arguments[1].type === 'Literal' && typeof node.arguments[1].value !== 'string')
+              ) {
+                keys = ['node', 'loc', 'message', 'data', 'fix'];
+              } else {
+                // Otherwise, we can't statically determine what argument means what, so no safe fix is possible.
+                return null;
+              }
 
               return fixer.replaceTextRange(
                 [openingParen.range[1], closingParen.range[0]],

Diff for: lib/rules/require-meta-fixable.js

@@ -45,7 +45,7 @@ module.exports = {
           contextIdentifiers.has(node.callee.object) &&
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report' &&
-          (node.arguments.length > 3 || (
+          (node.arguments.length > 4 || (
             node.arguments.length === 1 &&
             node.arguments[0].type === 'ObjectExpression' &&
             node.arguments[0].properties.some(prop => utils.getKeyName(prop) === 'fix')

Diff for: tests/lib/rules/no-deprecated-report-api.js

@@ -103,14 +103,14 @@ ruleTester.run('no-deprecated-report-api', rule, {
       code: `
         module.exports = {
           create(context) {
-            context.report(theNode, theLocation, theMessage, theData, theFix);
+            context.report(theNode, { line: foo, column: bar }, theMessage, theData, theFix);
           }
         };
       `,
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, loc: theLocation, message: theMessage, data: theData, fix: theFix});
+            context.report({node: theNode, loc: { line: foo, column: bar }, message: theMessage, data: theData, fix: theFix});
           }
         };
       `,
@@ -120,14 +120,14 @@ ruleTester.run('no-deprecated-report-api', rule, {
       code: `
         module.exports = {
           create(context) {
-            context.report(theNode, theMessage, theData, theFix);
+            context.report(theNode, "theMessage", theData, theFix);
           }
         };
       `,
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, message: theMessage, data: theData, fix: theFix});
+            context.report({node: theNode, message: "theMessage", data: theData, fix: theFix});
           }
         };
       `,
@@ -144,7 +144,7 @@ ruleTester.run('no-deprecated-report-api', rule, {
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, message: theMessage, data: theData, fix: theFix});
+            context.report(theNode, theMessage, theData, theFix);
           }
         };
       `,
@@ -154,14 +154,14 @@ ruleTester.run('no-deprecated-report-api', rule, {
       code: `
         module.exports = {
           create(context) {
-            context.report(theNode, theMessage, theData);
+            context.report(theNode, 'foo', theData);
           }
         };
       `,
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, message: theMessage, data: theData});
+            context.report({node: theNode, message: 'foo', data: theData});
           }
         };
       `,
@@ -171,14 +171,14 @@ ruleTester.run('no-deprecated-report-api', rule, {
       code: `
         module.exports = {
           create(context) {
-            context.report(theNode, theMessage);
+            context.report(theNode, 'foo');
           }
         };
       `,
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, message: theMessage});
+            context.report({node: theNode, message: 'foo'});
           }
         };
       `,
@@ -195,7 +195,7 @@ ruleTester.run('no-deprecated-report-api', rule, {
       output: `
         module.exports = {
           create(notContext) {
-            notContext.report({node: theNode, message: theMessage, data: theData, fix: theFix});
+            notContext.report(theNode, theMessage, theData, theFix);
           }
         };
       `,
@@ -204,12 +204,25 @@ ruleTester.run('no-deprecated-report-api', rule, {
     {
       code: `
         module.exports.create = context => {
-          context.report(theNode, theMessage, theData, theFix);
+          context.report(theNode, \`blah\`, theData, theFix);
         };
       `,
       output: `
         module.exports.create = context => {
-          context.report({node: theNode, message: theMessage, data: theData, fix: theFix});
+          context.report({node: theNode, message: \`blah\`, data: theData, fix: theFix});
+        };
+      `,
+      errors: [ERROR],
+    },
+    {
+      code: `
+        module.exports.create = context => {
+          context.report(theNode, 5, foo, bar);
+        };
+      `,
+      output: `
+        module.exports.create = context => {
+          context.report({node: theNode, loc: 5, message: foo, data: bar});
         };
       `,
       errors: [ERROR],
@@ -225,7 +238,7 @@ ruleTester.run('no-deprecated-report-api', rule, {
       output: `
         module.exports = {
           create(context) {
-            context.report({node: theNode, loc: theLocation, message: theMessage, data: theData, fix: theFix});
+            context.report(theNode, theLocation, theMessage, theData, theFix, somethingElse, somethingElse, somethingElse);
           }
         };
       `,

Diff for: tests/lib/rules/require-meta-fixable.js

@@ -110,23 +110,22 @@ ruleTester.run('require-meta-fixable', rule, {
       `,
       errors: [MISSING_ERROR],
     },
-  ],
-
-  invalid: [
     {
       code: `
         module.exports = {
           meta: {},
-          create(context) { context.report({node, message, fix: foo}); }
+          create(context) { context.report(node, message, data, fix); }
         };
       `,
-      errors: [MISSING_ERROR],
     },
+  ],
+
+  invalid: [
     {
       code: `
         module.exports = {
           meta: {},
-          create(context) { context.report(node, message, data, fix); }
+          create(context) { context.report({node, message, fix: foo}); }
         };
       `,
       errors: [MISSING_ERROR],