protobuf-es icon indicating copy to clipboard operation
protobuf-es copied to clipboard

Document `rewrite_imports` option in `MANUAL.md` + Explain how to do gradual migration

Open tenzinhl opened this issue 8 months ago • 0 comments

We ended up doing a very large migration internally within our company that was all at once when migrating from protobuf-es v1 to protobuf-es v2 (to get access to connect-es v2 features).

However, it would've been very helpful for us if we had been aware of the rewrite_imports plugin option to instead do the migration in a piece-wise fashion as demonstrated by @timostamm 's lovely example repo HERE. (Would've also been huge for relocating sources within our bazel output tree)

I'm not sure I fully understand the plugin option myself yet since we didn't use it, but a mention in MANUAL.md would be awesome. It would also be lovely if the "How to migrate" section of the MANUAL.md could highlight that it's possible to do the migration in a piecewise fashion with a link to https://github.com/timostamm/example-protobuf-es-v1-to-v2.

Related Info

Issue comment where @timostamm discusses the rewrite_imports plugin.

  • https://github.com/bufbuild/protobuf-es/issues/947#issuecomment-2257889255

Thanks a bunch for the project team.

tenzinhl avatar Aug 16 '25 04:08 tenzinhl