jsx-eslint/eslint-plugin-react

Rule proposal: no layout thrashing

Open

#1,889 opened on Jul 20, 2018

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

Repository metrics

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

Description

I've seen a lot of seemingly simple code lead to layout thrashing and performance problems that could have been statically detected and avoided. It would be nice to have a rule that could flag some of these scenarios.

I think it might make sense to take Paul Irish's list of what causes layout/reflow, and write a rule that flags when these happen synchronously in places like componentDidMount, render, and componentWillReceiveProps, etc.

Example:

class Foo extends React.Component {
  constructor(props) {
    super(props);

    this.state = {
      windowHeight: window.innerHeight, // <-- this forces layout
    };
  }
  // ...
}

Thoughts?

Contributor guide

Research direction
Study Paul Irish's list of layout thrashing properties, identify common patterns in React lifecycle methods, and implement an ESLint rule that flags synchronous layout reads/writes in appropriate hooks and lifecycle methods.
Tech stack
javascriptreact
Domain
frontend
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
JavaScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40