jsx-eslint/eslint-plugin-react

Add `reactLibrary` setting

Open

#2904 opened on Jan 17, 2021

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

Description

Add a reactLibrary setting for the name of the React library (defaults to 'react'). This would be helpful for Preact users.

Currently, the jsx-fragments rule (set to syntax) doesn't warn about this:

import {Fragment} from 'preact'

const foo = <Fragment>foo</Fragment>

Checking for the configured reactLibrary setting instead of the hard-coded 'react' would make this rule (and possibly others, I haven't really looked into this plugin that much) more flexible.

Contributor guide

Tech stack
javascriptreactnodejs
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.
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.
clear
Prerequisites
familiarity with ESLint plugin architectureknowledge of React JSX syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding a `reactLibrary` setting to the plugin, defaulting to `'react'`, and updating rules like `jsx fragments` to use it instead of hardcoding `'react'`. To implement, examine the current rule definitions in `rules/jsx fragments.js` and the plugin's schema in `index.js`. Look for any existing related settings (e.g., `reactLibrary`) already discussed in comments. The change should allow users to specify a library name like `'preact'` for fragment detection.