fix(cli): lint with multiple api files results in invalid output by harshit078 · Pull Request #2744 · Redocly/redocly-cli

harshit078 · 2026-04-15T10:21:05Z

What/Why/How?

Added logic to gather all lint results into allResults during per-file loop, then call formatProblems() once after with the combined totals.

Reference

#2692

Testing

Screenshots (optional)

Check yourself

This PR follows the contributing guide
All new/updated code is covered by tests
Core code changed? - Tested with other Redocly products (internal contributions only)
New package installed? - Tested in different environments (browser/node)
Documentation update has been considered

Security

The security impact of the change has been considered
Code follows company security practices and guidelines

Note

Medium Risk
Changes lint output behavior when multiple API files are provided by aggregating results into one formatProblems call, which can affect downstream tooling that parses structured formats. Logic is straightforward and covered by updated unit/e2e snapshots, but it impacts a core CLI command.

Overview
redocly lint now produces valid structured output when linting multiple APIs in one run. Instead of calling formatProblems() per API, the command accumulates all lint problems and prints one combined checkstyle/json/other structured document with overall totals.

Tests were updated to expect a single formatProblems call and new problem ordering/indices, docs (@v1/@v2) were revised to describe the combined structured output behavior, and a patch changeset was added.

^{Reviewed by Cursor Bugbot for commit 0c7cf32. Bugbot is set up for automated code reviews on this repo. Configure here.}

changeset-bot · 2026-04-15T10:21:10Z

🦋 Changeset detected

Latest commit: 0c7cf32

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@redocly/cli	Patch
@redocly/openapi-core	Patch
@redocly/respect-core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Daryna-del

Thanks for the contribution! The overall approach looks good, but there are
a couple of things worth addressing before merging. Could you also take a
look at why the build and test job is failing? Left a few comments.

Daryna-del · 2026-05-05T11:55:11Z

  const totals: Totals = { errors: 0, warnings: 0, ignored: 0 };
  let totalIgnored = 0;
+  const allLintRes: Awaited<ReturnType<typeof lint>> = [];
+  let loopCompleted = false;


The same here, I don't think we need this additional variable.

Daryna-del · 2026-05-05T11:55:47Z

+  const allLintRes: Awaited<ReturnType<typeof lint>> = [];
+  let loopCompleted = false;
+
+  try {


The try/finally adds complexity that I don't think is needed here.

Daryna-del · 2026-05-05T13:19:48Z

    case 'markdown': {
      const groupedByFile = groupByFiles(problems);
      for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
+        let fileErrors = 0;


The changes here unnecessary.

Agree ! fixed it. thanks for pointing it out

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 0c7cf32. Configure here.}

cursor · 2026-05-13T13:22:44Z

+      version,
+      command: 'lint',
+    });
+  }


maxProblems truncation now applies globally, hiding problems

Medium Severity

Moving formatProblems outside the per-file loop changes the semantics of --max-problems from a per-file cap to a global cap. formatProblems internally calls .slice(0, maxProblems) on the combined results. With the default of 100, linting several API files that together exceed 100 problems will now silently hide problems that were previously shown. For example, 5 files × 30 problems each = 150 total, but only 100 are displayed. This is a user-facing regression where legitimate lint issues go unreported without the user realizing it.

^{Reviewed by Cursor Bugbot for commit 0c7cf32. Configure here.}

Daryna-del

Hey @harshit078
Left some comments, could you, please, take a look?

Daryna-del · 2026-05-06T09:41:58Z

-{% admonition type="warning" name="Lint one API at a time" %}
-Some formats, such as `checkstyle` or `json`, don't work well when multiple APIs are linted in a single command. Try linting each API separately when you pass the command output to another tool.
-{% /admonition %}
+The standard `codeframe` output format works well in most situations, but `redocly` can also produce output to integrate with other tools. When multiple APIs are linted in a single command, all structured formats (such as `checkstyle` and `json`) produce a single combined document that groups problems per file.


You don't need to make changes in v1 docs

Daryna-del · 2026-05-15T07:54:53Z

+"@redocly/cli": patch
+---
+
+When multiple APIs are linted in a single command, all structured formats (such as `checkstyle` and `json`) produce a single combined document that groups problems per file.


We would like to have combined output only for checkstyle format. Could you please adjust it?

Daryna-del · 2026-05-15T07:54:56Z

-Some formats, such as `checkstyle` or `json`, don't work well when multiple APIs are linted in a single command.
-Try linting each API separately when you pass the command output to another tool.
-{% /admonition %}
+When multiple APIs are linted in a single command, all structured formats (such as `checkstyle` and `json`) produce a single combined document that groups problems per file.


Same here, only for checkstyle format. Could you please adjust docs?

Daryna-del · 2026-05-15T07:55:11Z

-          version,
-          command: 'lint',
-        });
+        allLintRes.push(...results);


We would like to have combined output only for checkstyle format. Could you please adjust a solution?

Daryna-del · 2026-05-15T07:55:14Z

    }
  }

+  if (!argv['generate-ignore-file']) {


Same here, only for checkstyle format

Daryna-del · 2026-05-15T07:55:21Z

-
-
-[1] split/info.yaml:1:1 at #/contact
+[3] split/info.yaml:1:1 at #/contact


This file shouldn't be changed

Daryna-del · 2026-05-15T07:55:25Z



-[1] openapi-oas32-2020.yaml:36:26 at #/paths/~1test/get/responses/200/content/application~1json/examples/exclusiveMinInvalid/value/age
+[4] openapi-oas32-2020.yaml:36:26 at #/paths/~1test/get/responses/200/content/application~1json/examples/exclusiveMinInvalid/value/age


This file shouldn't be changed

Daryna-del · 2026-05-15T07:55:30Z

@@ -29,7 +29,7 @@ referenced from openapi-oas30-draft4.yaml:43:7 at #/components/parameters/RefInv
 Error was generated by the no-invalid-parameter-examples rule.




This file shouldn't be changed

fix(cli): added logic to accumulate lint results before formatting

152b182

harshit078 changed the title ~~fix(cli): lint with multiple api files results in invalid checkstyle/json output~~ fix(cli): lint with multiple api files results in invalid output Apr 15, 2026

harshit078 and others added 3 commits April 15, 2026 16:25

Merge branch 'main' into fix-lint-multiple-files

1930fc3

fix(cli): updated lint test

8dcbcfb

fix: updated both lint md and added changset

1c82361

harshit078 marked this pull request as ready for review April 15, 2026 12:24

harshit078 requested review from a team as code owners April 15, 2026 12:24

cursor Bot reviewed Apr 15, 2026

View reviewed changes

Comment thread packages/cli/src/commands/lint.ts

harshit078 and others added 2 commits April 15, 2026 18:36

fix: address cursor comments

19092db

Merge branch 'main' into fix-lint-multiple-files

1799891

cursor Bot reviewed Apr 17, 2026

View reviewed changes

Comment thread packages/cli/src/commands/lint.ts Outdated

harshit078 and others added 4 commits April 20, 2026 16:53

Merge branch 'main' into fix-lint-multiple-files

2eec3c0

fix: comments addressed by cursor

c1fa6a2

Merge branch 'main' into fix-lint-multiple-files

545b1a0

Merge branch 'main' into fix-lint-multiple-files

a893ee5

Daryna-del reviewed May 5, 2026

View reviewed changes

harshit078 and others added 3 commits May 6, 2026 13:39

Merge branch 'main' into fix-lint-multiple-files

c7806a7

fix: address commments and simplify

bdef0c5

Merge branch 'main' into fix-lint-multiple-files

ed308eb

harshit078 requested a review from Daryna-del May 7, 2026 08:37

harshit078 and others added 2 commits May 7, 2026 14:20

fix: update failing e2e tests and updated snapshots

de3b116

Merge branch 'main' into fix-lint-multiple-files

0c7cf32

cursor Bot reviewed May 13, 2026

View reviewed changes

Daryna-del reviewed May 15, 2026

View reviewed changes



		[1] split/info.yaml:1:1 at #/contact
		[3] split/info.yaml:1:1 at #/contact



		[1] openapi-oas32-2020.yaml:36:26 at #/paths/~1test/get/responses/200/content/application~1json/examples/exclusiveMinInvalid/value/age
		[4] openapi-oas32-2020.yaml:36:26 at #/paths/~1test/get/responses/200/content/application~1json/examples/exclusiveMinInvalid/value/age

		@@ -29,7 +29,7 @@ referenced from openapi-oas30-draft4.yaml:43:7 at #/components/parameters/RefInv
		Error was generated by the no-invalid-parameter-examples rule.

Conversation

harshit078 commented Apr 15, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

Uh oh!

changeset-bot Bot commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

Daryna-del left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot May 13, 2026

Choose a reason for hiding this comment

maxProblems truncation now applies globally, hiding problems

Uh oh!

Daryna-del left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

harshit078 commented Apr 15, 2026 •

edited by cursor Bot

Loading

changeset-bot Bot commented Apr 15, 2026 •

edited

Loading

`maxProblems` truncation now applies globally, hiding problems