Is there a way to disable jsdoc on react components?

[antspy]

JSDocs does not work well with react components (it requires a bunch of weird parameters like root0 or internal react stuff).

Is there a way to disable it for react components? Or perhaps disable it on .tsx / .jsx files?

Thank you!

[brettz9]

See #272 (comment)

Closing as that should resolve, but feel free to comment further as needed.

[antspy]

Thank you @brettz9 !

From what I can see, this is a bit outdated, and does not really work with functional components that are common in new React code.

There is one comment trying to address this, but the poster mentions that it was too brittle and what they end up doing was to simply disable js-docs on functions that start with an upper case letter. This seems quite suboptimal.

I understand it might be hard to specifically target React components, but adding an option to disable jsdocs on .tsx/jsx files at least is trivial. Would it be possible to add that, so that people can easily disable the plugin?

Thank you!

[brettz9]

For flat config, you should be able to put {ignore: ['**/*.tsx', '**/*.jsx']} as your first object in the config. Either that or add files to specify which files you do want to be included where the jsdoc rules apply.

[antspy]

Thank you! For posterity:

  {
    ...jsdoc.configs['flat/recommended-typescript'],
    files: ['**/*.js', '**/*.ts'],
  },