Add jsdoc type to externally-exported rules (#1613)

sindresorhus · Nov 18, 2021 · 2e22382 · 2e22382
1 parent ba64055
commit 2e22382
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/rules/utils/create-deprecated-rules.js b/rules/utils/create-deprecated-rules.js
@@ -3,6 +3,7 @@ const packageJson = require('../../package.json');
 
 const repoUrl = 'https://github.com/sindresorhus/eslint-plugin-unicorn';
 
+/** @returns {{ [ruleName: string]: import('eslint').Rule.RuleModule }} */
 function createDeprecatedRules(data) {
 	return Object.fromEntries(
 		Object.entries(data).map(([ruleId, replacedBy = []]) => [

diff --git a/rules/utils/rule.js b/rules/utils/rule.js
@@ -74,6 +74,7 @@ function checkVueTemplate(create, options) {
 	return wrapped;
 }
 
+/** @returns {import('eslint').Rule.RuleModule} */
 function loadRule(ruleId) {
 	const rule = require(`../${ruleId}`);