jsx-eslint/eslint-plugin-react

Rule proposal: disallow children on DOM element tags when contentEditable

Open

#713 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 use contentEditable with children. This can be suppressed with suppressContentEditableWarning.

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

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

Bad:

<div contentEditable>
  Children
</div>

Good:

<div contentEditable />

<div contentEditable suppressContentEditableWarning>
  Children
</div>

Contributor guide

Tech stack
javascriptreact
Domain
tooling
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
ESLint plugin structureReact JSXAST understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Study existing ESLint rules in this plugin (e.g., no unknown property) to understand pattern. Implement rule to detect children on DOM elements with contentEditable attribute without suppressContentEditableWarning. Write unit tests. Reference React source at https://github.com/facebook/react/blob/85dcbf83/src/renderers/dom/shared/ReactDOMComponent.js#L187 L193 for context.