facebookarchive/prepack

Review all FatalError throws

Open

#2020 aperta il 24 mag 2018

Vedi su GitHub
 (2 commenti) (2 reazioni) (0 assegnatari)JavaScript (520 fork)batch import
bughelp wanted

Metriche repository

Star
 (14.268 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

I've seen a few code snippets like this:

    // todo: emit a diagnostic messsage
    throw new FatalError();

This is problematic for two reasons:

  1. User doesn't get any useful feedback.
  2. Worse, on the command-line it will show up as an internal error, because there must not be a FatalError without a CompilerDiagnostic thingy having been issued.

Concrete work items:

  1. Review all places in the code where a FatalError is thrown, and make sure that a corresponding CompilerDiagnostic thingy was issued before.
  2. Rethink best practices, as it is too easy to create mismatches between FatalError and CompilerDiagnostic (how did this get past code review?).

Guida contributor

Direzione di ricerca
Rivedi tutte le occorrenze di `throw new FatalError()` nella codebase di Prepack. Per ciascuna, verifica se viene emesso un `CompilerDiagnostic` prima del lancio. Il problema menziona che alcuni punti hanno un commento TODO senza una diagnostica. Esamina le PR o i commenti collegati per eventuali discussioni precedenti. I file probabilmente includono moduli di gestione degli errori del compilatore.
Tech stack
javascript
Dominio
developer experiencetooling
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Understanding of FatalError and CompilerDiagnostic in prepack
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30