reactjs / reactjs/react.dev

[Suggestion]: Add types to React compiler debugging example

Aberta
#8,245 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

type: documentation
Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

Summary

Hello I noticed that the examples on the debugging page (https://react.dev/reference/react-compiler/logger#basic-logging) for the compiler don’t include TypeScript types. It might be helpful to add them for the basic example like so

import type { Logger } from 'babel-plugin-react-compiler';

{
...
  logger: {
    logEvent(filename, event) {
      switch (event.kind) {
        case 'CompileSuccess': {
          console.log(`✅ Compiled: ${filename}`);
          break;
        }
        case 'CompileError': {
          console.log(`❌ Skipped: ${filename}`);
          break;
        }
        default: {}
      }
    }
  } satisfies Logger,
...
}

Using satisfies Logger ensures that logEvent(filename, event) is properly typed without needing to manually annotate the parameters.

Cheers

Page

Compiler debugging docs

Details

Adding types would be helpful for IntelliSense and would also help avoid potential errors.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pelo exemplo básico de logging da documentação de depuração do React compiler vinculado na issue. Atualize o exemplo para demonstrar o import proposto de TypeScript e a satisfação de Logger e, em seguida, verifique se o exemplo exibido inclui eventos de Logger tipados e permanece consistente com a documentação ao redor.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
react, typescript
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
50/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.