feat(generator): add the possibility to override the title

MadManMcIvor · Nov 2, 2020 · 7551f07 · 7551f07
1 parent 45dcdc4
commit 7551f07
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -188,6 +188,8 @@ type OverrideOutput = {
 };
 
 interface OutputOptions = {
+  // override title
+  title?: (title: string) => string
   // default axios
   client?: OutputClient
   // path to the file which will contains the implementation

diff --git a/src/core/generators/angular.ts b/src/core/generators/angular.ts
@@ -27,21 +27,23 @@ export const generateAngularTitle = (title: string) => {
   };
 };
 
-export const generateAngularHeader = (title: string) => {
-  const angularTitle = generateAngularTitle(title);
-
+export const generateAngularHeader = (titles: {
+  definition: string;
+  implementation: string;
+  implementationMock: string;
+}) => {
   return {
     definition: `
-  export abstract class ${angularTitle.definition} {`,
+  export abstract class ${titles.definition} {`,
     implementation: `
   @Injectable()
-  export class ${angularTitle.implementation} implements ${angularTitle.definition} {
+  export class ${titles.implementation} implements ${titles.definition} {
     constructor(
       private http: HttpClient,
     ) {}`,
     implementationMock: `
   @Injectable()
-  export class ${angularTitle.implementationMock} extends ${angularTitle.definition} {`,
+  export class ${titles.implementationMock} extends ${titles.definition} {`,
   };
 };
 

diff --git a/src/core/generators/axios.ts b/src/core/generators/axios.ts
@@ -80,12 +80,15 @@ export const generateAxiosTitle = (title: string) => {
   };
 };
 
-export const generateAxiosHeader = (title: string) => {
-  const axiosTitle = generateAxiosTitle(title);
+export const generateAxiosHeader = (titles: {
+  definition: string;
+  implementation: string;
+  implementationMock: string;
+}) => {
   return {
-    definition: `export interface ${axiosTitle.definition} {`,
-    implementation: `export const ${axiosTitle.implementation} = (axios: AxiosInstance): ${axiosTitle.definition} => ({\n`,
-    implementationMock: `export const ${axiosTitle.implementationMock} = (): ${axiosTitle.definition} => ({\n`,
+    definition: `export interface ${titles.definition} {`,
+    implementation: `export const ${titles.implementation} = (axios: AxiosInstance): ${titles.definition} => ({\n`,
+    implementationMock: `export const ${titles.implementationMock} = (): ${titles.definition} => ({\n`,
   };
 };
 

diff --git a/src/core/generators/client.ts b/src/core/generators/client.ts
@@ -75,10 +75,12 @@ export const generateClientImports = (
 export const generateClientHeader = (
   outputClient: OutputClient = DEFAULT_CLIENT,
   title: string,
+  customTitleFunc?: (title: string) => string,
 ): GeneratorClientExtra => {
+  const titles = generateClientTitle(outputClient, title, customTitleFunc);
   return {
-    ...GENERATOR_CLIENT[outputClient].header(title),
-    implementationMSW: `export const get${pascal(title)}MSW = () => [\n`,
+    ...GENERATOR_CLIENT[outputClient].header(titles),
+    implementationMSW: `export const ${titles.implementationMSW} = () => [\n`,
   };
 };
 
@@ -94,8 +96,19 @@ export const generateClientFooter = (
 export const generateClientTitle = (
   outputClient: OutputClient = DEFAULT_CLIENT,
   title: string,
+  customTitleFunc?: (title: string) => string,
 ) => {
-  return GENERATOR_CLIENT[outputClient].title(title);
+  if (customTitleFunc) {
+    const customTitle = customTitleFunc(title);
+    return {
+      ...GENERATOR_CLIENT[outputClient].title(customTitleFunc(title)),
+      implementationMSW: `get${pascal(customTitle)}MSW`,
+    };
+  }
+  return {
+    ...GENERATOR_CLIENT[outputClient].title(title),
+    implementationMSW: `get${pascal(title)}MSW`,
+  };
 };
 
 export const generateClient = (

diff --git a/src/core/generators/react-query.ts b/src/core/generators/react-query.ts
@@ -106,7 +106,11 @@ export const generateReactQueryTitle = (title: string) => {
   };
 };
 
-export const generateReactQueryHeader = (title: string) => {
+export const generateReactQueryHeader = (title: {
+  definition: string;
+  implementation: string;
+  implementationMock: string;
+}) => {
   return {
     definition: ``,
     implementation: ``,

diff --git a/src/core/writers/singleMode.ts b/src/core/writers/singleMode.ts
@@ -36,11 +36,7 @@ export const writeSingleMode = ({
     implementation,
     implementationMocks,
     implementationMSW,
-  } = generateTarget(
-    operations,
-    info,
-    isObject(output) ? output.client : undefined,
-  );
+  } = generateTarget(operations, info, isObject(output) ? output : undefined);
 
   let data = getFilesHeader(info);
 

diff --git a/src/core/writers/splitMode.ts b/src/core/writers/splitMode.ts
@@ -37,7 +37,7 @@ export const writeSplitMode = ({
     implementation,
     implementationMocks,
     implementationMSW,
-  } = generateTarget(operations, info, output.client);
+  } = generateTarget(operations, info, output);
 
   const header = getFilesHeader(info);
 
@@ -47,7 +47,11 @@ export const writeSplitMode = ({
   let mswData = header;
 
   const defaultImports = generateClientImports(output.client);
-  const title = generateClientTitle(output.client, info.title);
+  const title = generateClientTitle(
+    output.client,
+    info.title,
+    output.override?.title,
+  );
 
   definitionData += defaultImports.definition;
 

diff --git a/src/core/writers/splitTagsMode.ts b/src/core/writers/splitTagsMode.ts
@@ -31,7 +31,7 @@ export const writeSplitTagsMode = ({
     mkdirSync(dirname);
   }
 
-  const target = generateTargetForTags(operations, info, output.client);
+  const target = generateTargetForTags(operations, info, output);
 
   Object.entries(target).forEach(([tag, target]) => {
     const {
@@ -50,7 +50,11 @@ export const writeSplitTagsMode = ({
     let mswData = header;
 
     const defaultImports = generateClientImports(output.client);
-    const title = generateClientTitle(output.client, pascal(tag));
+    const title = generateClientTitle(
+      output.client,
+      pascal(tag),
+      output.override?.title,
+    );
 
     definitionData += defaultImports.definition;
 

diff --git a/src/core/writers/tagsMode.ts b/src/core/writers/tagsMode.ts
@@ -29,7 +29,7 @@ export const writeTagsMode = ({
     mkdirSync(dirname);
   }
 
-  const target = generateTargetForTags(operations, info, output.client);
+  const target = generateTargetForTags(operations, info, output);
 
   Object.entries(target).forEach(([tag, target]) => {
     const {

diff --git a/src/core/writers/target.ts b/src/core/writers/target.ts
@@ -1,5 +1,5 @@
 import { InfoObject } from 'openapi3-ts';
-import { OutputClient } from '../../types';
+import { OutputOptions } from '../../types';
 import { GeneratorOperations } from '../../types/generator';
 import { pascal } from '../../utils/case';
 import { generalTypesFilter } from '../../utils/filters';
@@ -11,12 +11,16 @@ import {
 export const generateTarget = (
   operations: GeneratorOperations,
   info: InfoObject,
-  outputClient?: OutputClient,
+  options?: OutputOptions,
 ) =>
   Object.values(operations).reduce(
     (acc, operation, index, arr) => {
       if (!index) {
-        const header = generateClientHeader(outputClient, pascal(info.title));
+        const header = generateClientHeader(
+          options?.client,
+          pascal(info.title),
+          options?.override?.title,
+        );
         acc.definition += header.definition;
         acc.implementation += header.implementation;
         acc.implementationMocks += header.implementationMock;
@@ -34,7 +38,7 @@ export const generateTarget = (
       acc.implementationMSW += operation.implementationMSW;
 
       if (index === arr.length - 1) {
-        const footer = generateClientFooter(outputClient);
+        const footer = generateClientFooter(options?.client);
         acc.definition += footer.definition;
         acc.implementation += footer.implementation;
         acc.implementationMocks += footer.implementationMock;

diff --git a/src/core/writers/targetTags.ts b/src/core/writers/targetTags.ts
@@ -1,5 +1,5 @@
 import { InfoObject } from 'openapi3-ts';
-import { OutputClient } from '../../types';
+import { OutputOptions } from '../../types';
 import {
   GeneratorOperation,
   GeneratorOperations,
@@ -20,13 +20,16 @@ const addDefaultTagIfEmpty = (operation: GeneratorOperation) => ({
 const generateTargetTags = (
   currentAcc: { [key: string]: GeneratorTarget },
   operation: GeneratorOperation,
-  info: InfoObject,
-  outputClient?: OutputClient,
+  options?: OutputOptions,
 ) =>
   operation.tags.reduce((acc, tag) => {
     const currentOperation = acc[tag];
     if (!currentOperation) {
-      const header = generateClientHeader(outputClient, pascal(tag));
+      const header = generateClientHeader(
+        options?.client,
+        pascal(tag),
+        options?.override?.title,
+      );
 
       return {
         ...acc,
@@ -65,15 +68,15 @@ const generateTargetTags = (
 export const generateTargetForTags = (
   operations: GeneratorOperations,
   info: InfoObject,
-  outputClient?: OutputClient,
+  options?: OutputOptions,
 ) =>
   Object.values(operations)
     .map(addDefaultTagIfEmpty)
     .reduce((acc, operation, index, arr) => {
-      const targetTags = generateTargetTags(acc, operation, info, outputClient);
+      const targetTags = generateTargetTags(acc, operation, options);
 
       if (index === arr.length - 1) {
-        const footer = generateClientFooter(outputClient);
+        const footer = generateClientFooter(options?.client);
 
         return Object.entries(targetTags).reduce((acc, [tag, target]) => {
           return {

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -51,6 +51,7 @@ export interface ExternalConfigFile {
 }
 
 export type OverrideOutput = {
+  title?: (title: string) => string;
   transformer?: string;
   mutator?: string;
   operations?: { [key: string]: OperationOptions };