gajus/eslint-plugin-jsdoc

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

Aberta

#869 aberto em 9 de abr. de 2022

 (1 comentário) (3 reações) (0 responsável)JavaScript (176 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (1.227 estrelas)
Métricas de merge de PR
 (Mesclagem média 2d 8h) (10 fundiu PRs em 30d)

Description

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.

Guia do colaborador