jsx-eslint/eslint-plugin-react

Rule proposal: ssr-friendly

Aberta

#2.057 aberto em 26 de nov. de 2018

Ver no GitHubGuia do colaborador
 (21 comentários) (23 reações) (0 responsável)JavaScript (2.731 forks)batch import
acceptedhelp wantednew rule

Métricas do repositório

Stars
 (9.293 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Analise as regras existentes no eslint plugin react para entender o padrão de criação de uma nova regra. Em seguida, implemente uma regra que detecte variáveis globais do navegador não protegidas (ex.: window, document) em métodos de ciclo de vida diferentes de componentDidMount, componentDidUpdate, componentWillUnmount, useEffect, useLayoutEffect e manipuladores de eventos. Considere fornecer opções de correção automática e lidar com guardas como 'typeof window !== "undefined"'.
Pilha de tecnologia
javascriptreact
Domain
frontendtooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
ReactESLint
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60