gajus/eslint-plugin-jsdoc

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

Open

#869 opened on Apr 9, 2022

View on GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (172 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,215 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Examine the `require param` rule implementation to understand how it currently generates fix suggestions. Then implement a new rule option (e.g., `objectSyntax`) that changes the fix to produce object destructuring syntax in the @param tags.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70