gajus/eslint-plugin-jsdoc

`jsdoc/check-param-names` should be fixable if order is wrong

Open

#47 opened on Oct 25, 2017

View on GitHub
 (10 comments) (1 reaction) (0 assignees)JavaScript (172 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

I saw that another eslint plugin detects merely incorrect parameter order. It would be nice if this could be automatically fixed. You would have to ensure object properties are kept with param, and it could also (if this is preferred) move the @returns to the end.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

Research direction
Investigate the `jsdoc/check param names` rule logic and AST structure to design an autofix that reorders parameters, preserves object properties, and optionally moves `@returns` to the end.
Tech stack
javascript
Domain
toolingdeveloper experience
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.
Half day
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
ESLintJSDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50