winglang/wing

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

Open

#1.829 aberto em 15 de mar. de 2023

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue⌨️ cli✨ enhancement

Métricas do repositório

Stars
 (5.385 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Examine a análise de argumentos da CLI existente (por exemplo, usando yargs ou commander) e o módulo de renderização de erros (provavelmente em src/). Adicione uma nova opção ` message format` que aceita 'short' ou 'json' e mapeie a para os estilos de exibição do codespan reporting ou o formatador de erros JSON no compilador. Teste executando `wing compile` com a nova flag.
Pilha de tecnologia
typescript
Domain
cli
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70