Merge pull request #2335 from hey-api/chore/check-node-version

chore: check Node version

Author: mrlubos

packages/openapi-ts/package.json

@@ -101,6 +101,7 @@
   },
   "devDependencies": {
     "@config/vite-base": "workspace:*",
+    "@types/bun": "1.2.19",
     "@types/cross-spawn": "6.0.6",
     "@types/express": "4.17.21",
     "axios": "1.8.2",

packages/openapi-ts/src/config/engine.ts

@@ -0,0 +1,19 @@
+import { ConfigError } from '../error';
+
+export const checkNodeVersion = () => {
+  if (typeof Bun !== 'undefined') {
+    const [major] = Bun.version.split('.').map(Number);
+    if (major! < 1) {
+      throw new ConfigError(
+        `Unsupported Bun version ${Bun.version}. Please use Bun 1.0.0 or newer.`,
+      );
+    }
+  } else if (typeof process !== 'undefined' && process.versions?.node) {
+    const [major] = process.versions.node.split('.').map(Number);
+    if (major! < 18) {
+      throw new ConfigError(
+        `Unsupported Node version ${process.versions.node}. Please use Node 18 or newer.`,
+      );
+    }
+  }
+};

packages/openapi-ts/src/config/init.ts

@@ -2,6 +2,7 @@ import path from 'node:path';
 
 import { loadConfig } from 'c12';
 
+import { ConfigError } from '../error';
 import type { Config, UserConfig } from '../types/config';
 import { isLegacyClient, setConfig } from '../utils/config';
 import { getInput } from './input';
@@ -70,15 +71,17 @@ export const initConfigs = async (
 
     if (!input.path) {
       errors.push(
-        new Error(
+        new ConfigError(
           'missing input - which OpenAPI specification should we use to generate your output?',
         ),
       );
     }
 
     if (!output.path) {
       errors.push(
-        new Error('missing output - where should we generate your output?'),
+        new ConfigError(
+          'missing output - where should we generate your output?',
+        ),
       );
     }
 

packages/openapi-ts/src/error.ts

@@ -8,6 +8,8 @@ import { ensureDirSync } from './generate/utils';
 
 export const isInteractive = process.stdin.isTTY && process.stdout.isTTY;
 
+export class ConfigError extends Error {}
+
 export class HeyApiError extends Error {
   args: ReadonlyArray<unknown>;
   event: string;
@@ -38,7 +40,14 @@ export class HeyApiError extends Error {
   }
 }
 
-export const logCrashReport = (error: unknown, logsDir: string): string => {
+export const logCrashReport = (
+  error: unknown,
+  logsDir: string,
+): string | undefined => {
+  if (error instanceof ConfigError) {
+    return;
+  }
+
   const logName = `openapi-ts-error-${Date.now()}.log`;
   const fullDir = path.resolve(process.cwd(), logsDir);
   ensureDirSync(fullDir);
@@ -138,18 +147,23 @@ export const printCrashReport = ({
       `\n\n${colors.red('❗️ Error:')} ${colors.white(typeof error === 'string' ? error : error instanceof Error ? error.message : 'Unknown error')}` +
       (logPath
         ? `\n\n${colors.cyan('📄 Crash log saved to:')} ${colors.gray(logPath)}`
-        : ''),
+        : '') +
+      '\n',
   );
 };
 
-export const shouldReportCrash = async (): Promise<boolean> => {
-  if (!isInteractive) {
+export const shouldReportCrash = async ({
+  error,
+}: {
+  error: unknown;
+}): Promise<boolean> => {
+  if (!isInteractive || error instanceof ConfigError) {
     return false;
   }
 
   return new Promise((resolve) => {
     process.stdout.write(
-      `${colors.yellow('\n\n📢 Open a GitHub issue with crash details?')} ${colors.yellow('(y/N):')}`,
+      `${colors.yellow('\n📢 Open a GitHub issue with crash details?')} ${colors.yellow('(y/N):')}`,
     );
     process.stdin.setEncoding('utf8');
     process.stdin.once('data', (data: string) => {

packages/openapi-ts/src/index.ts

@@ -2,6 +2,7 @@ import colors from 'ansi-colors';
 // @ts-expect-error
 import colorSupport from 'color-support';
 
+import { checkNodeVersion } from './config/engine';
 import { initConfigs } from './config/init';
 import { getLogs } from './config/logs';
 import { createClient as pCreateClient } from './createClient';
@@ -35,6 +36,8 @@ export const createClient = async (
   const configs: Array<Config> = [];
 
   try {
+    checkNodeVersion();
+
     Performance.start('createClient');
 
     Performance.start('config');
@@ -90,7 +93,7 @@ export const createClient = async (
 
     if (logs.level !== 'silent') {
       printCrashReport({ error, logPath });
-      if (await shouldReportCrash()) {
+      if (await shouldReportCrash({ error })) {
         await openGitHubIssueWithCrashReport(error);
       }
     }