Merge pull request ferdikoomen#1141 from markbrockhoff/add-model-postfix

ferdikoomen · web-flow · commit 2a26cb7fe44f · 2022-10-28T10:37:41.000+02:00
Add model postfix
diff --git a/README.md b/README.md
@@ -48,7 +48,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     -h, --help                display help for command
 
diff --git a/bin/index.js b/bin/index.js
@@ -21,7 +21,9 @@ const params = program
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
-    .option('--postfix <value>', 'Service name postfix', 'Service')
+    .option('--postfix <value>', 'Deprecated: Use --postfixServices instead. Service name postfix', 'Service')
+    .option('--postfixServices <value>', 'Service name postfix', 'Service')
+    .option('--postfixModels <value>', 'Model name postfix')
     .option('--request <value>', 'Path to custom request file')
     .parse(process.argv)
     .opts();
@@ -41,7 +43,8 @@ if (OpenAPI) {
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
-        postfix: params.postfix,
+        postfixServices: params.postfixServices ?? params.postfix,
+        postfixModels: params.postfixModels,
         request: params.request,
     })
         .then(() => {
diff --git a/bin/index.spec.js b/bin/index.spec.js
@@ -34,8 +34,10 @@ describe('bin', () => {
             'true',
             '--indent',
             '4',
-            '--postfix',
+            '--postfixServices',
             'Service',
+            '--postfixModels',
+            'Dto',
         ]);
         expect(result.stdout.toString()).toBe('');
         expect(result.stderr.toString()).toBe('');
@@ -67,4 +69,18 @@ describe('bin', () => {
         expect(result.stdout.toString()).toContain(`-o, --output <value>`);
         expect(result.stderr.toString()).toBe('');
     });
+
+    it('should still support the deprecated --postfix parameter', () => {
+        const result = crossSpawn.sync('node', [
+            './bin/index.js',
+            '--input',
+            './test/spec/v3.json',
+            '--output',
+            './test/generated/bin',
+            '--postfix',
+            'Service',
+        ]);
+        expect(result.stdout.toString()).toBe('');
+        expect(result.stderr.toString()).toBe('');
+    });
 });
diff --git a/docs/basic-usage.md b/docs/basic-usage.md
@@ -18,7 +18,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     -h, --help                display help for command
 
diff --git a/src/index.ts b/src/index.ts
@@ -24,7 +24,8 @@ export type Options = {
     exportModels?: boolean;
     exportSchemas?: boolean;
     indent?: Indent;
-    postfix?: string;
+    postfixServices?: string;
+    postfixModels?: string;
     request?: string;
     write?: boolean;
 };
@@ -44,7 +45,8 @@ export type Options = {
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
  * @param indent Indentation options (4, 2 or tab)
- * @param postfix Service name postfix
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
  * @param request Path to custom request file
  * @param write Write the files to disk (true or false)
  */
@@ -60,7 +62,8 @@ export const generate = async ({
     exportModels = true,
     exportSchemas = false,
     indent = Indent.SPACE_4,
-    postfix = 'Service',
+    postfixServices = 'Service',
+    postfixModels = '',
     request,
     write = true,
 }: Options): Promise<void> => {
@@ -89,7 +92,8 @@ export const generate = async ({
                 exportModels,
                 exportSchemas,
                 indent,
-                postfix,
+                postfixServices,
+                postfixModels,
                 clientName,
                 request
             );
@@ -112,7 +116,8 @@ export const generate = async ({
                 exportModels,
                 exportSchemas,
                 indent,
-                postfix,
+                postfixServices,
+                postfixModels,
                 clientName,
                 request
             );
diff --git a/src/templates/index.hbs b/src/templates/index.hbs
@@ -18,13 +18,13 @@ export type { OpenAPIConfig } from './core/OpenAPI';
 
 {{#each models}}
 {{#if @root.useUnionTypes}}
-export type { {{{name}}} } from './models/{{{name}}}';
+export type { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else if enum}}
-export { {{{name}}} } from './models/{{{name}}}';
+export { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else if enums}}
-export { {{{name}}} } from './models/{{{name}}}';
+export { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else}}
-export type { {{{name}}} } from './models/{{{name}}}';
+export type { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{/if}}
 {{/each}}
 {{/if}}
@@ -41,7 +41,7 @@ export { ${{{name}}} } from './schemas/${{{name}}}';
 {{#if services}}
 
 {{#each services}}
-export { {{{name}}}{{{@root.postfix}}} } from './services/{{{name}}}{{{@root.postfix}}}';
+export { {{{name}}}{{{@root.postfixServices}}} } from './services/{{{name}}}{{{@root.postfixServices}}}';
 {{/each}}
 {{/if}}
 {{/if}}
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -28,7 +28,8 @@ import { writeClientServices } from './writeClientServices';
  * @param exportSchemas Generate schemas
  * @param exportSchemas Generate schemas
  * @param indent Indentation options (4, 2 or tab)
- * @param postfix Service name postfix
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
  * @param clientName Custom client class name
  * @param request Path to custom request file
  */
@@ -44,7 +45,8 @@ export const writeClient = async (
     exportModels: boolean,
     exportSchemas: boolean,
     indent: Indent,
-    postfix: string,
+    postfixServices: string,
+    postfixModels: string,
     clientName?: string,
     request?: string
 ): Promise<void> => {
@@ -75,7 +77,7 @@ export const writeClient = async (
             useUnionTypes,
             useOptions,
             indent,
-            postfix,
+            postfixServices,
             clientName
         );
     }
@@ -94,7 +96,7 @@ export const writeClient = async (
 
     if (isDefined(clientName)) {
         await mkdir(outputPath);
-        await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfix);
+        await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfixServices);
     }
 
     if (exportCore || exportServices || exportSchemas || exportModels) {
@@ -108,7 +110,8 @@ export const writeClient = async (
             exportServices,
             exportModels,
             exportSchemas,
-            postfix,
+            postfixServices,
+            postfixModels,
             clientName
         );
     }
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -34,7 +34,7 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service');
+        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', '');
 
         expect(writeFile).toBeCalledWith('/index.ts', 'index');
     });
diff --git a/src/utils/writeClientIndex.ts b/src/utils/writeClientIndex.ts
@@ -19,7 +19,8 @@ import { sortServicesByName } from './sortServicesByName';
  * @param exportServices Generate services
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
- * @param postfix Service name postfix
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
  * @param clientName Custom client class name
  */
 export const writeClientIndex = async (
@@ -31,7 +32,8 @@ export const writeClientIndex = async (
     exportServices: boolean,
     exportModels: boolean,
     exportSchemas: boolean,
-    postfix: string,
+    postfixServices: string,
+    postfixModels: string,
     clientName?: string
 ): Promise<void> => {
     const templateResult = templates.index({
@@ -40,7 +42,8 @@ export const writeClientIndex = async (
         exportModels,
         exportSchemas,
         useUnionTypes,
-        postfix,
+        postfixServices,
+        postfixModels,
         clientName,
         server: client.server,
         version: client.version,
diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
diff --git a/test/index.spec.ts b/test/index.spec.ts
diff --git a/types/index.d.ts b/types/index.d.ts
