Cannot use "this" in a typescript function declaration

[a88zach]

Expected behavior

A user should be able to document a function in Typescript that uses the "this" keyword

Actual behavior

Conflicting rules prevent this from passing warnings.

• When @param this is declared the warning is:
  

• When @param this is removed the warning is:
  

ESLint Config

module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:jsdoc/recommended',
  ],
  overrides: [],
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint', 'jsdoc'],
  root: true,
  rules: {
    'jsdoc/require-param-type': 0,
    'jsdoc/require-returns-type': 0,
    'jsdoc/no-types': 2,
  },
};

ESLint sample

type T = { name: string };

/**
 * @param this desc
 * @param bar number to return
 * @returns number returned back to caller
 */
function foo(this: T, bar: number): number {
  console.log(this.name);
  return bar;
}

const bound = foo.bind({ name: 'baz' });

bound(2);

type T = { name: string };

/**
 * @param bar number to return
 * @returns number returned back to caller
 */
function foo(this: T, bar: number): number {
  console.log(this.name);
  return bar;
}

const bound = foo.bind({ name: 'baz' });

bound(2);

Environment

• Node version: 16
• ESLint version 8.25.0
• eslint-plugin-jsdoc version: 39.3.14

[gajus]

🎉 This issue has been resolved in version 39.3.16 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[brettz9]

I've resumed tolerating @param this in check-param-names, but we really still need to support this: xyz being ignored as a param in require-param whether the user is documenting it with the (also TS-sanctioned) @this or with @param this.

[brettz9]

I've gone ahead and also made require-param more tolerant in accepting @param this. However, since TS supports @this, it might be a better idea to ensure that the this object is documented with @this rather than as a param.

[gajus]

🎉 This issue has been resolved in version 39.3.19 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀