jsx-eslint/eslint-plugin-react

Rule proposal: ssr-friendly

Aperta

#2057 aperta il 26 nov 2018

Vedi su GitHubGuida contributor
 (21 commenti) (23 reazioni) (0 assegnatari)JavaScript (2731 fork)batch import
acceptedhelp wantednew rule

Metriche repository

Star
 (9293 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Analizza le regole esistenti in eslint plugin react per comprendere il modello per creare una nuova regola. Quindi implementa una regola che rilevi variabili globali del browser non protette (es. window, document) in metodi del ciclo di vita diversi da componentDidMount, componentDidUpdate, componentWillUnmount, useEffect, useLayoutEffect e gestori di eventi. Considera di fornire opzioni di correzione automatica e gestire guardie come 'typeof window !== "undefined"'.
Tech stack
javascriptreact
Dominio
frontendtooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ReactESLint
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60