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

.changeset/dull-pianos-enjoy.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+feat: ability to disable writing a log file via a `--no-log-file` flag or `logs.file` = `false`

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',
@@ -113,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/generate/__tests__/class.test.ts

@@ -20,6 +20,7 @@ describe('generateLegacyClientClass', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/generate/__tests__/core.test.ts

@@ -35,6 +35,7 @@ describe('generateLegacyCore', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -127,6 +128,7 @@ describe('generateLegacyCore', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -202,6 +204,7 @@ describe('generateLegacyCore', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/generate/__tests__/index.test.ts

@@ -20,6 +20,7 @@ describe('generateIndexFile', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/generate/__tests__/output.test.ts

@@ -21,6 +21,7 @@ describe('generateLegacyOutput', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

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,10 +67,11 @@
   } catch (error) {
     const config = configs[0] as Config | undefined;
     const dryRun = config ? config.dryRun : resolvedConfig?.dryRun;
+
     // TODO: add setting for log output
     if (!dryRun) {
       const logs = config?.logs ?? getLogs(resolvedConfig);
-      if (logs.level !== 'silent') {
+      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/openApi/__tests__/index.test.ts

@@ -18,6 +18,7 @@ vi.mock('../3.1.x', () => ({
 vi.mock('../../utils/config', () => {
   const config: Partial<Config> = {
     logs: {
+      file: false,
       level: 'silent',
       path: '',
     },

packages/openapi-ts/src/plugins/@hey-api/schemas/__tests__/schemas.test.ts

@@ -21,6 +21,7 @@ describe('generateLegacySchemas', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -109,6 +110,7 @@ describe('generateLegacySchemas', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/plugins/@hey-api/sdk/__tests__/plugin.test.ts

@@ -24,6 +24,7 @@ describe('handlerLegacy', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -184,6 +185,7 @@ describe('methodNameBuilder', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -266,6 +268,7 @@ describe('methodNameBuilder', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -351,6 +354,7 @@ describe('methodNameBuilder', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/plugins/@hey-api/typescript/__tests__/plugin.test.ts

@@ -21,6 +21,7 @@ describe('generateLegacyTypes', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

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

@@ -143,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.
@@ -168,6 +174,7 @@ export interface UserConfig {
           | 'silent'
           | 'trace'
           | 'warn';
+
         /**
          * The relative location of the logs folder
          *

packages/openapi-ts/src/utils/__tests__/handlebars.test.ts

@@ -18,6 +18,7 @@ describe('registerHandlebarHelpers', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },
@@ -84,6 +85,7 @@ describe('registerHandlebarTemplates', () => {
         path: '',
       },
       logs: {
+        file: true,
         level: 'info',
         path: process.cwd(),
       },

packages/openapi-ts/src/utils/__tests__/parse.test.ts

@@ -13,6 +13,7 @@ describe('operationNameFn', () => {
       path: '',
     },
     logs: {
+      file: true,
       level: 'info',
       path: process.cwd(),
     },