winglang/wing

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

Open

#1,829 opened on Mar 15, 2023

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

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (No merged PRs in 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

Contributor guide

Research direction
Look at the existing CLI argument parsing (e.g., using yargs or commander) and the error rendering module (likely in src/). Add a new ` message format` option that accepts 'short' or 'json', and map it to the codespan reporting display styles or the JSON error formatter in the compiler. Test by running `wing compile` with the new flag.
Tech stack
typescript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70