[Suggestion]: Add types to React compiler debugging example
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 11.8k
- Forks
- 7.9k
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 11
Beschreibung
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
Details
Adding types would be helpful for IntelliSense and would also help avoid potential errors.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem im Issue verlinkten grundlegenden Logging-Beispiel in der Debugging-Dokumentation des React compiler. Aktualisiere das Beispiel, um den vorgeschlagenen TypeScript-Import und die Erfüllung von Logger zu demonstrieren, und überprüfe anschließend, dass das angezeigte Beispiel typisierte Logger-Ereignisse enthält und mit der umgebenden Dokumentation konsistent bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 50/100