winglang/wing

CLI option for error formatting style `--message-format`

Open

#1829 aperta il 15 mar 2023

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (214 fork)github user discovery
good first issue⌨️ cli✨ enhancement

Metriche repository

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

Descrizione

Community Note

Please vote by adding a 👍 reaction to the issue to help us prioritize. If you are interested to work on this issue, please leave a comment.

Feature Spec

Add an option to the CLI for choosing how errors are formatted, such as in a "short" format (that does not show code snippets" or a "json" format. Naming suggestions welcome

Use Cases

When users do not want to fully detailed diagnostics and renderings of their code snippets, or they want to parse Wing errors programmatically.

Implementation Notes

The library used by the CLI for rendering error messages supports a few rendering styles, and the wing compiler also is capable of producing errors as JSON as well (though the format is ad-hoc at the moment).

Component

CLI

Guida contributor

Direzione di ricerca
Esamina il parsing degli argomenti CLI esistente (ad esempio con yargs o commander) e il modulo di rendering degli errori (probabilmente in src/). Aggiungi una nuova opzione ` message format` che accetta 'short' o 'json', e mappala agli stili di visualizzazione di codespan reporting o al formattatore JSON degli errori nel compilatore. Prova eseguendo `wing compile` con la nuova opzione.
Tech stack
typescript
Dominio
cli
Tipo issue
Funzionalità
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitTypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70