question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Remove `require-jsdoc` and `valid-jsdoc` (and `doctrine`)

See original GitHub issue

ESLint version

v8.14.0

What problem do you want to solve?

The require-jsdoc and valid-jsdoc rules were deprecated a good while ago, but despite having replacements in eslint-plugin-jsdoc, a major version change hasn’t removed them.

What do you think is the correct solution?

For the next major version, I think we should remove the rules (and the doctrine dependency which is only being used by these rules).

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:3
  • Comments:8 (7 by maintainers)

github_iconTop GitHub Comments

3reactions
nzakascommented, Apr 29, 2022

I think it’s at least worth having a discussion in this case considering that these rules require a dependency that isn’t used anywhere else in ESLint.

2reactions
nzakascommented, Apr 29, 2022

We can put this on the board for v9.0.0.

Read more comments on GitHub >

github_iconTop Results From Across the Web

End-of-Life for Built-in JSDoc Support in ESLint
The require-jsdoc and valid-jsdoc rules will be deprecated. These two rules will remain in ESLint but we will no longer add new features...
Read more >
How do I configure ESLint to check for TypeScript class ...
Firstly, I should note that eslint-plugin-jsdoc 's rules are incremental. If you don't have any jsdoc block at all, you first need to...
Read more >
How to disable require jsdoc in esLint? - YouTube
How to disable require jsdoc in esLint?Welcome to Kimavi Super Simple Educational Videos.How to disable require jsdoc in esLint?
Read more >
Diff - plugins/task - Google Git
... + "jsdoc/valid-types": 2, + "jsdoc/require-file-overview": [ + "error", ... + object-keys "^1.0.12" + +doctrine@^2.1.0: + version "2.1.0" + resolved ...
Read more >
ESLint の組み込み JSDoc サポートが終了します - Qiita
require -jsdoc と valid-jsdoc ルールは非推奨になります。私たちのルール非推奨ポリシーに従い、これらのルールはすぐには削除されませんが、機能追加や ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found