feat: added the "typePrefix" and "typeSuffix" options. (#1069)

Fixes #1033

README.markdown

@@ -555,6 +555,10 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useNullAsOptional=true`, `undefined` values will be converted to `null`, and if you use `optional` label in your `.proto` file, the field will have `undefined` type as well. for example:
 
+- With `--ts_proto_opt=typePrefix=MyPrefix`, the generated interfaces, enums, and factories will have a prefix of `MyPrefix` in their names.
+
+- With `--ts_proto_opt=typeSuffix=MySuffix`, the generated interfaces, enums, and factories will have a suffix of `MySuffix` in their names.
+
 ```protobuf
 message ProfileInfo {
     int32 id = 1;

integration/affixes/affixes.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package affixes;
+
+message AwesomeMessage {
+  message Inner {
+  }
+}
+
+enum AwesomeEnum {
+  AWESOME_ENUM_AWESOME = 0;
+  AWESOME_ENUM_COOL = 1;
+  AWESOME_ENUM_JUST_OKAY = 2;
+}
+
+service AwesomeService {
+}

integration/affixes/parameters.txt

@@ -0,0 +1 @@
+typePrefix=Prefix,typeSuffix=Suffix

src/options.ts

@@ -104,6 +104,8 @@ export type Options = {
   annotateFilesWithVersion: boolean;
   noDefaultsForOptionals: boolean;
   bigIntLiteral: boolean;
+  typePrefix: string;
+  typeSuffix: string;
 };
 
 export function defaultOptions(): Options {
@@ -172,6 +174,8 @@ export function defaultOptions(): Options {
     annotateFilesWithVersion: true,
     noDefaultsForOptionals: false,
     bigIntLiteral: true,
+    typePrefix: "",
+    typeSuffix: "",
   };
 }
 

src/visit.ts

@@ -39,8 +39,9 @@ export function visit(
     const protoFullName = protoPrefix + enumDesc.name;
     // I.e. FooBar_ZazInner
     const tsFullName = tsPrefix + maybeSnakeToCamel(enumDesc.name, options);
+    const tsFullNameWithAffixes = `${options.typePrefix}${tsFullName}${options.typeSuffix}`;
     const nestedSourceInfo = sourceInfo.open(childEnumType, index);
-    enumFn(tsFullName, enumDesc, nestedSourceInfo, protoFullName);
+    enumFn(tsFullNameWithAffixes, enumDesc, nestedSourceInfo, protoFullName);
   });
 
   const messages = "messageType" in proto ? proto.messageType : proto.nestedType;
@@ -51,8 +52,9 @@ export function visit(
     const protoFullName = protoPrefix + message.name;
     // I.e. FooBar_ZazInner
     const tsFullName = tsPrefix + maybeSnakeToCamel(messageName(message), options);
+    const tsFullNameWithAffixes = `${options.typePrefix}${tsFullName}${options.typeSuffix}`;
     const nestedSourceInfo = sourceInfo.open(childType, index);
-    messageFn(tsFullName, message, nestedSourceInfo, protoFullName);
+    messageFn(tsFullNameWithAffixes, message, nestedSourceInfo, protoFullName);
     const delim = options.useSnakeTypeName ? "_" : "";
     visit(message, nestedSourceInfo, messageFn, options, enumFn, tsFullName + delim, protoFullName + ".");
   });

tests/options-test.ts

@@ -51,6 +51,8 @@ describe("options", () => {
           "keys",
         ],
         "stringEnums": false,
+        "typePrefix": "",
+        "typeSuffix": "",
         "unknownFields": false,
         "unrecognizedEnum": true,
         "unrecognizedEnumName": "UNRECOGNIZED",