feat: add postprocess_cmd option to run commands after code generation
#4287
+285
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new
postprocess_cmdoption to plugin configurations inbuf.gen.yaml. This allows users to specify commands that run after code generation for each plugin, enabling automatic formatting, linting, or other post-processing of generated files.Motivation
Solves #3207
Many protoc plugins generate code that doesn't conform to a project's formatting standards and some languages need postprocessing (eg. python) for the modules to be importable. Currently, users must manually run formatters and cleanup scripts after
buf generate, or maintain separate scripts. This feature allows integrating post-processing directly into the generation workflow.Common use cases:
gofmtorgoimportson generated Go codeproletariaton generated python code to fix importsUsage
Supported Variables
Commands support variable substitution:
$out- output directory (resolved with any base output path)$name- plugin name$opt- plugin options (comma-separated)$path- plugin path (for local plugins)$strategy- generation strategy ("directory" or "all")Unit tests have been added