gajus/eslint-plugin-jsdoc

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

開放

#869 建立於 2022年4月9日

 (1 則留言) (3 個反應) (0 位負責人)JavaScript (176 個分叉)github user discovery
enhancementhelp wanted

倉庫指標

星標
 (1,227 顆星)
PR 合併指標
 (平均合併 2天 8小時) (30 天內合併 10 個 PR)

描述

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.

貢獻者指南