test: add test for rule jsdoc type comment

sindresorhus · Nov 16, 2021 · bdd6dde · bdd6dde
1 parent a3670e3
commit bdd6dde
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/test/package.mjs b/test/package.mjs
@@ -187,6 +187,17 @@ test('Every deprecated rules listed in docs/deprecated-rules.md', async t => {
 	}
 });
 
+test('Every rule file has the appropriate contents', t => {
+	for (const ruleFile of ruleFiles) {
+		const ruleName = path.basename(ruleFile, '.js');
+		const rule = index.rules[ruleName];
+		const rulePath = path.join('rules', `${ruleName}.js`);
+		const ruleContents = fs.readFileSync(rulePath, 'utf8');
+
+		t.true(ruleContents.includes("/** @type {import('eslint').Rule.RuleModule} */"), `${ruleName} includes jsdoc comment for rule type`);
+	}
+});
+
 test('Every rule has a doc with the appropriate content', t => {
 	for (const ruleFile of ruleFiles) {
 		const ruleName = path.basename(ruleFile, '.js');