[Suggestion]: Add types to React compiler debugging example

Aperta
#8,245 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
50/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
react, typescript
Ambito
documentation

Direzione di ricerca

Inizia dall’esempio di logging di base della documentazione sul debugging di React compiler collegato nell’issue. Aggiorna l’esempio per dimostrare l’import TypeScript proposto e la soddisfazione di Logger, quindi verifica che l’esempio mostrato includa eventi Logger tipizzati e rimanga coerente con la documentazione circostante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

type: documentation
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.

Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
16h 6m
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactjs/react.dev

Tutte le issue di reactjs/react.dev

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.