jsx-eslint/eslint-plugin-react

[feat-request] prefer-create-ref

Open

#2237 opened on Apr 12, 2019

View on GitHub
 (1 comment) (4 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
help wantednew rule

Description

This is a feature request. In React it is possible to create references to elements in 3 different ways, including one deprecated (string refs, for this there is the no-string-refs rule). To improve consistency of what approach to be used for refs it would be nice to have a prefer-create-ref rule, maybe other naming also in favor of callback refs.

Contributor guide

Tech stack
javascriptreact
Domain
frontenddeveloper 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.
1-2 days
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.
mostly clear
Prerequisites
React refsESLint rule developmentJavaScript AST
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine existing rules in the eslint plugin react repository (e.g., no string refs) for implementation patterns. The issue requests a new rule 'prefer create ref' to enforce using createRef over other ref patterns. Review the ESLint custom rule documentation and AST for JSX. The comment on the issue (if any) may contain maintainer feedback; check the conversation for additional context. Start by creating a new rule file in the 'lib/rules' directory and corresponding test file.