fix(require-param): ensure all structures with interfaces do not trigger with interfaceExemptsParamsCheck: true

Author: brettz9

docs/rules/require-param.md

@@ -1998,5 +1998,16 @@ function quux ({
 }: FunctionInterface) {
 }
 // "jsdoc/require-param": ["error"|"warn", {"interfaceExemptsParamsCheck":true}]
+
+/**
+ *
+ */
+export async function fetchMarketstackEOD(
+  parameters: FetchEODParameters,
+): Promise<MarketstackDataPoint[]>
+{
+  // ...
+};
+// "jsdoc/require-param": ["error"|"warn", {"interfaceExemptsParamsCheck":true}]
 ````
 

src/iterateJsdoc.js

@@ -257,6 +257,7 @@ import esquery from 'esquery';
 /**
  * @callback GetFunctionParameterNames
  * @param {boolean} [useDefaultObjectProperties]
+ * @param {boolean} [ignoreInterfacedParameters]
  * @returns {import('./jsdocUtils.js').ParamNameInfo[]}
  */
 
@@ -1369,8 +1370,8 @@ const getUtils = (
   utils.flattenRoots = jsdocUtils.flattenRoots;
 
   /** @type {GetFunctionParameterNames} */
-  utils.getFunctionParameterNames = (useDefaultObjectProperties) => {
-    return jsdocUtils.getFunctionParameterNames(node, useDefaultObjectProperties);
+  utils.getFunctionParameterNames = (useDefaultObjectProperties, ignoreInterfacedParameters) => {
+    return jsdocUtils.getFunctionParameterNames(node, useDefaultObjectProperties, ignoreInterfacedParameters);
   };
 
   /** @type {HasParams} */

src/jsdocUtils.js

@@ -203,11 +203,12 @@ const getPropertiesFromPropertySignature = (propSignature) => {
 /**
  * @param {ESTreeOrTypeScriptNode|null} functionNode
  * @param {boolean} [checkDefaultObjects]
+ * @param {boolean} [ignoreInterfacedParameters]
  * @throws {Error}
  * @returns {ParamNameInfo[]}
  */
 const getFunctionParameterNames = (
-  functionNode, checkDefaultObjects,
+  functionNode, checkDefaultObjects, ignoreInterfacedParameters,
 ) => {
   /* eslint-disable complexity -- Temporary */
   /**
@@ -230,6 +231,19 @@ const getFunctionParameterNames = (
     const hasLeftTypeAnnotation = 'left' in param && 'typeAnnotation' in param.left;
 
     if ('typeAnnotation' in param || hasLeftTypeAnnotation) {
+      if (ignoreInterfacedParameters && 'typeAnnotation' in param &&
+        param.typeAnnotation) {
+        // No-op
+        return [
+          undefined, {
+            hasPropertyRest: false,
+            hasRestElement: false,
+            names: [],
+            rests: [],
+          },
+        ];
+      }
+
       const typeAnnotation = hasLeftTypeAnnotation ?
         /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */ (
           param.left

src/rules/requireParam.js

@@ -65,19 +65,10 @@ export default iterateJsdoc(({
     useDefaultObjectProperties = false,
   } = context.options[0] || {};
 
-  if (interfaceExemptsParamsCheck) {
-    if (node && 'params' in node && node.params.length === 1 &&
-        node.params?.[0] && typeof node.params[0] === 'object' &&
-        node.params[0].type === 'ObjectPattern' &&
-        'typeAnnotation' in node.params[0] && node.params[0].typeAnnotation
-    ) {
-      return;
-    }
-
-    if (node && node.parent?.type === 'VariableDeclarator' &&
-        'typeAnnotation' in node.parent.id && node.parent.id.typeAnnotation) {
-      return;
-    }
+  if (interfaceExemptsParamsCheck && node &&
+    node.parent?.type === 'VariableDeclarator' &&
+    'typeAnnotation' in node.parent.id && node.parent.id.typeAnnotation) {
+    return;
   }
 
   const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({
@@ -87,7 +78,7 @@ export default iterateJsdoc(({
     return;
   }
 
-  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);
+  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties, interfaceExemptsParamsCheck);
   if (!functionParameterNames.length) {
     return;
   }

test/rules/assertions/requireParam.js

@@ -3953,5 +3953,26 @@ export default /** @type {import('../index.js').TestCases} */ ({
         },
       ],
     },
+    {
+      code: `
+        /**
+         *
+         */
+        export async function fetchMarketstackEOD(
+          parameters: FetchEODParameters,
+        ): Promise<MarketstackDataPoint[]>
+        {
+          // ...
+        };
+      `,
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+      options: [
+        {
+          interfaceExemptsParamsCheck: true,
+        },
+      ],
+    },
   ],
 });