fix(require-param): be tolerant if this is not included as @param; fixes #919

Author: brettz9

README.md

@@ -16916,6 +16916,25 @@ function Item({
 export function testFn1 ({ prop = { a: 1, b: 2 } }) {
 }
 // "jsdoc/require-param": ["error"|"warn", {"useDefaultObjectProperties":false}]
+
+/**
+ * @param this The this object
+ * @param bar number to return
+ * @returns number returned back to caller
+ */
+function foo(this: T, bar: number): number {
+  console.log(this.name);
+  return bar;
+}
+
+/**
+ * @param bar number to return
+ * @returns number returned back to caller
+ */
+function foo(this: T, bar: number): number {
+  console.log(this.name);
+  return bar;
+}
 ````
 
 

src/rules/requireParam.js

@@ -296,7 +296,7 @@ export default iterateJsdoc(({
       name,
     }) => {
       return name === funcParamName;
-    })) {
+    }) && funcParamName !== 'this') {
       missingTags.push({
         functionParameterIdx: getParamIndex(funcParamName),
         functionParameterName: funcParamName,

test/rules/assertions/requireParam.js

@@ -3455,5 +3455,32 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      /**
+       * @param this The this object
+       * @param bar number to return
+       * @returns number returned back to caller
+       */
+      function foo(this: T, bar: number): number {
+        console.log(this.name);
+        return bar;
+      }
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
+    {
+      code: `
+      /**
+       * @param bar number to return
+       * @returns number returned back to caller
+       */
+      function foo(this: T, bar: number): number {
+        console.log(this.name);
+        return bar;
+      }
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
 };