gajus/eslint-plugin-jsdoc

Applying fixes with object syntax via `require-param` rule

Open

#869 geöffnet am 9. Apr. 2022

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (172 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (1.215 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Hi, Is there any setting/option to make the require-param rule to apply fixes by adding an object instead of properties in new lines? If not, I think moving forward with a new proposal should be acceptable 🙏🏻

Motivation

Applying fixes with object syntax in @param declarations.

Current behavior

/**
 * @param root0
 * @param root0.bar
 * @returns {void}
 */
const foo = ({ bar }) => {};

Desired behavior

/**
 * @param {{ bar: any }} param0
 * @returns {void}
 */
const foo = ({ bar }) => {};

Alternatives considered

If it is worth to mention, copy-pasting types from TypeScript files with object syntax, makes it easier to adapt it into JSDoc.

Contributor Guide