Improve user and script-usage by having consistent flags that would disable "pretty" features and prioritize JSON responses
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 102
- Forks
- 49
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 16
Description
Currently our scripts have different flag for usage by people that focuses on improving DX (emojis, statuses, progress bars, using non-JSON for display), and others like the models have a flag to display in parsable JSON syntax.
We should settle on consistent global flags that users can turn on when using scripts or in CI that would disable all pretty features and focuses on parsability.
We should also have a better exposed interface that users can track to understand breaking changes and what values they can retrieve from the outputs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name specific files, tests, or entry points. Start by inventorying the existing flags used by scripts and models, then define the scope of consistent non-pretty and JSON behavior. Done means users have a consistent interface for parsable output and can understand its supported values and breaking changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100