Merge pull request #435 from hey-api/feat/move-use-dates-option

feat: replace useDateType with option in types object

.changeset/soft-ladybugs-shave.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat: replace useDateType with option in types object

docs/openapi-ts/migrating.md

@@ -78,6 +78,20 @@ export default {
 }
 ```
 
+### Removed `useDateType`
+
+This config option has been removed. You can now configure date type using the `types.dates` option.
+
+```js{5}
+export default {
+  input: 'path/to/openapi.json',
+  output: 'src/client',
+  type: {
+    dates: true,
+  },
+}
+```
+
 ## v0.40.0
 
 ### Renamed `models.gen.ts` file

packages/openapi-ts/bin/index.cjs

@@ -37,10 +37,6 @@ const params = program
   .option('--schemas [value]', 'Write schemas to disk')
   .option('--services [value]', 'Write services to disk')
   .option('--types [value]', 'Write types to disk')
-  .option(
-    '--useDateType [value]',
-    'Output Date instead of string for the format "date-time" in the models',
-  )
   .option('--useOptions [value]', 'Use options instead of arguments')
   .parse(process.argv)
   .opts();
@@ -82,7 +78,6 @@ async function start() {
       'schemas',
       'services',
       'types',
-      'useDateType',
       'useOptions',
     ]);
     await createClient(userConfig);

packages/openapi-ts/rollup.config.ts

@@ -28,7 +28,6 @@ export function handlebarsPlugin(): Plugin {
             ifdef: true,
             notEquals: true,
             transformServiceName: true,
-            useDateType: true,
           },
           knownHelpersOnly: true,
           noEscape: true,

packages/openapi-ts/src/index.ts

@@ -125,6 +125,7 @@ const getServices = (userConfig: UserConfig): Config['services'] => {
 
 const getTypes = (userConfig: UserConfig): Config['types'] => {
   let types: Config['types'] = {
+    dates: false,
     export: true,
     name: 'preserve',
   };
@@ -169,7 +170,6 @@ const initConfig = async (
     name,
     operationId = true,
     request,
-    useDateType = false,
     useOptions = true,
   } = userConfig;
 
@@ -218,7 +218,6 @@ const initConfig = async (
     schemas,
     services,
     types,
-    useDateType,
     useOptions,
   });
 };

packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts

@@ -29,7 +29,6 @@ describe('getOperationName', () => {
     types: {
       export: false,
     },
-    useDateType: false,
     useOptions: false,
   };
 
@@ -54,7 +53,6 @@ describe('getOperationName', () => {
     types: {
       export: false,
     },
-    useDateType: false,
     useOptions: false,
   };
 

packages/openapi-ts/src/openApi/v2/parser/__tests__/getServices.spec.ts

@@ -19,7 +19,6 @@ describe('getServices', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/openApi/v3/parser/__tests__/getServices.spec.ts

@@ -19,7 +19,6 @@ describe('getServices', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

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

@@ -115,6 +115,11 @@ export interface UserConfig {
     | boolean
     | string
     | {
+        /**
+         * Output Date instead of string for format "date-time"
+         * @default false
+         */
+        dates?: boolean;
         /**
          * Generate types?
          * @default true
@@ -130,11 +135,6 @@ export interface UserConfig {
          */
         name?: 'PascalCase' | 'preserve';
       };
-  /**
-   * Output Date instead of string for the format "date-time" in the models
-   * @default false
-   */
-  useDateType?: boolean;
   /**
    * Use options or arguments functions
    * @default true

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

@@ -23,7 +23,6 @@ describe('registerHandlebarHelpers', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: false,
     });
     registerHandlebarHelpers();
@@ -52,7 +51,6 @@ describe('registerHandlebarTemplates', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: false,
     });
     const templates = registerHandlebarTemplates();

packages/openapi-ts/src/utils/write/__tests__/class.spec.ts

@@ -26,7 +26,6 @@ describe('writeClientClass', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/utils/write/__tests__/client.spec.ts

@@ -25,7 +25,6 @@ describe('writeClient', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: false,
     });
 

packages/openapi-ts/src/utils/write/__tests__/core.spec.ts

@@ -40,7 +40,6 @@ describe('writeCore', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 
@@ -96,7 +95,6 @@ describe('writeCore', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 
@@ -135,7 +133,6 @@ describe('writeCore', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/utils/write/__tests__/index.spec.ts

@@ -25,7 +25,6 @@ describe('processIndex', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/utils/write/__tests__/models.spec.ts

@@ -26,7 +26,6 @@ describe('processTypesAndEnums', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/utils/write/__tests__/schemas.spec.ts

@@ -27,7 +27,6 @@ describe('processSchemas', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: true,
     });
 

packages/openapi-ts/src/utils/write/__tests__/services.spec.ts

@@ -25,7 +25,6 @@ describe('processServices', () => {
       schemas: {},
       services: {},
       types: {},
-      useDateType: false,
       useOptions: false,
     });
 

packages/openapi-ts/src/utils/write/type.ts

@@ -12,7 +12,7 @@ const base = (model: Model) => {
   if (model.base === 'binary') {
     return compiler.typedef.union(['Blob', 'File']);
   }
-  if (config.useDateType && model.format === 'date-time') {
+  if (config.types.dates && model.format === 'date-time') {
     return compiler.typedef.basic('Date');
   }
   // transform root level model names

packages/openapi-ts/test/bin.spec.ts

@@ -225,8 +225,6 @@ describe('cli', () => {
       'false',
       '--operationId',
       'false',
-      '--useDateType',
-      'false',
       '--useOptions',
       'false',
       '--dry-run',
@@ -241,7 +239,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('lint: false');
     expect(result.stderr.toString()).toContain('operationId: false');
     expect(result.stderr.toString()).toContain('schemas: false');
-    expect(result.stderr.toString()).toContain('useDateType: false');
     expect(result.stderr.toString()).toContain('useOptions: false');
   });
 
@@ -267,8 +264,6 @@ describe('cli', () => {
       'true',
       '--operationId',
       'true',
-      '--useDateType',
-      'true',
       '--useOptions',
       'true',
       '--dry-run',
@@ -283,7 +278,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('lint: true');
     expect(result.stderr.toString()).toContain('operationId: true');
     expect(result.stderr.toString()).toContain('schemas: true');
-    expect(result.stderr.toString()).toContain('useDateType: true');
     expect(result.stderr.toString()).toContain('useOptions: true');
   });
 
@@ -304,7 +298,6 @@ describe('cli', () => {
       '--format',
       '--lint',
       '--operationId',
-      '--useDateType',
       '--useOptions',
       '--dry-run',
       'true',
@@ -316,7 +309,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('lint: true');
     expect(result.stderr.toString()).toContain('operationId: true');
     expect(result.stderr.toString()).toContain('schemas: true');
-    expect(result.stderr.toString()).toContain('useDateType: true');
     expect(result.stderr.toString()).toContain('useOptions: true');
     expect(result.stderr.toString()).toContain("types: 'foo");
     expect(result.stderr.toString()).toContain("services: 'bar'");

packages/openapi-ts/test/index.spec.ts

@@ -119,8 +119,10 @@ describe('OpenAPI v3', () => {
         exportCore: false,
         schemas: false,
         services: false,
-        types: '^ModelWithPattern',
-        useDateType: true,
+        types: {
+          dates: true,
+          include: '^ModelWithPattern',
+        },
       } as UserConfig,
       description: 'generate Date types',
       name: 'v3_date',
@@ -130,8 +132,10 @@ describe('OpenAPI v3', () => {
         ...config,
         schemas: false,
         services: '^Defaults',
-        types: '^ModelWithString',
-        useDateType: true,
+        types: {
+          dates: true,
+          include: '^ModelWithString',
+        },
         useOptions: false,
       } as UserConfig,
       description: 'generate legacy positional arguments',
@@ -142,8 +146,10 @@ describe('OpenAPI v3', () => {
         ...config,
         schemas: false,
         services: '^Defaults',
-        types: '^ModelWithString',
-        useDateType: true,
+        types: {
+          dates: true,
+          include: '^ModelWithString',
+        },
       } as UserConfig,
       description: 'generate optional arguments',
       name: 'v3_options',
@@ -153,7 +159,9 @@ describe('OpenAPI v3', () => {
         ...config,
         name: 'ApiClient',
         schemas: false,
-        useDateType: true,
+        types: {
+          dates: true,
+        },
       } as UserConfig,
       description: 'generate client',
       name: 'v3_client',