fix: make logFile optional in config

Author: Matsuuu

packages/openapi-ts/bin/index.cjs

@@ -118,6 +118,8 @@ async function start() {
       userConfig.logs.level = 'silent';
     }
 
+    userConfig.logs.file = userConfig.logFile;
+
     if (typeof params.watch === 'string') {
       userConfig.watch = Number.parseInt(params.watch, 10);
     }

packages/openapi-ts/src/getLogs.ts

@@ -2,6 +2,7 @@ import type { Config, UserConfig } from './types/config';
 
 export const getLogs = (userConfig: UserConfig | undefined): Config['logs'] => {
   let logs: Config['logs'] = {
+    file: true,
     level: 'info',
     path: process.cwd(),
   };

packages/openapi-ts/src/index.ts

@@ -67,11 +67,11 @@ export const createClient = async (
   } catch (error) {
     const config = configs[0] as Config | undefined;
     const dryRun = config ? config.dryRun : resolvedConfig?.dryRun;
-    const writeLogFile = config ? config.logFile : resolvedConfig?.logFile;
+
     // TODO: add setting for log output
     if (!dryRun) {
       const logs = config?.logs ?? getLogs(resolvedConfig);
-      if (logs.level !== 'silent' && writeLogFile) {
+      if (logs.level !== 'silent' && logs.file) {
         const logName = `openapi-ts-error-${Date.now()}.log`;
         const logsDir = path.resolve(process.cwd(), logs.path ?? '');
         ensureDirSync(logsDir);

packages/openapi-ts/src/initConfigs.ts

@@ -269,7 +269,6 @@ export const initConfigs = async (
       dryRun = false,
       experimentalParser = true,
       exportCore = true,
-      logFile = true,
       name,
       request,
       useOptions = true,
@@ -312,7 +311,6 @@ export const initConfigs = async (
       experimentalParser,
       exportCore: false,
       input,
-      logFile,
       logs,
       name,
       output,

packages/openapi-ts/src/types/config.d.ts

@@ -135,23 +135,6 @@ export interface UserConfig {
     | (string & {})
     | Record<string, unknown>
     | Input;
-  /**
-   * @deprecated
-   *
-   * Opt in to the experimental parser?
-   *
-   * @default true
-   */
-  experimentalParser?: boolean;
-
-  /**
-   * @deprecated
-   *
-   * Generate core client classes?
-   *
-   * @default true
-   */
-  exportCore?: boolean;
   /**
    * The relative location of the logs folder
    *
@@ -160,6 +143,12 @@ export interface UserConfig {
   logs?:
     | string
     | {
+        /**
+         * Whether or not error logs should be written to a file or not
+         *
+         * @default true
+         * */
+        file?: boolean;
         /**
          * The logging level to control the verbosity of log output.
          * Determines which messages are logged based on their severity.
@@ -185,55 +174,14 @@ export interface UserConfig {
           | 'silent'
           | 'trace'
           | 'warn';
+
         /**
          * The relative location of the logs folder
          *
          * @default process.cwd()
          */
         path?: string;
       };
-  /**
-   * Whether or not error logs should be written to a file or not
-   * */
-  logFile: boolean;
-  /**
-   * Regenerate the client when the input file changes? You can alternatively
-   * pass a numeric value for the interval in ms.
-   *
-   * @default false
-   */
-  watch?:
-    | boolean
-    | number
-    | {
-        /**
-         * Regenerate the client when the input file changes?
-         *
-         * @default false
-         */
-        enabled?: boolean;
-        /**
-         * How often should we attempt to detect the input file change? (in ms)
-         *
-         * @default 1000
-         */
-        interval?: number;
-        /**
-         * How long will we wait before the request times out?
-         *
-         * @default 60_000
-         */
-        timeout?: number;
-      };
-  /**
-   * @deprecated
-   *
-   * Custom client class name. Please note this option is deprecated and
-   * will be removed in favor of clients.
-   *
-   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
-   */
-  name?: string;
   /**
    * The relative location of the output folder
    */
@@ -289,13 +237,67 @@ export interface UserConfig {
    * @default ['@hey-api/typescript', '@hey-api/sdk']
    */
   plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
+  /**
+   * Regenerate the client when the input file changes? You can alternatively
+   * pass a numeric value for the interval in ms.
+   *
+   * @default false
+   */
+  watch?:
+    | boolean
+    | number
+    | {
+        /**
+         * Regenerate the client when the input file changes?
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * How often should we attempt to detect the input file change? (in ms)
+         *
+         * @default 1000
+         */
+        interval?: number;
+        /**
+         * How long will we wait before the request times out?
+         *
+         * @default 60_000
+         */
+        timeout?: number;
+      };
   /**
    * @deprecated
    *
    * Manually set base in OpenAPI config instead of inferring from server value
    */
   // eslint-disable-next-line typescript-sort-keys/interface
   base?: string;
+  /**
+   * @deprecated
+   *
+   * Opt in to the experimental parser?
+   *
+   * @default true
+   */
+  experimentalParser?: boolean;
+  /**
+   * @deprecated
+   *
+   * Generate core client classes?
+   *
+   * @default true
+   */
+  exportCore?: boolean;
+  /**
+   * @deprecated
+   *
+   * Custom client class name. Please note this option is deprecated and
+   * will be removed in favor of clients.
+   *
+   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+   */
+  name?: string;
   /**
    * @deprecated
    *