Fix: Ensure require-meta-* rules test null/undefined property values (

#164) We need to ensure that the rules correctly handle `null` / `undefined` as the value of the meta properties since these values are commonly used as placeholder values.
eslint-community · Jul 12, 2021 · 990f8f6 · 990f8f6 · aladdin-add · Jul 12, 2021
1 parent cb9276e
commit 990f8f6
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/lib/rules/require-meta-schema.js b/lib/rules/require-meta-schema.js
@@ -68,7 +68,7 @@ module.exports = {
         }
 
         let { value } = schemaNode;
-        if (value.type === 'Identifier') {
+        if (value.type === 'Identifier' && value.name !== 'undefined') {
           const variable = findVariable(
             scopeManager.acquire(value) || scopeManager.globalScope,
             value

diff --git a/tests/lib/rules/require-meta-docs-description.js b/tests/lib/rules/require-meta-docs-description.js
@@ -134,6 +134,26 @@ ruleTester.run('require-meta-docs-description', rule, {
       output: null,
       errors: [{ messageId: 'wrongType', type: 'Literal' }],
     },
+    {
+      code: `
+        module.exports = {
+          meta: { docs: { description: null } },
+          create(context) {}
+        };
+      `,
+      output: null,
+      errors: [{ messageId: 'wrongType', type: 'Literal' }],
+    },
+    {
+      code: `
+        module.exports = {
+          meta: { docs: { description: undefined } },
+          create(context) {}
+        };
+      `,
+      output: null,
+      errors: [{ messageId: 'wrongType', type: 'Identifier' }],
+    },
     {
       code: `
         const DESCRIPTION = true;

diff --git a/tests/lib/rules/require-meta-has-suggestions.js b/tests/lib/rules/require-meta-has-suggestions.js
@@ -74,6 +74,24 @@ ruleTester.run('require-meta-has-suggestions', rule, {
       }
     };
     `,
+    // No suggestions reported, hasSuggestions property set to `null`.
+    `
+    module.exports = {
+      meta: { hasSuggestions: null },
+      create(context) {
+        context.report({node, message});
+      }
+    };
+    `,
+    // No suggestions reported, hasSuggestions property set to `undefined`.
+    `
+    module.exports = {
+      meta: { hasSuggestions: undefined },
+      create(context) {
+        context.report({node, message});
+      }
+    };
+    `,
     // No suggestions reported, hasSuggestions property set to false (as variable).
     `
     const hasSuggestions = false;

diff --git a/tests/lib/rules/require-meta-schema.js b/tests/lib/rules/require-meta-schema.js
@@ -129,6 +129,16 @@ schema: [] },
       output: null,
       errors: [{ messageId: 'wrongType', type: 'Literal' }],
     },
+    {
+      code: `
+        module.exports = {
+          meta: { schema: undefined },
+          create(context) {}
+        };
+      `,
+      output: null,
+      errors: [{ messageId: 'wrongType', type: 'Identifier' }],
+    },
     {
       code: `
         const schema = null;