jsx-eslint/eslint-plugin-react

Rule Suggestion: Forbid Classes / Classnames

Open

#1,193 opened on May 13, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (2,797 forks)batch import
acceptedenhancementhelp wantednew rule

Repository metrics

Stars
 (8,630 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We have a font-awesome <Icon> component that handles accessibility nicely. However, it's still really easy for people to write <i className="fa ...">. It would be nice if we could ban a class based on matching a regex. Obviously, it's tricky/impossible to ban every possible use if people are doing things at runtime, but it would be nice if I could say no to a fair number of cases where this comes up.

Contributor guide

Research direction
Explore the ESLint plugin architecture, create a new rule file, and implement detection of class names matching a regex pattern. Refer to existing rules for patterns.
Tech stack
javascriptreact
Domain
developer 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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60