Redocly / Redocly/redocly-cli

Respect output format option

Open
#2,609 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Respect Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.

respect logs in CI can be very large and noisy, which increases storage usage and makes results harder to read.

Current formats:

  • lint: stylish, codeframe, json, checkstyle, codeclimate, summary, markdown, github-actions
  • scorecard-classic: stylish, json
  • stats: stylish, json, markdown

Describe the solution you'd like

  1. Add formats to respect commands (e.g. codeclimate, github-actions, summary...)

  2. Add additional CI-friendly format:

  1. Optional: if --format is not provided, detect CI and pick a better default format.

Describe alternatives you've considered

Additional context

Formats in oxlint: https://oxc.rs/docs/guide/usage/linter/output-formats
Vitest reporters: https://vitest.dev/guide/reporters.html#built-in-reporters

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the format handling for the respect commands and compare the existing lint, scorecard-classic, and stats format lists. Review the linked oxlint and Vitest reporter references, then define support for the requested formats, including JUnit XML; done means the commands accept and produce the documented formats with coverage from the project's relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, cli, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.