remove default_opts from buf.plugin.yaml #1582
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
After using buf.plugin.yaml for a bit, we discovered that 'default_opts' had more potential to confuse users than make their lives easier. It also was unclear how a user could reset options to no options if a plugin used 'default_opts'. As a result, we've migrated to remove all use of 'default_opts' so a plugin behaves the same when executed locally or remotely in buf.gen.yaml. We also make use of the 'opts' field under 'registry:' to set appropriate options for generated code by the Go module proxy or NPM registries.
mfridman
reviewed
Nov 10, 2022
mfridman
approved these changes
Nov 10, 2022
Monirul1
pushed a commit
to Monirul1/buf
that referenced
this pull request
Apr 30, 2023
After using buf.plugin.yaml for a bit, we discovered that 'default_opts' had more potential to confuse users than make their lives easier. It also was unclear how a user could reset options to no options if a plugin used 'default_opts'. As a result, we've migrated to remove all use of 'default_opts' so a plugin behaves the same when executed locally or remotely in buf.gen.yaml. We also make use of the 'opts' field under 'registry:' to set appropriate options for generated code by the Go module proxy or NPM registries.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
After using buf.plugin.yaml for a bit, we discovered that 'default_opts' had more potential to confuse users than make their lives easier. It also was unclear how a user could reset options to no options if a plugin used 'default_opts'.
As a result, we've migrated to remove all use of 'default_opts' so a plugin behaves the same when executed locally or remotely in buf.gen.yaml. We also make use of the 'opts' field under 'registry:' to set appropriate options for generated code by the Go module proxy or NPM registries.