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 (8,630 stars) (2,797 forks)batch import
help wantednew rule

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

Tech stack
javascriptreact
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
JavaScriptReactESLint plugin developmentAST basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the React DOM component source linked in the issue to understand the warning condition. Review existing rules in eslint plugin react, such as no danger with children, for implementation patterns. Check the single comment on the issue for any additional context. Investigate the rule creation process: adding to rules/index.js, writing tests, and documentation. Consider edge cases like custom components using innerHTML correctly or props spreading.