reuse output extensions

Author: tatomyr

packages/cli/src/types.ts

@@ -1,4 +1,4 @@
-import type { BundleOutputFormat, RuleSeverity } from '@redocly/openapi-core';
+import type { RuleSeverity } from '@redocly/openapi-core';
 import type { RespectOptions, GenerateArazzoFileOptions } from '@redocly/respect-core';
 import type { LintOptions } from './commands/lint.js';
 import type { BundleOptions } from './commands/bundle.js';
@@ -23,8 +23,8 @@ export type Entrypoint = {
   alias?: string;
   output?: string;
 };
-export const outputExtensions = ['json', 'yaml', 'yml'] as ReadonlyArray<BundleOutputFormat>; // FIXME: use one source of truth (2.0)
-export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined; // FIXME: use one source of truth (2.0)
+export const outputExtensions = ['json', 'yaml', 'yml'] as const;
+export type OutputExtensions = typeof outputExtensions[number];
 export type CommandOptions =
   | StatsOptions
   | SplitOptions

packages/cli/src/utils/miscellaneous.ts

@@ -28,13 +28,7 @@ import { outputExtensions } from '../types.js';
 import { exitWithError } from './error.js';
 import { handleLintConfig } from '../commands/lint.js';
 
-import type {
-  Config,
-  BundleOutputFormat,
-  Oas3Definition,
-  Oas2Definition,
-  Exact,
-} from '@redocly/openapi-core';
+import type { Config, Oas3Definition, Oas2Definition, Exact } from '@redocly/openapi-core';
 import type { Totals, Entrypoint, OutputExtensions, CommandOptions } from '../types.js';
 
 const globPromise = promisify(glob.glob);
@@ -185,7 +179,7 @@ export class CircularJSONNotSupportedError extends Error {
   }
 }
 
-export function dumpBundle(obj: any, format: BundleOutputFormat, dereference?: boolean): string {
+export function dumpBundle(obj: any, format: OutputExtensions, dereference?: boolean): string {
   if (format === 'json') {
     try {
       return JSON.stringify(obj, null, 2);
@@ -279,10 +273,8 @@ export function writeJson(data: unknown, filename: string) {
 
 export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtensions> {
   const ext = fileName.split('.').pop();
-
-  if (['yaml', 'yml', 'json'].includes(ext!)) {
-    // FIXME: ^ use one source of truth (2.0)
-    return ext as NonNullable<OutputExtensions>;
+  if (outputExtensions.includes(ext as OutputExtensions)) {
+    return ext as OutputExtensions;
   }
   logger.warn(`Unsupported file extension: ${ext}. Using yaml.\n`);
   return 'yaml';
@@ -377,7 +369,7 @@ export function getOutputFileName({
   entrypoint: string;
   output?: string;
   argvOutput?: string;
-  ext?: BundleOutputFormat;
+  ext?: OutputExtensions;
   entries: number;
 }) {
   let outputFile = output || argvOutput;
@@ -386,16 +378,16 @@ export function getOutputFileName({
   }
 
   if (entries > 1 && argvOutput) {
-    ext = ext || (extname(entrypoint).substring(1) as BundleOutputFormat);
+    ext = ext || (extname(entrypoint).substring(1) as OutputExtensions);
     if (!outputExtensions.includes(ext)) {
       throw new Error(`Invalid file extension: ${ext}.`);
     }
     outputFile = join(argvOutput, basename(entrypoint, extname(entrypoint))) + '.' + ext;
   } else {
     ext =
       ext ||
-      (extname(outputFile).substring(1) as BundleOutputFormat) ||
-      (extname(entrypoint).substring(1) as BundleOutputFormat);
+      (extname(outputFile).substring(1) as OutputExtensions) ||
+      (extname(entrypoint).substring(1) as OutputExtensions);
     if (!outputExtensions.includes(ext)) {
       throw new Error(`Invalid file extension: ${ext}.`);
     }

packages/core/src/index.ts

@@ -1,5 +1,4 @@
 export {
-  type BundleOutputFormat,
   type CollectFn,
   type Exact,
   keysOf,

packages/core/src/utils.ts

@@ -32,8 +32,6 @@ export function popStack<T, P extends Stack<T>>(head: P) {
   return head?.prev ?? null;
 }
 
-export type BundleOutputFormat = 'json' | 'yml' | 'yaml'; // FIXME: use one source of truth (2.0)
-
 export async function loadYaml<T>(filename: string): Promise<T> {
   const contents = await fs.promises.readFile(filename, 'utf-8');
   return parseYaml(contents) as T;