Merge pull request #398 from stackb/pcj/example-ts-proto-outputs

Add example of ts-proto vendored assets

Author: pcj

.bazelrc

@@ -10,17 +10,21 @@ common --incompatible_use_plus_in_repo_names
 # =========================================================================
 
 # Don't leak PATH and LD_LIBRARY_PATH into the build.
-# build --incompatible_strict_action_env
+build --incompatible_strict_action_env
 
 # Don't use legacy repository rules.
 build --incompatible_disable_native_repo_rules
 
 # C++17 for protobuf compatibility
-build --host_cxxopt=-std=c++17
-build --cxxopt=-std=c++17
+build --host_cxxopt=-std=c++17 --cxxopt=-std=c++17
 
 # To facilitate testing in bazelci incompatible flags
 # @see https://github.com/bazelbuild/bazel/pull/26906#issue-3386957462
 # build --incompatible_autoload_externally=@rules_python,+java_common,+JavaInfo,+JavaPluginInfo,+ProguardSpecProvider,+java_binary,+java_import,+java_library,+java_plugin,+java_test,+java_runtime,+java_toolchain,+java_package_configuration,@com_google_protobuf,@rules_shell,+@rules_android,+@rules_cc
 # build --incompatible_autoload_externally=@rules_shell
 build --incompatible_autoload_externally=
+
+# This flag is present only to demonstrate the effect on generated ts-proto
+# assets (see example/assets/*.ts). Without this, the generated descriptor sets
+# from the proto_library rule will be devoid of source info.
+build --experimental_proto_descriptor_sets_include_source_info

example/assets/BUILD.bazel

@@ -9,19 +9,28 @@ load("@rules_proto//proto:defs.bzl", "proto_library")
 # gazelle:proto_language java enable false
 # gazelle:proto_language python enable false
 # gazelle:proto_language scala enable false
-# gazelle:proto_language ts_proto enable false
 
 # -- modifies the inherited go configuration
+# gazelle:proto_language go enable true
 # gazelle:proto_language go -rule proto_compile
-# gazelle:proto_language go -rule proto_go_library
 # gazelle:proto_language go +rule proto_compiled_sources
+# gazelle:proto_language go -rule proto_go_library
+
+# -- modifies the inherited ts_proto configuration
+# gazelle:proto_language ts_proto enable true
+# gazelle:proto_language ts_proto -rule proto_compile
+# gazelle:proto_language ts_proto +rule proto_compiled_sources
+# gazelle:proto_language ts_proto -rule proto_ts_library
 
 proto_compile_assets(
     name = "assets",
     deps = [
         ":api_go_compiled_sources",
         ":api_request_go_compiled_sources",
+        ":api_request_ts_proto_compiled_sources",
         ":api_response_go_compiled_sources",
+        ":api_response_ts_proto_compiled_sources",
+        ":api_ts_proto_compiled_sources",
     ],
 )
 
@@ -73,3 +82,45 @@ proto_compiled_sources(
     proto = "api_response_proto",
     visibility = ["//visibility:public"],
 )
+
+proto_compiled_sources(
+    name = "api_ts_proto_compiled_sources",
+    srcs = ["api.ts"],
+    args = ["--include_source_info"],
+    options = {"@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto": [
+        "emitImportedFiles=false",
+        "esModuleInterop=true",
+        "comments=true",
+    ]},
+    plugins = ["@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto"],
+    proto = "api_proto",
+    visibility = ["//visibility:public"],
+)
+
+proto_compiled_sources(
+    name = "api_request_ts_proto_compiled_sources",
+    srcs = ["api_request.ts"],
+    args = ["--include_source_info"],
+    options = {"@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto": [
+        "emitImportedFiles=false",
+        "esModuleInterop=true",
+        "comments=true",
+    ]},
+    plugins = ["@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto"],
+    proto = "api_request_proto",
+    visibility = ["//visibility:public"],
+)
+
+proto_compiled_sources(
+    name = "api_response_ts_proto_compiled_sources",
+    srcs = ["api_response.ts"],
+    args = ["--include_source_info"],
+    options = {"@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto": [
+        "emitImportedFiles=false",
+        "esModuleInterop=true",
+        "comments=true",
+    ]},
+    plugins = ["@build_stack_rules_proto//plugin/stephenh/ts-proto:protoc-gen-ts-proto"],
+    proto = "api_response_proto",
+    visibility = ["//visibility:public"],
+)

example/assets/api.pb.go

@@ -1,3 +1,5 @@
+// ts-proto: Adding a comment to the syntax will become the first
+// comment in the output source file.
 syntax = "proto3";
 
 package example.assets;
@@ -7,7 +9,11 @@ import "example/assets/api_response.proto";
 
 option go_package = "github.com/stackb/rules_proto/example/assets;assets";
 
+// ApiExchange is a demonstrative example of an API call that has a request and
+// a response.
 message ApiExchange {
+  // request is the API request
   ApiRequest request = 1;
+  // response is the API response
   ApiResponse response = 2;
 }

example/assets/api.proto

@@ -0,0 +1,118 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+import { ApiRequest } from "./api_request";
+import { ApiResponse } from "./api_response";
+
+export const protobufPackage = "example.assets";
+
+/**
+ * ts-proto: Adding a comment to the syntax will become the first
+ * comment in the output source file.
+ */
+
+/**
+ * ApiExchange is a demonstrative example of an API call that has a request and
+ * a response.
+ */
+export interface ApiExchange {
+  /** request is the API request */
+  request:
+    | ApiRequest
+    | undefined;
+  /** response is the API response */
+  response: ApiResponse | undefined;
+}
+
+function createBaseApiExchange(): ApiExchange {
+  return { request: undefined, response: undefined };
+}
+
+export const ApiExchange = {
+  encode(message: ApiExchange, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.request !== undefined) {
+      ApiRequest.encode(message.request, writer.uint32(10).fork()).ldelim();
+    }
+    if (message.response !== undefined) {
+      ApiResponse.encode(message.response, writer.uint32(18).fork()).ldelim();
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ApiExchange {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseApiExchange();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.request = ApiRequest.decode(reader, reader.uint32());
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.response = ApiResponse.decode(reader, reader.uint32());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ApiExchange {
+    return {
+      request: isSet(object.request) ? ApiRequest.fromJSON(object.request) : undefined,
+      response: isSet(object.response) ? ApiResponse.fromJSON(object.response) : undefined,
+    };
+  },
+
+  toJSON(message: ApiExchange): unknown {
+    const obj: any = {};
+    if (message.request !== undefined) {
+      obj.request = ApiRequest.toJSON(message.request);
+    }
+    if (message.response !== undefined) {
+      obj.response = ApiResponse.toJSON(message.response);
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<ApiExchange>, I>>(base?: I): ApiExchange {
+    return ApiExchange.fromPartial(base ?? {});
+  },
+
+  fromPartial<I extends Exact<DeepPartial<ApiExchange>, I>>(object: I): ApiExchange {
+    const message = createBaseApiExchange();
+    message.request = (object.request !== undefined && object.request !== null)
+      ? ApiRequest.fromPartial(object.request)
+      : undefined;
+    message.response = (object.response !== undefined && object.response !== null)
+      ? ApiResponse.fromPartial(object.response)
+      : undefined;
+    return message;
+  },
+};
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}

example/assets/api.ts

@@ -0,0 +1,77 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "example.assets";
+
+export interface ApiRequest {
+  header: string[];
+}
+
+function createBaseApiRequest(): ApiRequest {
+  return { header: [] };
+}
+
+export const ApiRequest = {
+  encode(message: ApiRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    for (const v of message.header) {
+      writer.uint32(10).string(v!);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ApiRequest {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseApiRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.header.push(reader.string());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ApiRequest {
+    return { header: Array.isArray(object?.header) ? object.header.map((e: any) => String(e)) : [] };
+  },
+
+  toJSON(message: ApiRequest): unknown {
+    const obj: any = {};
+    if (message.header?.length) {
+      obj.header = message.header;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<ApiRequest>, I>>(base?: I): ApiRequest {
+    return ApiRequest.fromPartial(base ?? {});
+  },
+
+  fromPartial<I extends Exact<DeepPartial<ApiRequest>, I>>(object: I): ApiRequest {
+    const message = createBaseApiRequest();
+    message.header = object.header?.map((e) => e) || [];
+    return message;
+  },
+};
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };