jsx-eslint/eslint-plugin-react

Rule proposal: ssr-friendly

Open

#2,057 建立於 2018年11月26日

在 GitHub 查看
 (21 留言) (23 反應) (0 負責人)JavaScript (8,630 star) (2,797 fork)batch import
acceptedhelp wantednew rule

描述

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

貢獻者指南

技術棧
javascriptreact
領域
frontendtooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
ESLint plugin developmentReact lifecycle methodsSSR concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
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.