add jsdoc to help hint the shape better

jsx-eslint · Feb 21, 2024 · d1465bc · d1465bc
1 parent f4159ab
commit d1465bc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/configs/all.js b/configs/all.js
@@ -9,6 +9,10 @@ function filterRules(rules, predicate) {
   return fromEntries(entries(rules).filter((entry) => predicate(entry[1])));
 }
 
+/**
+ * @param {object} rules - rules object mapping rule name to rule module
+ * @returns {Record<string, 2>}
+ */
 function configureAsError(rules) {
   return fromEntries(Object.keys(rules).map((key) => [`react/${key}`, 2]));
 }
@@ -20,6 +24,12 @@ const deprecatedRules = filterRules(allRules, (rule) => rule.meta.deprecated);
 
 module.exports = {
   plugins: {
+    /**
+     * @type {{
+     *   deprecatedRules: Record<string, import('eslint').Rule.RuleModule>,
+     *   rules: Record<string, import('eslint').Rule.RuleModule>,
+     * }}
+     */
     react: {
       deprecatedRules,
       rules: allRules,

diff --git a/lib/rules/index.js b/lib/rules/index.js
@@ -2,6 +2,7 @@
 
 /* eslint global-require: 0 */
 
+/** @satisfies {Record<string, import('eslint').Rule.RuleModule>} */
 module.exports = {
   'boolean-prop-naming': require('./boolean-prop-naming'),
   'button-has-type': require('./button-has-type'),