chore: changes after review

Author: DmitryAnansky

packages/cli/src/index.ts

@@ -25,7 +25,7 @@ import { handleTranslations } from './commands/translations';
 import { handleEject } from './commands/eject';
 import { PRODUCT_PLANS } from './commands/preview-project/constants';
 import { commonPushHandler } from './commands/push';
-import { handleRun, handleGenerate } from '@redocly/respect-core';
+import { handleRun } from '@redocly/respect-core';
 
 import type { Arguments } from 'yargs';
 import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
@@ -961,8 +961,9 @@ yargs
           },
         });
     },
-    (argv) => {
+    async (argv) => {
       process.env.REDOCLY_CLI_COMMAND = 'generate-arazzo';
+      const { handleGenerate } = await import('@redocly/respect-core');
       commandWrapper(
         handleGenerate as (wrapperArgs: CommandArgs<CommandOptions>) => Promise<unknown>
       )(argv);

packages/respect-core/src/handlers/generate.ts

@@ -3,19 +3,29 @@ import { writeFileSync } from 'fs';
 import { stringifyYaml } from '../utils/yaml';
 import { generateTestConfig } from '../modules/test-config-generator';
 import { DefaultLogger } from '../utils/logger/logger';
-import { type GenerateArazzoFileArgv } from '../types';
-import { type CommandArgs } from './run';
+import { exitWithError } from '../utils/exit-with-error';
+import { type CommandArgs } from '../types';
+
+export type GenerateArazzoFileOptions = {
+  descriptionPath: string;
+  'output-file'?: string;
+  extended?: boolean;
+};
 
 const logger = DefaultLogger.getInstance();
 
-export async function handleGenerate({ argv }: CommandArgs<GenerateArazzoFileArgv>) {
-  logger.log(gray('\n  Generating test configuration... \n'));
+export async function handleGenerate({ argv }: CommandArgs<GenerateArazzoFileOptions>) {
+  try {
+    logger.log(gray('\n  Generating test configuration... \n'));
 
-  const generatedConfig = await generateTestConfig(argv);
-  const content = stringifyYaml(generatedConfig);
+    const generatedConfig = await generateTestConfig(argv);
+    const content = stringifyYaml(generatedConfig);
 
-  const fileName = argv['output-file'] || 'auto-generated.arazzo.yaml';
-  writeFileSync(fileName, content);
+    const fileName = argv['output-file'] || 'auto-generated.arazzo.yaml';
+    writeFileSync(fileName, content);
 
-  logger.log('\n' + blue(`Config ${yellow(fileName)} successfully generated.`) + '\n');
+    logger.log('\n' + blue(`Config ${yellow(fileName)} successfully generated.`) + '\n');
+  } catch (_err) {
+    exitWithError('\n' + '❌  Auto config generation failed.');
+  }
 }

packages/respect-core/src/handlers/run.ts

@@ -1,4 +1,5 @@
-import { bgRed, red } from 'colorette';
+import { red } from 'colorette';
+import { type CollectFn } from '@redocly/openapi-core/src/utils';
 import { runTestFile } from '../modules/flow-runner';
 import {
   displayErrors,
@@ -7,17 +8,8 @@ import {
   calculateTotals,
 } from '../modules/cli-output';
 import { DefaultLogger } from '../utils/logger/logger';
-
-import type { Config } from '@redocly/openapi-core';
-import type { CollectFn } from '@redocly/openapi-core/src/utils';
-import type { RunArgv } from '../types';
-
-export type CommandArgs<T> = {
-  argv: T;
-  config: Config;
-  version: string;
-  collectSpecData?: CollectFn;
-};
+import { type CommandArgs, type RunArgv } from '../types';
+import { exitWithError } from '../utils/exit-with-error';
 
 export type RespectOptions = {
   files: string[];
@@ -112,9 +104,3 @@ async function runFile(
 
   return { hasProblems, file: argv.file, workflows, argv };
 }
-
-const exitWithError = (message: string) => {
-  logger.error(bgRed(message));
-  logger.printNewLine();
-  throw new Error(message);
-};

packages/respect-core/src/index.ts

@@ -1 +1,3 @@
 export { handleGenerate, handleRun } from './handlers/index';
+export type { GenerateArazzoFileOptions } from './handlers/generate';
+export type { RespectOptions } from './handlers/run';

packages/respect-core/src/modules/test-config-generator/generate-test-config.ts

@@ -2,13 +2,8 @@ import * as path from 'path';
 import { sortMethods } from '../../utils/sort';
 import { bundleOpenApi } from '../description-parser';
 
-import type {
-  OperationMethod,
-  TestDescription,
-  GenerateArazzoFileArgv,
-  Workflow,
-  Step,
-} from '../../types';
+import type { OperationMethod, TestDescription, Workflow, Step } from '../../types';
+import type { GenerateArazzoFileOptions } from '../../handlers/generate';
 
 type WorkflowsFromDescriptionInput = {
   descriptionPaths: any;
@@ -104,7 +99,7 @@ export async function generateTestConfig({
   descriptionPath,
   'output-file': outputFile,
   extended,
-}: GenerateArazzoFileArgv) {
+}: GenerateArazzoFileOptions) {
   const { paths: pathsObject, info } = (await bundleOpenApi(descriptionPath, '')) || {};
   const sourceDescriptionName = resolveDescriptionNameFromPath(descriptionPath);
   const resolvedDescriptionPath = outputFile

packages/respect-core/src/types.ts

@@ -19,6 +19,8 @@ import type { OperationDetails } from './modules/description-parser';
 import type { RuleSeverity } from '@redocly/openapi-core/lib/config/types';
 import type { ApiFetcher } from './utils/api-fetcher';
 import type { RespectOptions } from './handlers/run';
+import type { Config } from '@redocly/openapi-core';
+import type { CollectFn } from '@redocly/openapi-core/src/utils';
 
 export type OperationMethod = FromSchema<typeof operationMethod>;
 export type ResponseContext = {
@@ -82,6 +84,13 @@ export type RunArgv = Omit<RespectOptions, 'files'> & {
   severity?: string | string[];
 };
 
+export type CommandArgs<T> = {
+  argv: T;
+  config: Config;
+  version: string;
+  collectSpecData?: CollectFn;
+};
+
 export interface RequestContext {
   body: any;
   header: Record<string, string | number | boolean>;
@@ -223,12 +232,6 @@ export type Check = {
   additionalMessage?: string;
 };
 
-export type GenerateArazzoFileArgv = {
-  descriptionPath: string;
-  'output-file'?: string;
-  extended?: boolean;
-};
-
 export interface ResultsOfTests {
   passed: number;
   failed: number;

packages/respect-core/src/utils/exit-with-error.ts

@@ -0,0 +1,10 @@
+import { bgRed } from 'colorette';
+import { DefaultLogger } from '../utils/logger/logger';
+
+const logger = DefaultLogger.getInstance();
+
+export const exitWithError = (message: string) => {
+  logger.error(bgRed(message));
+  logger.printNewLine();
+  throw new Error(message);
+};