eslint-plugin-jsdoc icon indicating copy to clipboard operation
eslint-plugin-jsdoc copied to clipboard

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

Open seahindeniz opened this issue 2 years ago • 1 comments

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.

seahindeniz avatar Apr 09 '22 12:04 seahindeniz

Sounds like a good option to add. Note that although their logic may be more complicated, there are a couple bugs on the param checking rules (#540 and #762 ) that we can hopefully get fixed.

brettz9 avatar Apr 09 '22 13:04 brettz9