jsx-eslint/eslint-plugin-react

Rule proposal: forbid innerHTML prop on DOM element tags

Open

#712 opened on Jul 26, 2016

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

Repository metrics

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

Description

React will issue a warning in dev if you try to use pass innerHTML prop to a DOM element tag.

https://github.com/facebook/react/blob/85dcbf83/src/renderers/dom/shared/ReactDOMComponent.js#L182-L184

This should be easy enough to enforce for most cases with a linter rule.

Bad:

<div innerHTML='HTML' />

Good:

<div dangerouslySetInnerHTML={{ __html: 'HTML' }} />

Contributor guide

Research direction
Examine existing ESLint rules in the plugin for patterns, then implement a rule that detects the innerHTML prop on DOM elements by checking JSX attribute names and element types. Reference the React source code for the warning message and conditions.
Tech stack
javascriptreact
Domain
developer experiencetooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65