fix: redirect bundling problems to stderr instead on stdout (#2541)

Author: tatomyr

.changeset/major-icons-talk.md

@@ -0,0 +1,7 @@
+---
+"@redocly/respect-core": patch
+"@redocly/openapi-core": patch
+"@redocly/cli": patch
+---
+
+Redirected bundling problems (such as lint errors and warnings) to stderr instead of stdout to avoid interfering with the bundled output.

packages/cli/src/__tests__/commands/lint.test.ts

@@ -160,6 +160,7 @@ describe('handleLint', () => {
         maxProblems: 2,
         totals: { errors: 0 },
         version: '2.0.0',
+        command: 'lint',
       });
       expect(getExecutionTime).toHaveBeenCalledWith(42);
     });

packages/cli/src/commands/bundle.ts

@@ -111,6 +111,7 @@ export async function handleBundle({
         format: 'codeframe',
         totals: fileTotals,
         version,
+        command: 'bundle',
       });
 
       if (argv.metafile) {
@@ -131,7 +132,7 @@ export async function handleBundle({
             )} with errors ${green(elapsed)}.\n${yellow('Errors ignored because of --force')}.\n`
           );
         } else {
-          logger.info(
+          logger.error(
             `❌ Errors encountered while bundling ${blue(
               formatPath(path)
             )}: bundle not created (use --force to ignore errors).\n`

packages/cli/src/commands/join.ts

@@ -147,6 +147,7 @@ export async function handleJoin({
       formatProblems(problems, {
         totals: fileTotals,
         version: packageVersion,
+        command: 'join',
       });
       exitWithError(
         `❌ Errors encountered while bundling ${blue(

packages/cli/src/commands/lint.ts

@@ -103,6 +103,7 @@ export async function handleLint({
           maxProblems: argv['max-problems'],
           totals: fileTotals,
           version,
+          command: 'lint',
         });
       }
 
@@ -153,6 +154,7 @@ export async function handleLintConfig(argv: Exact<CommandArgv>, version: string
     maxProblems: argv['max-problems'],
     totals: fileTotals,
     version,
+    command: 'check-config',
   });
 
   printConfigLintTotals(fileTotals, command);

packages/core/src/format/format.ts

@@ -87,6 +87,7 @@ export function formatProblems(
     color?: boolean;
     totals: Totals;
     version?: string;
+    command?: 'bundle' | 'lint' | 'join' | 'check-config';
   }
 ) {
   const {
@@ -96,6 +97,7 @@ export function formatProblems(
     color = colorOptions.enabled,
     totals = getTotals(problems),
     version = '2.0',
+    command,
   } = opts;
 
   colorOptions.enabled = color; // force colors if specified
@@ -117,7 +119,11 @@ export function formatProblems(
     case 'codeframe':
       for (let i = 0; i < problems.length; i++) {
         const problem = problems[i];
-        logger.output(`${formatCodeframe(problem, i)}\n`);
+        if (command === 'bundle') {
+          logger.info(`${formatCodeframe(problem, i)}\n`);
+        } else {
+          logger.output(`${formatCodeframe(problem, i)}\n`);
+        }
       }
       break;
     case 'stylish': {

packages/respect-core/src/modules/flow-runner/get-test-description-from-file.ts

@@ -66,6 +66,7 @@ export async function bundleArazzo(options: BundleArazzoOptions) {
       formatProblems(lintProblems, {
         totals: fileTotals,
         version,
+        command: 'bundle',
       });
 
       printConfigLintTotals(fileTotals, options.logger);

tests/e2e/bundle/bundle-external-value/snapshot.txt

@@ -32,6 +32,10 @@ paths:
                   type: object
                 externalValue: ./external-value.json
 components: {}
+
+bundling test-success.yaml using configuration for api 'first'...
+📦 Created a bundle for test-success.yaml at stdout <test>ms.
+bundling test-wrong-examples.yaml using configuration for api 'second'...
 [1] test-wrong-examples.yaml:27:17 at #/paths/~1/post/requestBody/content/application~1xml/examples/test-wrong-ref
 
 Can't resolve $ref: ENOENT: no such file or directory './tests/e2e/bundle/bundle-external-value/external-value-bad-path.json'
@@ -47,8 +51,4 @@ Can't resolve $ref: ENOENT: no such file or directory './tests/e2e/bundle/bundle
 Error was generated by the bundler rule.
 
 
-
-bundling test-success.yaml using configuration for api 'first'...
-📦 Created a bundle for test-success.yaml at stdout <test>ms.
-bundling test-wrong-examples.yaml using configuration for api 'second'...
 ❌ Errors encountered while bundling test-wrong-examples.yaml: bundle not created (use --force to ignore errors).

tests/e2e/bundle/info-description-override-error/snapshot.txt

@@ -1,3 +1,5 @@
+
+bundling main.yaml using configuration for api 'main'...
 [1] main.yaml:8:16 at #/info/description
 
 Failed to read markdown override file for "info.description".
@@ -13,6 +15,4 @@ ENOENT: no such file or directory, open './tests/e2e/bundle/info-description-ove
 Error was generated by the info-description-override rule.
 
 
-
-bundling main.yaml using configuration for api 'main'...
 ❌ Errors encountered while bundling main.yaml: bundle not created (use --force to ignore errors).

tests/e2e/bundle/operation-description-override-error/snapshot.txt

@@ -1,3 +1,5 @@
+
+bundling openapi.yaml using configuration for api 'main'...
 [1] openapi.yaml:23:7 at #/paths/~1pet/put/operationId
 
 Failed to read markdown override file for operation "updatePet".
@@ -13,6 +15,4 @@ ENOENT: no such file or directory, open './tests/e2e/bundle/operation-descriptio
 Error was generated by the operation-description-override rule.
 
 
-
-bundling openapi.yaml using configuration for api 'main'...
 ❌ Errors encountered while bundling openapi.yaml: bundle not created (use --force to ignore errors).