How do I handle generating code with Protobuf definitions that share dependencies and plugins that generate all code to the same package and expect the same package name?

[doriable]

Sometimes you want to generate code using a plugin, such as Twirp, that puts all code into the same package, and you need to generate the code with dependencies. However this creates a conflict in the go_package options. How should I handle these cases?

[doriable]

Full example available at: https://github.com/mfridman/buf-generate-twirp-go

To start, when you generate, you can use the --include-imports flag in order to ensure that you are including the necessary dependencies. However, you'll find that you may get a conflict:

$ buf generate --include-imports --template buf.gen.yaml buf.build/acme/petapis

error:files have conflicting go_package settings, must be the same: "money" and "paymentv1alpha1"

petapis is dependent paymentapis and both are dependent on googleapis.

The workaround here is to generate the dependent modules (in this case, paymentapis) separately with a different buf.gen.yaml template that only contains the Go plugin:

# generate Go and Twirp code
$ buf generate --template buf.gen.yaml buf.build/acme/petapis

# generate dependant Go code (not using Twirp plugin)
$ buf generate --template buf.gen-go.yaml buf.build/acme/paymentapis