Replace valid-jsdoc rule with eslint-plugin-jsdoc for eslint

Created on 11 March 2022, over 3 years ago
Updated 19 March 2025, 4 months ago

Problem/Motivation

Drupal's ESLint configuration, which contrib projects are also encouraged to use β†’ , uses the valid-jsdoc rule, which has been deprecated.

The ESLint team recommends using eslint-plugin-jsdoc instead.

<!--<h4 id="summary-steps-reproduce">Steps to reproduce</h4>-->

Proposed resolution

Stop using the valid-jsdoc rule in Drupal's ESLint configuration. Begin using eslint-plugin-jsdoc instead. For now, configure eslint-plugin-jsdoc similarly to how the valid-jsdoc is configured now, to minimize rework. In the future, consider using more features from eslint-plugin-jsdoc, as it is quite a bit more powerful than the valid-jsdoc rule.

Remaining tasks

User interface changes

API changes

Data model changes

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component

javascript

Created by

πŸ‡ΊπŸ‡ΈUnited States john.karahalis

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024