feat: add generate options

Author: moecasts

.sage/einrideeslint.go

@@ -14,8 +14,8 @@ const (
 	name               = "eslint"
 	packageJSONContent = `{
   "dependencies": {
-    "@einride/eslint-plugin": "4.2.0",
-    "eslint": "8.5.0"
+    "@einride/eslint-plugin": "7.4.0",
+    "eslint": "8.51.0"
   }
 }`
 )

README.md

@@ -23,9 +23,53 @@ Or download a prebuilt binary from [releases](./releases).
 ```bash
 protoc 
   --typescript-http_out [OUTPUT DIR] \
+  --typescript-http_opt use_enum_numbers=true,use_multi_line_comment=true
   [.proto files ...]
 ```
 
+#### Support options
+
+```ts
+// UseProtoNames controls the casing of generated field names.
+// If set to true, fields will use proto names (typically snake_case).
+// If omitted or set to false, fields will use JSON names (typically camelCase).
+use_proto_names: bool
+
+// UseEnumNumbers emits enum values as numbers.
+use_enum_numbers: bool
+
+// The method names of service methods naming case.
+// Only work when `UseEnumNumbers=true`
+// opt:
+// camelcase: convert name to lower camel case like `camelCase`
+// pascalcase: convert name to pascalcase like `PascalCase`
+// default is pascalcase
+enum_field_naming: string
+
+// Generate comments as multiline comments.
+// multiline comments: /** ... */
+// single line comments: // ...
+use_multi_line_comment: bool
+
+// force add `undefined` to message field.
+// default true
+force_message_field_undefinable: bool
+
+// If set to true, body will be JSON.stringify before send
+// default true
+use_body_stringify: bool
+
+// The method names of service methods naming case.
+// opt:
+// camelcase: convert name to lower camel case like `camelCase`
+// pascalcase: convert name to pascalcase like `PascalCase`
+// default is pascalcase
+service_method_naming: 'camelcase' | 'pascalcase'
+
+// If set to true, field int64 and uint64 will convert to string
+force_long_as_string: bool
+```
+
 ---
 
 The generated clients can be used with any HTTP client that returns a Promise containing JSON data.
@@ -39,11 +83,17 @@ type Request = {
   body: string | null
 }
 
-function fetchRequestHandler({path, method, body}: Request) {
+// This is optional
+type RequestOptions = {
+  useCache?: boolean;
+}
+
+function fetchRequestHandler({path, method, body}: Request & RequestOptions) {
   return fetch(rootUrl + path, {method, body}).then(response => response.json())
 }
 
 export function siteClient() {
-  return createShipperServiceClient(fetchRequestHandler);
+  // This Generics is optional
+  return createShipperServiceClient<RequestOptions>(fetchRequestHandler);
 }
 ```

examples/proto/buf.gen.yaml

@@ -3,3 +3,4 @@ version: v1
 plugins:
   - name: typescript-http
     out: gen/typescript
+    opt: use_enum_numbers=true,force_message_field_undefined=false,use_body_stringify=false,service_method_naming=camelcase,force_long_as_string=true

examples/proto/einride/example/freight/v1/freight_service.proto

@@ -21,15 +21,19 @@ import "google/protobuf/field_mask.proto";
 // - Each Shipper has a collection of [Site][einride.example.freight.v1.Site]
 //   resources, named `shippers/*/sites/*`
 //
-// - Each Shipper has a collection of [Shipment][einride.example.freight.v1.Shipment]
+// - Each Shipper has a collection of
+// [Shipment][einride.example.freight.v1.Shipment]
 //   resources, named `shippers/*/shipments/*`
 service FreightService {
   option (google.api.default_host) = "freight-example.einride.tech";
 
   // Get a shipper.
   // See: https://google.aip.dev/131 (Standard methods: Get).
   rpc GetShipper(GetShipperRequest) returns (Shipper) {
-    option (google.api.http) = {get: "/v1/{name=shippers/*}"};
+    option (google.api.http) = {
+      get: "/v1/{name=shippers/*}",
+      additional_bindings {get: "/v1/{name=shippers-alias/*}"}
+    };
     option (google.api.method_signature) = "name";
   }
 
@@ -261,8 +265,8 @@ message ListSitesResponse {
 
 // Request message for FreightService.CreateSite.
 message CreateSiteRequest {
-  // The resource name of the parent shipper for which this site will be created.
-  // Format: shippers/{shipper}
+  // The resource name of the parent shipper for which this site will be
+  // created. Format: shippers/{shipper}
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {child_type: "freight-example.einride.tech/Shipper"}
@@ -339,8 +343,8 @@ message ListShipmentsResponse {
 
 // Request message for FreightService.CreateShipment.
 message CreateShipmentRequest {
-  // The resource name of the parent shipper for which this shipment will be created.
-  // Format: shippers/{shipper}
+  // The resource name of the parent shipper for which this shipment will be
+  // created. Format: shippers/{shipper}
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {child_type: "freight-example.einride.tech/Shipper"}

examples/proto/einride/example/freight/v1/shipment.proto

@@ -5,6 +5,16 @@ package einride.example.freight.v1;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+
+enum ShipmentState {
+  // The shipment' state is unknown
+  UNKNOWN_UNSPECIFIED = 0;
+  // The shipment'state is active
+  ACTIVE = 1;
+  // The shipment'state is inactive
+  INACTIVE = 2;
+}
 
 // A shipment represents transportation of goods between an origin
 // [site][einride.example.freight.v1.Site] and a destination
@@ -62,6 +72,16 @@ message Shipment {
 
   // Annotations of the shipment.
   map<string, string> annotations = 12;
+
+  // The state of the shipment
+  ShipmentState state = 14;
+
+  // wrapper string
+  optional google.protobuf.StringValue wrapper_string = 15;
+  // long number
+  int64 long_number = 16;
+  // wrapper long number
+  google.protobuf.Int64Value wrapper_long_number = 17;
 }
 
 // A shipment line item.
@@ -73,5 +93,5 @@ message LineItem {
   // The weight of the line item in kilograms.
   float weight_kg = 3;
   // The volume of the line item in cubic meters.
-  float volume_m3 = 4;
+  optional float volume_m3 = 4;
 }