jsx-eslint/eslint-plugin-react

[jsx-handler-names] Option to enforce only for class methods

Open

#358 opened on Dec 11, 2015

View on GitHub
 (6 comments) (5 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
enhancementhelp wantedrule

Description

This is a useful rule, but it can sometimes get annoying when I want to use a prop or a method from a library directly as a handler. I think the real benefit to the rule is to force me to name my component's methods appropriately, but as it currently works, I sometimes need to do silly things like const handleSelect = props.entities.toggleItem;.

I would really like an option which prevents:

<MyComponent onChange={this.doSomething} />

// or in a stateless component:

<MyComponent onChange={doSomething} />

but still allows:

<MyComponent onChange={library.doSomething} />

<MyComponent onChange={this.props.doSomething} />

// or in a stateless component:

<MyComponent onChange={props.doSomething} />

Does that make any sense?

Contributor guide

Tech stack
javascriptreact
Domain
toolingdeveloper experiencefrontend
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of ESLint plugin developmentFamiliarity with React and JSX
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requests a new option for the 'jsx handler names' rule to allow non method handler references from props or library objects while still enforcing naming for class methods. The rule's source code is in the eslint plugin react repository; look for the rule definition in the 'lib/rules' directory. There are no linked PRs but there are 6 comments that may contain further discussion. To implement, consider adding a configuration option like 'ignoreMemberExpressions' or 'allowNonMethodHandlers' and update the rule logic accordingly.