search

thesayyn / protoc-gen-ts

Compile protocol buffer messages to TypeScript.
MIT License
362 stars 75 forks source link

snake_case to camelCase conversion #254

Open Dugnom opened 9 months ago

Dugnom commented 9 months ago

I have set up a nest.js instance with their grpc microservice. The grpc microservice is providing the interfaces in json default camelCase as seems to be the expected standard by grpc clients. Is it possible for protoc-gen-ts to generate the interface to match this provided interface? Currently the case is kept as snake_case, as it is standard in proto files.

There would be a workaround by implementing sth. equivalent to here: https://github.com/nestjs/nest/issues/9047, but I'm not a fan, since the deviation in the standard seems to be from this plugin.

Is there an option to provide the typescript interfaces in camelCase?

I also don't understand how I am the only one with this problem, should I be doing something different?

graup commented 9 months ago

Have you tried --ts_opt=json_names?

Dugnom commented 9 months ago

I have not, because I understood the flag to allow optional json names to be defined in square brackets, like discussed here https://github.com/thesayyn/protoc-gen-ts/pull/142

I should have tried using the flag, you're right, but I was expecting the default behaviour to be the one defined in the standard, where the variable names are changed from snake to camel case.

I will not be able to test it in the next two weeks, since I've changed my workflow to use https://github.com/stephenh/ts-proto , which worked as expected without any flags and I now have other priorities. Still interested in working it out though.

Do you know if it would be the correct flag or are you just guessing by the name? Either way I appreciate you trying to help me! If you do not know if it would work I will try to keep "testing --ts_opt=json_names" on my todo list.

Dugnom commented 9 months ago

I was more succesful today digging into this, then last week and found the following threads on this topic: https://github.com/thesayyn/protoc-gen-ts/issues/78 , https://github.com/thesayyn/protoc-gen-ts/pull/89 and https://github.com/thesayyn/protoc-gen-ts/pull/98 where the consensus seemed to be to make the conversion default, but it seems like in the end nobody took the time to write any tests which stopped it from being merged.

But, as is only implied in the title of the PR https://github.com/thesayyn/protoc-gen-ts/pull/142 , the json names option was added and using it would lead to the behaviour I've expected. As I said, I was confused by the discussion about the optional json names.

This is how I understand the current situation and the timeline, maybe I am wrong, but wanted to share hoping I am helping someone else understand. I will just use the other project instead of using barely documented workarounds in this one.

Please correct me if I misunderstood!

thesayyn commented 9 months ago

This is supported by default on main branch of this repo. I have rewritten everything from scratch and now we support fromJSON and toJSON.

Dugnom commented 9 months ago

Thank you for the time of day you're giving me. As you can probably guess, I'm just getting into grpc communication and don't know much. I am assuming I am on main branch since I've installed the latest npm package.

I don't understand why you have implemented it like you did, but that is clearly a lack of knowledge on my part. I am sure I could have looked deeper into the documentation and made myself more familiar with the tool.

But if you forgive me reiterating the same point in every message, why is it implemented in the way it is. Is it meant not to automatically translate from snake to camel or did I just use the tool in an unintended way? I just want to understand the landscape better.

You're of course not obligated to teach me, and it is clearly a useful tool for many. Feel free to close this issue either way and have a good time!

thesayyn commented 9 months ago

No worries, it's design choice i have made when i started the plugin, original generator for the JS has converted field names to Getters/Setters which many people didn't like.

That said, --json_names is no longer applicable as we now fully support JSON payloads, if you use the Rust implementation of this plugin. you can simply do message.fromJson and message.toJson.

See https://github.com/thesayyn/protoc-gen-ts/issues/255

thesayyn commented 9 months ago

I am going to label this as documentation issue, which it clearly is. Feel free to send a PR improving the documentation.