sindresorhus/eslint-plugin-unicorn

Autofix for unicorn/prevent-abbreviations and JSDoc

Closed

#733 opened on May 17, 2020

View on GitHubContributor guide
 (3 comments) (2 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Autofix for unicorn/prevent-abbreviations must either don't touch function parameters or rename them in JSDoc when it exists or it will break a code (the JSDoc based type check, documentation, etc).

Contributor guide

Research direction
The issue proposes modifying the autofix of the unicorn/prevent abbreviations rule to either skip renaming function parameters or update the corresponding JSDoc. To determine the best approach, examine the rule's source file (likely in rules/prevent abbreviations.js) and its test file. Look for existing tests related to autofix and JSDoc. Review the linked issue comments for any maintainer guidance. Implement a solution that ensures JSDoc type annotations remain consistent after renaming.
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.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
ESLint plugin developmentJSDoc syntaxJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20