zalando/zally

Support JSON as output format for the zally CLI

Open

#925 opened on Feb 14, 2019

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Kotlin (156 forks)auto 404
area: cligood first issuehelp wantedtype: enhancement

Repository metrics

Stars
 (945 stars)
PR merge metrics
 (PR metrics pending)

Description

It would be helpful, if the Zally CLI would support JSON as output format (--format json) to be easier to use in CI builds that need to post-process the output report. Directly using the API is currently not a good option since the API is not able to directly consume the API spec files since they have to be wrapped into another JSON structure (api_definition_string).

Contributor guide

Research direction
Locate the output formatting code in the CLI module and implement a new JSON formatter that converts violations to JSON.
Tech stack
kotlin
Domain
clitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
KotlinCLI development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60