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 (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 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

Research direction
Review existing eslint plugin react rules (e.g., no danger with children) to understand the pattern. Create a new rule that checks for DOM elements with contentEditable and children. Implement the rule in a new file under lib/rules/. Write tests and update documentation.
Tech stack
javascriptreactnodejs
Domain
frontendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
JavaScriptReactESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75