feat: disable writing a log file via a --no-log-file flag

Author: Matsuuu

packages/openapi-ts/bin/index.cjs

@@ -34,6 +34,10 @@ const params = program
     'DEPRECATED. Manually set base in OpenAPI config instead of inferring from server value',
   )
   .option('-s, --silent', 'Set log level to silent')
+  .option(
+    '--no-log-file',
+    'Disable writing a log file. Works like --silent but without supressing console output',
+  )
   .option(
     '-w, --watch [value]',
     'Regenerate the client when the input file changes?',
@@ -83,6 +87,7 @@ async function start() {
 
     userConfig = processParams(params, [
       'dryRun',
+      'logFile',
       'experimentalParser',
       'exportCore',
       'useOptions',

packages/openapi-ts/src/index.ts

@@ -67,10 +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') {
+      if (logs.level !== 'silent' && writeLogFile) {
         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,6 +269,7 @@ export const initConfigs = async (
       dryRun = false,
       experimentalParser = true,
       exportCore = true,
+      logFile = true,
       name,
       request,
       useOptions = true,
@@ -311,6 +312,7 @@ export const initConfigs = async (
       experimentalParser,
       exportCore: false,
       input,
+      logFile,
       logs,
       name,
       output,

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

@@ -135,6 +135,23 @@ 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
    *
@@ -175,6 +192,48 @@ export interface UserConfig {
          */
         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
    */
@@ -230,67 +289,13 @@ 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
    *