feat(ts-proto-stephenh#859): updated docs and renamed methods to toOn…

…ly and fromOnly
Frabat · Jul 19, 2023 · 8f9d490 · 8f9d490
1 parent 088ffd7
commit 8f9d490
Show file tree

Hide file tree

Showing 13 changed files with 9 additions and 5 deletions.
diff --git a/README.markdown b/README.markdown
@@ -376,6 +376,10 @@ Generated code will be placed in the Gradle build directory.
 
   This is also useful if you want "only types".
 
+- With `--ts_proto_opt=outputJsonMethods=to-only` and `--ts_proto_opt=outputJsonMethods=from-only` you will be able to export only one between the `Message.toJSON` and `Message.fromJSON` methods.
+
+  This is useful if you're using ts-proto just to `encode` or `decode` and not for both.
+
 - With `--ts_proto_opt=outputPartialMethods=false`, the `Message.fromPartial` and `Message.create` methods for accepting partially-formed objects/object literals will not be output.
 
 - With `--ts_proto_opt=stringEnums=true`, the generated enum types will be string-based instead of int-based.

diff --git a/...ration/output-decode-only-json/decode.bin → integration/output-fromJSON-only/decode.bin b/...ration/output-decode-only-json/decode.bin → integration/output-fromJSON-only/decode.bin
diff --git a/...tion/output-decode-only-json/decode.proto → ...gration/output-fromJSON-only/decode.proto b/...tion/output-decode-only-json/decode.proto → ...gration/output-fromJSON-only/decode.proto
diff --git a/...gration/output-decode-only-json/decode.ts → integration/output-fromJSON-only/decode.ts b/...gration/output-decode-only-json/decode.ts → integration/output-fromJSON-only/decode.ts
diff --git a/...ode-only-json/google/protobuf/wrappers.ts → ...fromJSON-only/google/protobuf/wrappers.ts b/...ode-only-json/google/protobuf/wrappers.ts → ...fromJSON-only/google/protobuf/wrappers.ts
diff --git a/...on/output-decode-only-json/parameters.txt → ...ation/output-fromJSON-only/parameters.txt b/...on/output-decode-only-json/parameters.txt → ...ation/output-fromJSON-only/parameters.txt
@@ -1 +1 @@
-outputEncodeMethods=false,outputPartialMethods=false,outputJsonMethods=decode-only,nestJs=false
+outputEncodeMethods=false,outputPartialMethods=false,outputJsonMethods=from-only,nestJs=false
diff --git a/...ration/output-encode-only-json/encode.bin → integration/output-toJSON-only/encode.bin b/...ration/output-encode-only-json/encode.bin → integration/output-toJSON-only/encode.bin
diff --git a/...tion/output-encode-only-json/encode.proto → integration/output-toJSON-only/encode.proto b/...tion/output-encode-only-json/encode.proto → integration/output-toJSON-only/encode.proto
diff --git a/...gration/output-encode-only-json/encode.ts → integration/output-toJSON-only/encode.ts b/...gration/output-encode-only-json/encode.ts → integration/output-toJSON-only/encode.ts
diff --git a/...ode-only-json/google/protobuf/wrappers.ts → ...t-toJSON-only/google/protobuf/wrappers.ts b/...ode-only-json/google/protobuf/wrappers.ts → ...t-toJSON-only/google/protobuf/wrappers.ts
diff --git a/...on/output-encode-only-json/parameters.txt → ...gration/output-toJSON-only/parameters.txt b/...on/output-encode-only-json/parameters.txt → ...gration/output-toJSON-only/parameters.txt
@@ -1 +1 @@
-outputEncodeMethods=false,outputPartialMethods=false,outputJsonMethods=encode-only,nestJs=false
+outputEncodeMethods=false,outputPartialMethods=false,outputJsonMethods=to-only,nestJs=false
diff --git a/src/main.ts b/src/main.ts
@@ -235,10 +235,10 @@ export function generateFile(ctx: Context, fileDesc: FileDescriptorProto): [stri
           staticMembers.push(generateDecodeTransform(fullName));
         }
         if (options.outputJsonMethods) {
-          if (options.outputJsonMethods === true || options.outputJsonMethods === "decode-only") {
+          if (options.outputJsonMethods === true || options.outputJsonMethods === "from-only") {
             staticMembers.push(generateFromJson(ctx, fullName, fullTypeName, message));
           }
-          if (options.outputJsonMethods === true || options.outputJsonMethods === "encode-only") {
+          if (options.outputJsonMethods === true || options.outputJsonMethods === "to-only") {
             staticMembers.push(generateToJson(ctx, fullName, fullTypeName, message));
           }
         }

diff --git a/src/options.ts b/src/options.ts
@@ -46,7 +46,7 @@ export type Options = {
   fileSuffix: string;
   importSuffix: string;
   outputEncodeMethods: true | false | "encode-only" | "decode-only" | "encode-no-creation";
-  outputJsonMethods: true | false | "encode-only" | "decode-only";
+  outputJsonMethods: true | false | "to-only" | "from-only";
   outputPartialMethods: boolean;
   outputTypeAnnotations: boolean | "static-only";
   outputTypeRegistry: boolean;