test: Add test for rule jsdoc type comment (#229)

eslint-community · Nov 17, 2021 · 3568bc4 · 3568bc4
1 parent de1e2f0
commit 3568bc4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/tests/lib/rule-setup.js b/tests/lib/rule-setup.js
@@ -70,6 +70,16 @@ describe('rule setup is correct', () => {
           const ALLOWED_CATEGORIES = ['Rules', 'Tests'];
           assert.ok(ALLOWED_CATEGORIES.includes(rule.meta.docs.category), 'has an allowed category');
         });
+
+        it('should have the right contents', () => {
+          const filePath = path.join(__dirname, '..', '..', 'lib', 'rules', `${ruleName}.js`);
+          const file = readFileSync(filePath, 'utf8');
+
+          assert.ok(
+            file.includes("/** @type {import('eslint').Rule.RuleModule} */"),
+            'includes jsdoc comment for rule type'
+          );
+        });
       });
     }
   });