feature: (nodejs) ability to add prefix\suffix for type names and enum keys

js2me · js2me · commit f69b156de0e5 · 2022-11-11T17:55:04.000+06:00
```ts
typePrefix?: string;
typeSuffix?: string;
enumKeyPrefix?: string;
enumKeySuffix?: string;
```
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,13 @@ BREAKING_CHANGE: add ability to custom prefix for autofix invalid enum keys, inv
 BREAKING_CHANGE: by default all component enum schemas (even numeric) extracting as `enum` TS constructions (#344)   
 feature: ability to extract all enums from nested types\interfaces to `enum` TS construction using `--extract-enums` option (#344)   
 feature: ability to modify route path params before insert them into string (request url, #446, with using hook `onInsertPathParam`)  
+feature: (nodejs) ability to add prefix\suffix for type names and enum keys  
+```ts
+typePrefix?: string;
+typeSuffix?: string;
+enumKeyPrefix?: string;
+enumKeySuffix?: string;
+```
 docs: update docs for `extraTemplates` option  
 
 # 11.1.3  
diff --git a/index.d.ts b/index.d.ts
@@ -143,6 +143,14 @@ interface GenerateApiParamsBase {
   fixInvalidTypeNamePrefix?: string;
   /** prefix string value needed to fix invalid enum keys (default: 'Value') */
   fixInvalidEnumKeyPrefix?: string;
+  /** prefix string value for enum keys */
+  enumKeyPrefix?: string;
+  /** suffix string value for enum keys */
+  enumKeySuffix?: string;
+  /** prefix string value for type names */
+  typePrefix?: string;
+  /** suffix string value for type names */
+  typeSuffix?: string;
 }
 
 type CodeGenConstruct = {
@@ -448,6 +456,8 @@ export interface GenerateApiConfiguration {
     singleHttpClient: boolean;
     typePrefix: string;
     typeSuffix: string;
+    enumKeyPrefix: string;
+    enumKeySuffix: string;
     patch: boolean;
     cleanOutput: boolean;
     debug: boolean;
diff --git a/src/configuration.js b/src/configuration.js
@@ -131,6 +131,8 @@ class CodeGenConfig {
   silent = false;
   typePrefix = "";
   typeSuffix = "";
+  enumKeyPrefix = "";
+  enumKeySuffix = "";
   patch = false;
   componentTypeNameResolver = new ComponentTypeNameResolver([]);
   /** name of the main exported class */
diff --git a/src/schema-parser/schema-parser.js b/src/schema-parser/schema-parser.js
@@ -123,13 +123,9 @@ class SchemaParser {
           const formattedKey =
             (enumName &&
               this.typeName.format(enumName, {
-                ignorePrefix: true,
-                ignoreSuffix: true,
                 type: "enum-key",
               })) ||
             this.typeName.format(`${enumValue}`, {
-              ignorePrefix: true,
-              ignoreSuffix: true,
               type: "enum-key",
             });
 
@@ -151,8 +147,6 @@ class SchemaParser {
         content = _.map(schema.enum, (key) => {
           return {
             key: this.typeName.format(`${key}`, {
-              ignorePrefix: true,
-              ignoreSuffix: true,
               type: "enum-key",
             }),
             type: keyType,
diff --git a/src/type-name.js b/src/type-name.js
@@ -21,17 +21,21 @@ class TypeName {
 
   /**
    * @param name
-   * @param options {{ ignorePrefix?: boolean, ignoreSuffix?: boolean, fixPrefix?: string; type?: FormattingSchemaType }}
+   * @param options {{ type?: FormattingSchemaType }}
    * @return {string}
    */
   format = (name, options) => {
-    const typePrefix = options && options.ignorePrefix ? "" : this.config.typePrefix;
-    const typeSuffix = options && options.ignoreSuffix ? "" : this.config.typeSuffix;
-    const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
+    options = options || {};
+
     /**
      * @type {FormattingSchemaType}
      */
-    const schemaType = (options && options.type) || "type-name";
+    const schemaType = options.type || "type-name";
+
+    const typePrefix = schemaType === "enum-key" ? this.config.enumKeyPrefix : this.config.typePrefix;
+    const typeSuffix = schemaType === "enum-key" ? this.config.enumKeySuffix : this.config.typeSuffix;
+
+    const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
 
     if (typeof name !== "string") {
       this.logger.warn("wrong name of the model name", name);
diff --git a/tests/generated/v3.0/wrong-schema-names.ts b/tests/generated/v3.0/wrong-schema-names.ts
@@ -13,7 +13,7 @@
  * Not found response
  * @example "Not found"
  */
-export type FF = string;
+export type DF = string;
 
 /**
  * Not found response
diff --git a/tests/schemas/v3.0/wrong-schema-names.yaml b/tests/schemas/v3.0/wrong-schema-names.yaml
@@ -184,7 +184,7 @@ components:
       description: Not found response
       type: string
       example: Not found
-    $FF:
+    $DF:
       description: Not found response
       type: string
       example: Not found
diff --git a/tests/spec/extract-enums/expected.ts b/tests/spec/extract-enums/expected.ts
@@ -9,108 +9,108 @@
  * ---------------------------------------------------------------
  */
 
-export enum EnumRoot {
-  Key100644 = "100644",
-  Key100755 = "100755",
-  Key040000 = "040000",
-  Key160000 = "160000",
-  Key120000 = "120000",
-  Test1 = "test1",
-  Test2 = "test2",
+export enum TypeNamePrefixEnumRootTypeNameSuffix {
+  EnumKeyPrefixInvalidKey100644EnumKeySuffix = "100644",
+  EnumKeyPrefixInvalidKey100755EnumKeySuffix = "100755",
+  EnumKeyPrefixInvalidKey040000EnumKeySuffix = "040000",
+  EnumKeyPrefixInvalidKey160000EnumKeySuffix = "160000",
+  EnumKeyPrefixInvalidKey120000EnumKeySuffix = "120000",
+  EnumKeyPrefixTest1EnumKeySuffix = "test1",
+  EnumKeyPrefixTest2EnumKeySuffix = "test2",
 }
 
-export interface Tree {
+export interface TypeNamePrefixTreeTypeNameSuffix {
   tree?: {
-    mode?: TreeMode;
-    "mode-num"?: TreeModeNum;
-    type?: TreeType;
-    bereke?: TreeBereke;
+    mode?: TypeNamePrefixTreeModeTypeNameSuffix;
+    "mode-num"?: TypeNamePrefixTreeModeNumTypeNameSuffix;
+    type?: TypeNamePrefixTreeTypeTypeNameSuffix;
+    bereke?: TypeNamePrefixTreeBerekeTypeNameSuffix;
   }[];
 }
 
-export enum OnlyEnumNames {
-  Bla = "Bla",
-  Blabla = "Blabla",
-  Boiler = "Boiler",
+export enum TypeNamePrefixOnlyEnumNamesTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "Bla",
+  EnumKeyPrefixBlablaEnumKeySuffix = "Blabla",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
 
-export enum StringOnlyEnumNames {
-  Bla = "Bla",
-  Blabla = "Blabla",
-  Boiler = "Boiler",
+export enum TypeNamePrefixStringOnlyEnumNamesTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "Bla",
+  EnumKeyPrefixBlablaEnumKeySuffix = "Blabla",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
 
-export enum StringEnums {
-  Bla = "foo",
-  Blabla = "bar",
-  Boiler = "Boiler",
+export enum TypeNamePrefixStringEnumsTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "foo",
+  EnumKeyPrefixBlablaEnumKeySuffix = "bar",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
 
-export enum StringCompleteEnums {
-  Bla = "foo",
-  Blabla = "bar",
-  Boiler = "baz",
+export enum TypeNamePrefixStringCompleteEnumsTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "foo",
+  EnumKeyPrefixBlablaEnumKeySuffix = "bar",
+  EnumKeyPrefixBoilerEnumKeySuffix = "baz",
 }
 
 /** @format int32 */
-export enum EmptyEnum {
-  Bla = "Bla",
-  Blabla = "Blabla",
-  Boiler = "Boiler",
+export enum TypeNamePrefixEmptyEnumTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "Bla",
+  EnumKeyPrefixBlablaEnumKeySuffix = "Blabla",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
 
 /** @format int32 */
-export enum EnumWithMoreNames {
-  Bla = 1,
-  Blabla = "Blabla",
-  Boiler = "Boiler",
+export enum TypeNamePrefixEnumWithMoreNamesTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = 1,
+  EnumKeyPrefixBlablaEnumKeySuffix = "Blabla",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
 
 /** @format int32 */
-export enum SomeInterestEnum {
-  Bla = 6,
-  Blabla = 2,
-  Boiler = 1,
-  Bbabab = 67,
-  Nowadays = 88,
-  FAIL = 122,
-  Vvvvv = 88,
-  ASdasAS = 0,
-  ASDsacZX = 213,
-  Zook = 12378,
-  EnumMm = 123125,
-  VCsa = 32452,
-  Yuuu = 1111,
-  ASddd = 66666,
-  ASdsdsa = "ASdsdsa",
-  ASDds = "ASDds",
-  HSDFDS = "HSDFDS",
+export enum TypeNamePrefixSomeInterestEnumTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = 6,
+  EnumKeyPrefixBlablaEnumKeySuffix = 2,
+  EnumKeyPrefixBoilerEnumKeySuffix = 1,
+  EnumKeyPrefixBbababEnumKeySuffix = 67,
+  EnumKeyPrefixNowadaysEnumKeySuffix = 88,
+  EnumKeyPrefix_FAIL_EnumKeySuffix = 122,
+  EnumKeyPrefixVvvvvEnumKeySuffix = 88,
+  EnumKeyPrefixASdasASEnumKeySuffix = 0,
+  EnumKeyPrefixASDsacZXEnumKeySuffix = 213,
+  EnumKeyPrefixZookEnumKeySuffix = 12378,
+  EnumKeyPrefixEnumMmEnumKeySuffix = 123125,
+  EnumKeyPrefixVCsaEnumKeySuffix = 32452,
+  EnumKeyPrefixYuuuEnumKeySuffix = 1111,
+  EnumKeyPrefixASdddEnumKeySuffix = 66666,
+  EnumKeyPrefixASdsdsaEnumKeySuffix = "ASdsdsa",
+  EnumKeyPrefixASDdsEnumKeySuffix = "ASDds",
+  EnumKeyPrefix_HSDFDS_EnumKeySuffix = "HSDFDS",
 }
 
-export enum TreeMode {
-  Key100644 = "100644",
-  Key100755 = "100755",
-  Key040000 = "040000",
-  Key160000 = "160000",
-  Key120000 = "120000",
+export enum TypeNamePrefixTreeModeTypeNameSuffix {
+  EnumKeyPrefixInvalidKey100644EnumKeySuffix = "100644",
+  EnumKeyPrefixInvalidKey100755EnumKeySuffix = "100755",
+  EnumKeyPrefixInvalidKey040000EnumKeySuffix = "040000",
+  EnumKeyPrefixInvalidKey160000EnumKeySuffix = "160000",
+  EnumKeyPrefixInvalidKey120000EnumKeySuffix = "120000",
 }
 
-export enum TreeModeNum {
-  Key100644 = 100644,
-  Key100755 = 100755,
-  Key40000 = 40000,
-  Key160000 = 160000,
-  Key120000 = 120000,
+export enum TypeNamePrefixTreeModeNumTypeNameSuffix {
+  EnumKeyPrefixInvalidKey100644EnumKeySuffix = 100644,
+  EnumKeyPrefixInvalidKey100755EnumKeySuffix = 100755,
+  EnumKeyPrefixInvalidKey40000EnumKeySuffix = 40000,
+  EnumKeyPrefixInvalidKey160000EnumKeySuffix = 160000,
+  EnumKeyPrefixInvalidKey120000EnumKeySuffix = 120000,
 }
 
-export enum TreeType {
-  Blob = "blob",
-  Tree = "tree",
-  Commit = "commit",
+export enum TypeNamePrefixTreeTypeTypeNameSuffix {
+  EnumKeyPrefixBlobEnumKeySuffix = "blob",
+  EnumKeyPrefixTreeEnumKeySuffix = "tree",
+  EnumKeyPrefixCommitEnumKeySuffix = "commit",
 }
 
-export enum TreeBereke {
-  Bla = "Bla",
-  Blabla = "Blabla",
-  Boiler = "Boiler",
+export enum TypeNamePrefixTreeBerekeTypeNameSuffix {
+  EnumKeyPrefixBlaEnumKeySuffix = "Bla",
+  EnumKeyPrefixBlablaEnumKeySuffix = "Blabla",
+  EnumKeyPrefixBoilerEnumKeySuffix = "Boiler",
 }
diff --git a/tests/spec/extract-enums/schema.ts b/tests/spec/extract-enums/schema.ts
diff --git a/tests/spec/extract-enums/test.js b/tests/spec/extract-enums/test.js
