format tool

[unship]

I use clang-format to format proto file, but the output option section of proto file is not what I expect,

say I clang-format -i examples/proto/examplepb/a_bit_of_everything.proto

I get

option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
  info : {title : "A Bit of Everything";
version : "1.0";
contact : {
name:
  "gRPC-Gateway project";
url:
  "https://github.com/grpc-ecosystem/grpc-gateway";
email:
  "none@example.com";
};
}
;
// Overwriting host entry breaks tests, so this is not done here.
external_docs : {
url:
  "https://github.com/grpc-ecosystem/grpc-gateway";
description:
  "More about gRPC-Gateway";
}
schemes : HTTP;
schemes : HTTPS;
schemes : WSS;
consumes : "application/json";
consumes : "application/x-foo-mime";
produces : "application/json";
produces : "application/x-foo-mime";
security_definitions : {
security : {
key:
  "BasicAuth";
value : {
type:
  TYPE_BASIC;
}
}
security : {
key:
  "ApiKeyAuth";
value : {
type:
  TYPE_API_KEY;
in:
  IN_HEADER;
name:
  "X-API-Key";
}
}
security : {
key:
  "OAuth2";
value : {
type:
  TYPE_OAUTH2;
flow:
  FLOW_ACCESS_CODE;
authorization_url:
  "https://example.com/oauth/authorize";
token_url:
  "https://example.com/oauth/token";
scopes : {
scope : {
key:
  "read";
value:
  "Grants read access";
}
scope : {
key:
  "write";
value:
  "Grants write access";
}
scope : {
key:
  "admin";
value:
  "Grants read and write access to administrative information";
}
}
}
}
}
security : {
security_requirement : {
key:
  "BasicAuth";
value : {};
}
security_requirement : {
key:
  "ApiKeyAuth";
value : {};
}
}
security : {
security_requirement : {
key:
  "OAuth2";
value : {
scope:
  "read";
scope:
  "write";
}
}
security_requirement : {
key:
  "ApiKeyAuth";
value : {};
}
}
responses : {
key:
  "403";
value : {
description:
  "Returned when the user does not have permission to access the resource.";
}
}
responses : {
key:
  "404";
value : {
description:
  "Returned when the resource does not exist.";
schema : {
json_schema : {
type:
  STRING;
}
}
}
}
responses : {
key:
  "418";
value : {
description:
  "I'm a teapot.";
schema : {
json_schema : {
ref:
  ".grpc.gateway.examples.examplepb.NumericEnum";
}
}
}
}
}
;

so what format tool are you using?

[johanbrandhorst]

The files in this repo are manually formatted, but a formatting tool that solves this much better than clang is prototool.

I'll close this issue as it's largely unrelated to the gateway, but feel free to reopen if you have more questions.

[yuhang2]

Hey @llVim , Do you find the solution for how to formatting proto file?

[unship]

@yuhang2 not yet

[johanbrandhorst]

As I said in my previous comment, using prototool --no-rewrite format works well for me.

[ec2ainun]

@johanbrandhorst
Hi johan, can you provide guide in documentation on how to setup prototool with current grpc-gateway /v2 ?
i am new and try to work with grpc-gateway
i already use buf to generate stub, but unfortunately there is no buf format right now

[johanbrandhorst]

Do you need any particular configuration to use the prototool formatter on its own? buf is going to get a formatter eventually, we just haven't gotten around to implementing it yet 😁.

[ec2ainun]

@johanbrandhorst not really sir 😄
i just want to format .proto file, but i got problem on importing

<input>:1:1:Import "google/api/annotations.proto" was not found.
<input>:1:1:Import "protoc-gen-openapiv2/options/annotations.proto" was not found.
api/proto/v1/todo-service.proto:6:1:Import "google/api/annotations.proto" was not found or had errors.
api/proto/v1/todo-service.proto:7:1:Import "protoc-gen-openapiv2/options/annotations.proto" was not found or had errors.

and im try to look for solution on the prototool github issue, but it seems no one responding, i know that it will be replaced by buf, as for now, i just wanna search working solution haha
reference issue:
Import "google/api/annotations.proto" was not found or had errors

[johanbrandhorst]

Yeah I'm not sure, I don't know prototool, I haven't used it in years. I'm afraid maybe you just don't use formatting for now?

[ec2ainun]

@johanbrandhorst okay sir, thanks for replaying
as for now, manually formatted is the way, while waiting buf format release.