Redocly / Redocly/redocly-cli

Separate commands for lint, bundle, decorate

Open
#1,042 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Idea
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.

As a user, I know which operations I want to perform, and in what order.

  • I want to lint intentionally, not as a side effect of a bundle command
  • I want to decorate either before or after linting
  • By having the commands as a separate step, I can easily report (for example in CI) which part failed.

Describe the solution you'd like

Additional command redocly decorate and no additional operations (linting, decorating) as side-effects of other operations such as bundle.

We might also need a pre-processor command since that's another step that gets done by bundle.

Describe alternatives you've considered

Multiple config blocks for the same API with different names so that I can run one step and then another for each stage of the process to work around this limitation and try to restrict commands to a single operation at a time.

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 tracing the existing bundle command and the linting, decorating, and pre-processing steps it currently performs. Done means lint and decorate are independently invocable through Redocly CLI, bundle has no such side effects, and the need for a separate pre-processor command is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
cli, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.