jsx-eslint/eslint-plugin-react

Rule proposal: ssr-friendly

Open

#2,057 opened on Nov 26, 2018

View on GitHub
 (21 comments) (23 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
acceptedhelp wantednew rule

Description

In order to be SSR compliant, you can only access browser globals such as window, document and so on, inside of componentDidMount, componentDidUpdate and componentWillUnmount

A rule could be created to avoid the use of unguarded browser globals in other lifecycle methods.

Example of a guard:

if (typeof window !== 'undefined') {
 // I can use browser globals in here
}

Use of browser globals are allowed when:

  • used in a guard
  • used in componentDidMount, componentDidUpdate and componentWillUnmount
  • used in useEffect or useLayoutEffect
  • used in an event handler

Contributor guide

Tech stack
javascriptreact
Domain
frontendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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 developmentReact lifecycle methodsSSR concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
To implement this rule, examine existing rules in eslint plugin react for structural patterns, such as how they traverse AST and report violations. Study React's official lifecycle documentation and SSR guidelines to understand which lifecycle methods allow browser globals. Consider referencing the linked lifecycle diagram and the React.Component docs. Look at how guards like `typeof window !== 'undefined'` can be detected using AST visitors.