fix: correctly handle rules that are missing meta or have meta / …

…`create` defined in variables (#225)
eslint-community · Oct 26, 2021 · badd4eb · badd4eb
1 parent 6a09dbe
commit badd4eb
Show file tree

Hide file tree

Showing 36 changed files with 444 additions and 170 deletions.
diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md
@@ -39,8 +39,8 @@ Examples of **incorrect** code for this rule:
 module.exports = {
   create (context) {
     return {
-      Program (node) {
-        const firstToken = context.getFirstToken(node);
+      Program (ast) {
+        const firstToken = context.getFirstToken(ast);
       },
     };
   },
@@ -55,8 +55,8 @@ module.exports = {
     const sourceCode = context.getSourceCode();
 
     return {
-      Program (node) {
-        const firstToken = sourceCode.getFirstToken(node);
+      Program (ast) {
+        const firstToken = sourceCode.getFirstToken(ast);
       },
     };
   },

diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -93,8 +93,9 @@ module.exports = {
     }
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        const sourceCode = context.getSourceCode();
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
 
       // Stacks this function's information.

diff --git a/lib/rules/no-deprecated-context-methods.js b/lib/rules/no-deprecated-context-methods.js
@@ -58,8 +58,8 @@ module.exports = {
     // ----------------------------------------------------------------------
 
     return {
-      'Program:exit' () {
-        [...utils.getContextIdentifiers(context, sourceCode.ast)]
+      'Program:exit' (ast) {
+        [...utils.getContextIdentifiers(sourceCode.scopeManager, ast)]
           .filter(
             contextId =>
               contextId.parent.type === 'MemberExpression' &&

diff --git a/lib/rules/no-deprecated-report-api.js b/lib/rules/no-deprecated-report-api.js
@@ -36,8 +36,8 @@ module.exports = {
     // ----------------------------------------------------------------------
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
       CallExpression (node) {
         if (

diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
@@ -37,7 +37,8 @@ module.exports = {
 
     return {
       Program (ast) {
-        contextIdentifiers = utils.getContextIdentifiers(context, ast);
+        const sourceCode = context.getSourceCode();
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
       CallExpression (node) {
         if (

diff --git a/lib/rules/no-unused-placeholders.js b/lib/rules/no-unused-placeholders.js
@@ -37,7 +37,8 @@ module.exports = {
 
     return {
       Program (ast) {
-        contextIdentifiers = utils.getContextIdentifiers(context, ast);
+        const sourceCode = context.getSourceCode();
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
       CallExpression (node) {
         if (

diff --git a/lib/rules/no-useless-token-range.js b/lib/rules/no-useless-token-range.js
@@ -107,7 +107,7 @@ module.exports = {
 
     return {
       'Program:exit' (ast) {
-        [...utils.getSourceCodeIdentifiers(context, ast)]
+        [...utils.getSourceCodeIdentifiers(sourceCode.scopeManager, ast)]
           .filter(identifier => identifier.parent.type === 'MemberExpression' &&
             identifier.parent.object === identifier &&
             identifier.parent.property.type === 'Identifier' &&

diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js
@@ -36,9 +36,9 @@ module.exports = {
 
     return {
       Program (ast) {
-        contextIdentifiers = utils.getContextIdentifiers(context, ast);
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
 
-        if (info === null || info.meta === null) {
+        if (info === null) {
           return;
         }
 
@@ -49,7 +49,7 @@ module.exports = {
           metaNode.properties.find(p => p.type === 'Property' && utils.getKeyName(p) === 'messages');
 
         if (!messagesNode) {
-          context.report({ node: metaNode, messageId: 'messagesMissing' });
+          context.report({ node: metaNode || info.create, messageId: 'messagesMissing' });
           return;
         }
 

diff --git a/lib/rules/prefer-placeholders.js b/lib/rules/prefer-placeholders.js
@@ -39,8 +39,8 @@ module.exports = {
     // ----------------------------------------------------------------------
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
       CallExpression (node) {
         if (

diff --git a/lib/rules/prefer-replace-text.js b/lib/rules/prefer-replace-text.js
@@ -38,8 +38,8 @@ module.exports = {
     let contextIdentifiers;
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
 
       // Stacks this function's information.

diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -59,9 +59,10 @@ module.exports = {
     // ----------------------------------------------------------------------
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
-        const ruleInfo = utils.getRuleInfo(context.getSourceCode());
+      Program (ast) {
+        const sourceCode = context.getSourceCode();
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
+        const ruleInfo = utils.getRuleInfo(sourceCode);
         const messagesObject = ruleInfo &&
           ruleInfo.meta &&
           ruleInfo.meta.type === 'ObjectExpression' &&

diff --git a/lib/rules/require-meta-docs-description.js b/lib/rules/require-meta-docs-description.js
@@ -39,12 +39,12 @@ module.exports = {
   },
 
   create (context) {
-    const sourceCode = context.getSourceCode();
-    const info = utils.getRuleInfo(sourceCode);
-
     return {
       Program () {
-        if (info === null || info.meta === null) {
+        const sourceCode = context.getSourceCode();
+        const info = utils.getRuleInfo(sourceCode);
+
+        if (info === null) {
           return;
         }
 
@@ -62,7 +62,7 @@ module.exports = {
           docsNode.value.properties.find(p => p.type === 'Property' && utils.getKeyName(p) === 'description');
 
         if (!descriptionNode) {
-          context.report({ node: docsNode ? docsNode : metaNode, messageId: 'missing' });
+          context.report({ node: docsNode || metaNode || info.create, messageId: 'missing' });
           return;
         }
 

diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
@@ -57,8 +57,8 @@ module.exports = {
     // ----------------------------------------------------------------------
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
       CallExpression (node) {
         if (

diff --git a/lib/rules/require-meta-has-suggestions.js b/lib/rules/require-meta-has-suggestions.js
@@ -31,8 +31,8 @@ module.exports = {
     let ruleReportsSuggestions;
 
     return {
-      Program (node) {
-        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      Program (ast) {
+        contextIdentifiers = utils.getContextIdentifiers(sourceCode.scopeManager, ast);
       },
       CallExpression (node) {
         if (
@@ -71,7 +71,7 @@ module.exports = {
           if (!hasSuggestionsProperty) {
             // Rule reports suggestions but is missing the `meta.hasSuggestions` property altogether.
             context.report({
-              node: metaNode ? metaNode : ruleInfo.create,
+              node: metaNode || ruleInfo.create,
               messageId: 'shouldBeSuggestable',
               fix (fixer) {
                 if (metaNode && metaNode.type === 'ObjectExpression') {

diff --git a/lib/rules/require-meta-schema.js b/lib/rules/require-meta-schema.js
@@ -41,7 +41,7 @@ module.exports = {
     const sourceCode = context.getSourceCode();
     const { scopeManager } = sourceCode;
     const info = utils.getRuleInfo(sourceCode);
-    if (info === null || info.meta === null) {
+    if (info === null) {
       return {};
     }
 
@@ -57,7 +57,7 @@ module.exports = {
 
     return {
       Program (ast) {
-        contextIdentifiers = utils.getContextIdentifiers(context, ast);
+        contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
 
         schemaNode =
           metaNode &&
@@ -106,16 +106,16 @@ module.exports = {
       'Program:exit' () {
         if (!schemaNode && requireSchemaPropertyWhenOptionless) {
           context.report({
-            node: metaNode,
+            node: metaNode || info.create,
             messageId: 'missing',
-            suggest: isUsingOptions ? [] : [
+            suggest: !isUsingOptions && metaNode && metaNode.type === 'ObjectExpression' ? [
               {
                 messageId: 'addEmptySchema',
                 fix (fixer) {
                   return utils.insertProperty(fixer, metaNode, 'schema: []', sourceCode);
                 },
               },
-            ],
+            ] : [],
           });
         }
       },
@@ -130,7 +130,7 @@ module.exports = {
           node.property.name === 'options'
         ) {
           isUsingOptions = true;
-          context.report({ node: schemaNode || metaNode, messageId: 'foundOptionsUsage' });
+          context.report({ node: schemaNode || metaNode || info.create, messageId: 'foundOptionsUsage' });
         }
       },
     };

diff --git a/lib/rules/require-meta-type.js b/lib/rules/require-meta-type.js
@@ -31,20 +31,16 @@ module.exports = {
   },
 
   create (context) {
-    const sourceCode = context.getSourceCode();
-    const info = utils.getRuleInfo(sourceCode);
-
-    // ----------------------------------------------------------------------
-    // Helpers
-    // ----------------------------------------------------------------------
-
     // ----------------------------------------------------------------------
     // Public
     // ----------------------------------------------------------------------
 
     return {
       Program () {
-        if (info === null || info.meta === null) {
+        const sourceCode = context.getSourceCode();
+        const info = utils.getRuleInfo(sourceCode);
+
+        if (info === null) {
           return;
         }
 
@@ -55,7 +51,7 @@ module.exports = {
           metaNode.properties.find(p => p.type === 'Property' && utils.getKeyName(p) === 'type');
 
         if (!typeNode) {
-          context.report({ node: metaNode, messageId: 'missing' });
+          context.report({ node: metaNode || info.create, messageId: 'missing' });
           return;
         }