refactor: use stderr for all output except for the output for programmatic use (#2033)

Author: andriimredocly

__tests__/build-docs/build-docs-with-config-option/snapshot.txt

@@ -1,5 +1,5 @@
+
 Found nested/redocly.yaml and using theme.openapi options
 Prerendering docs
 
 🎉 bundled successfully in: nested/redoc-static.html (36 KiB) [⏱ <test>ms].
-

__tests__/build-docs/simple-build-docs/snapshot.txt

@@ -1,5 +1,5 @@
+
 Found undefined and using theme.openapi options
 Prerendering docs
 
 🎉 bundled successfully in: redoc-static.html (330 KiB) [⏱ <test>ms].
-

__tests__/miscellaneous/resolve-refs-in-preprocessors/snapshot_3.txt

@@ -1,6 +1,3 @@
-
-Document: openapi.yaml stats:
-
 🚗 References: 3 
 📦 External Documents: 0 
 📈 Schemas: 1 
@@ -11,5 +8,8 @@ Document: openapi.yaml stats:
 👷 Operations: 2 
 🔖 Tags: 0 
 
+Document: openapi.yaml stats:
+
+
 openapi.yaml: stats processed in <test>ms
 

__tests__/stats/stats-stylish/snapshot.txt

@@ -1,6 +1,3 @@
-
-Document: museum.yaml stats:
-
 🚗 References: 43 
 📦 External Documents: 0 
 📈 Schemas: 23 
@@ -11,5 +8,8 @@ Document: museum.yaml stats:
 👷 Operations: 8 
 🔖 Tags: 3 
 
+Document: museum.yaml stats:
+
+
 museum.yaml: stats processed in <test>ms
 

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

@@ -1,4 +1,4 @@
-import { bundle, getTotals, getMergedConfig, Config } from '@redocly/openapi-core';
+import { bundle, getTotals, getMergedConfig, Config, logger } from '@redocly/openapi-core';
 
 import { BundleOptions, handleBundle } from '../../commands/bundle.js';
 import {
@@ -17,16 +17,12 @@ import { type Arguments } from 'yargs';
 describe('bundle', () => {
   let processExitMock: MockInstance;
   let exitCb: any;
-  let stderrWriteMock: any;
-  let stdoutWriteMock: any;
   beforeEach(async () => {
     processExitMock = vi.spyOn(process, 'exit').mockImplementation(vi.fn() as any);
     vi.spyOn(process, 'once').mockImplementation((_e, cb) => {
       exitCb = cb;
       return process.on(_e, cb);
     });
-    stderrWriteMock = vi.spyOn(process.stderr, 'write').mockImplementation(vi.fn());
-    stdoutWriteMock = vi.spyOn(process.stdout, 'write').mockImplementation(vi.fn());
 
     vi.mock('@redocly/openapi-core');
     vi.mocked(bundle).mockImplementation(
@@ -209,7 +205,7 @@ describe('bundle', () => {
 
       expect(saveBundle).toBeCalledTimes(1);
       expect(saveBundle).toHaveBeenCalledWith('output/foo.yaml', expect.any(String));
-      expect(process.stdout.write).toHaveBeenCalledTimes(1);
+      expect(logger.output).toHaveBeenCalledTimes(1);
     });
 
     it('should NOT store bundled API descriptions in the output files described in the apis section of config IF there is a positional api provided', async () => {
@@ -241,7 +237,7 @@ describe('bundle', () => {
       });
 
       expect(saveBundle).toBeCalledTimes(0);
-      expect(process.stdout.write).toHaveBeenCalledTimes(1);
+      expect(logger.output).toHaveBeenCalledTimes(1);
     });
 
     it('should store bundled API descriptions in the directory specified in argv IF multiple positional apis provided AND --output specified', async () => {

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

@@ -5,6 +5,7 @@ import {
   getTotals,
   formatProblems,
   doesYamlFileExist,
+  logger,
   type Totals,
 } from '@redocly/openapi-core';
 import {
@@ -183,7 +184,7 @@ describe('handleLint', () => {
         };
       });
       await commandWrapper(handleLint)(argvMock);
-      expect(process.stderr.write).toHaveBeenCalledWith(
+      expect(logger.info).toHaveBeenCalledWith(
         `No configurations were provided -- using built in ${blue(
           'recommended'
         )} configuration by default.\n\n`

packages/cli/src/__tests__/spinner.test.ts

@@ -3,15 +3,15 @@ import { Spinner } from '../utils/spinner.js';
 import * as process from 'node:process';
 
 describe('Spinner', () => {
-  const IS_TTY = process.stdout.isTTY;
+  const IS_TTY = process.stderr.isTTY;
 
   let writeMock: MockInstance;
   let spinner: Spinner;
 
   beforeEach(() => {
     vi.useFakeTimers();
-    process.stdout.isTTY = true;
-    writeMock = vi.spyOn(process.stdout, 'write').mockImplementation(vi.fn());
+    process.stderr.isTTY = true;
+    writeMock = vi.spyOn(process.stderr, 'write').mockImplementation(vi.fn());
     spinner = new Spinner();
   });
 
@@ -20,7 +20,7 @@ describe('Spinner', () => {
   });
 
   afterAll(() => {
-    process.stdout.isTTY = IS_TTY;
+    process.stderr.isTTY = IS_TTY;
   });
 
   it('starts the spinner', () => {
@@ -42,7 +42,7 @@ describe('Spinner', () => {
   });
 
   it('should call write 1 times if CI set to true', () => {
-    process.stdout.isTTY = false;
+    process.stderr.isTTY = false;
     spinner.start('Loading');
     vi.advanceTimersByTime(300);
     expect(writeMock).toHaveBeenCalledTimes(1);

packages/cli/src/__tests__/utils.test.ts

@@ -462,6 +462,8 @@ describe('checkIfRulesetExist', () => {
   });
 
   it('should throw an error if rules are not provided', () => {
+    vi.mocked(red).mockImplementation((text) => text as string);
+
     const rules = {
       oas2: {},
       oas3_0: {},

packages/cli/src/auth/device-flow.ts

@@ -1,5 +1,6 @@
 import { blue, green } from 'colorette';
 import * as childProcess from 'node:child_process';
+import { logger } from '@redocly/openapi-core';
 import { ReuniteApiClient } from '../reunite/api/api-client.js';
 
 export type AuthToken = {
@@ -18,17 +19,17 @@ export class RedoclyOAuthDeviceFlow {
 
   async run() {
     const code = await this.getDeviceCode();
-    process.stdout.write(
+    logger.output(
       'Attempting to automatically open the SSO authorization page in your default browser.\n'
     );
-    process.stdout.write(
+    logger.output(
       'If the browser does not open or you wish to use a different device to authorize this request, open the following URL:\n\n'
     );
-    process.stdout.write(blue(code.verificationUri));
-    process.stdout.write(`\n\n`);
-    process.stdout.write(`Then enter the code:\n\n`);
-    process.stdout.write(blue(code.userCode));
-    process.stdout.write(`\n\n`);
+    logger.output(blue(code.verificationUri));
+    logger.output(`\n\n`);
+    logger.output(`Then enter the code:\n\n`);
+    logger.output(blue(code.userCode));
+    logger.output(`\n\n`);
 
     this.openBrowser(code.verificationUriComplete);
 
@@ -37,7 +38,7 @@ export class RedoclyOAuthDeviceFlow {
       code.interval,
       code.expiresIn
     );
-    process.stdout.write(green('✅ Logged in\n\n'));
+    logger.output(green('✅ Logged in\n\n'));
 
     return accessToken;
   }

packages/cli/src/auth/oauth-client.ts

@@ -3,6 +3,7 @@ import * as path from 'node:path';
 import { mkdirSync, existsSync, writeFileSync, readFileSync, rmSync } from 'node:fs';
 import * as crypto from 'node:crypto';
 import { Buffer } from 'node:buffer';
+import { logger } from '@redocly/openapi-core';
 import { type AuthToken, RedoclyOAuthDeviceFlow } from './device-flow.js';
 
 const SALT = '4618dbc9-8aed-4e27-aaf0-225f4603e5a4';
@@ -88,7 +89,7 @@ export class RedoclyOAuthClient {
         this.cipher.update(JSON.stringify(token), 'utf8', 'hex') + this.cipher.final('hex');
       writeFileSync(path.join(this.dir, 'auth.json'), encrypted);
     } catch (error) {
-      process.stderr.write('Error saving tokens:', error);
+      logger.error(`Error saving tokens: ${error}`);
     }
   }