gajus/eslint-plugin-jsdoc

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

Open

#869 创建于 2022年4月9日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)JavaScript (172 fork)github user discovery
enhancementhelp wanted

仓库指标

Star
 (1,215 star)
PR 合并指标
 (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.

贡献者指南