rename the OutputExtension type

Author: tatomyr

packages/cli/src/commands/bundle.ts

@@ -15,14 +15,14 @@ import {
 } from '../utils/miscellaneous.js';
 import { AbortFlowError } from '../utils/error.js';
 
-import type { OutputExtensions, Totals, VerifyConfigOptions } from '../types.js';
+import type { OutputExtension, Totals, VerifyConfigOptions } from '../types.js';
 import type { CommandArgs } from '../wrapper.js';
 
 export type BundleOptions = {
   apis?: string[];
   extends?: string[];
   output?: string;
-  ext?: OutputExtensions;
+  ext?: OutputExtension;
   dereferenced?: boolean;
   force?: boolean;
   metafile?: string;

packages/cli/src/types.ts

@@ -24,7 +24,7 @@ export type Entrypoint = {
   output?: string;
 };
 export const outputExtensions = ['json', 'yaml', 'yml'] as const;
-export type OutputExtensions = typeof outputExtensions[number];
+export type OutputExtension = typeof outputExtensions[number];
 export type CommandOptions =
   | StatsOptions
   | SplitOptions

packages/cli/src/utils/miscellaneous.ts

@@ -29,7 +29,7 @@ import { exitWithError } from './error.js';
 import { handleLintConfig } from '../commands/lint.js';
 
 import type { Config, Oas3Definition, Oas2Definition, Exact } from '@redocly/openapi-core';
-import type { Totals, Entrypoint, OutputExtensions, CommandOptions } from '../types.js';
+import type { Totals, Entrypoint, OutputExtension, CommandOptions } from '../types.js';
 
 const globPromise = promisify(glob.glob);
 
@@ -179,7 +179,7 @@ export class CircularJSONNotSupportedError extends Error {
   }
 }
 
-export function dumpBundle(obj: any, format: OutputExtensions, dereference?: boolean): string {
+export function dumpBundle(obj: any, format: OutputExtension, dereference?: boolean): string {
   if (format === 'json') {
     try {
       return JSON.stringify(obj, null, 2);
@@ -271,10 +271,10 @@ export function writeJson(data: unknown, filename: string) {
   fs.writeFileSync(filename, content);
 }
 
-export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtensions> {
+export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtension> {
   const ext = fileName.split('.').pop();
-  if (outputExtensions.includes(ext as OutputExtensions)) {
-    return ext as OutputExtensions;
+  if (outputExtensions.includes(ext as OutputExtension)) {
+    return ext as OutputExtension;
   }
   logger.warn(`Unsupported file extension: ${ext}. Using yaml.\n`);
   return 'yaml';
@@ -369,7 +369,7 @@ export function getOutputFileName({
   entrypoint: string;
   output?: string;
   argvOutput?: string;
-  ext?: OutputExtensions;
+  ext?: OutputExtension;
   entries: number;
 }) {
   let outputFile = output || argvOutput;
@@ -378,16 +378,16 @@ export function getOutputFileName({
   }
 
   if (entries > 1 && argvOutput) {
-    ext = ext || (extname(entrypoint).substring(1) as OutputExtensions);
+    ext = ext || (extname(entrypoint).substring(1) as OutputExtension);
     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 OutputExtensions) ||
-      (extname(entrypoint).substring(1) as OutputExtensions);
+      (extname(outputFile).substring(1) as OutputExtension) ||
+      (extname(entrypoint).substring(1) as OutputExtension);
     if (!outputExtensions.includes(ext)) {
       throw new Error(`Invalid file extension: ${ext}.`);
     }

packages/core/src/index.ts

@@ -69,7 +69,7 @@ export {
   type ResolvedApiConfig,
   type Plugin,
   type RuleConfig,
-  Config, // FIXME: only export as a type in v2
+  Config, // FIXME: export it as a type
   IGNORE_FILE,
   loadConfig,
   findConfig,