Add support for gazelle:resolve directives
#127
Conversation
This file contains hidden or 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
|
|
…ution Addresses bufbuild#117. Add support for `gazelle:resolve buf` directives in the buf gazelle plugin's `CrossResolve` function. This allows users to override the default `@buf_deps//` resolution for proto imports, enabling proper integration with `local_path_override` modules in bzlmod monorepos. The `CrossResolve` function now first checks for `gazelle:resolve buf` directives using the standard `resolve.FindRuleWithOverride` function. If a matching directive is found, return that label. Otherwise, fall back to the default `@buf_deps//` resolution. Example Usage ```python This directive goes in a BUILD file (typically root or parent directory) and tells gazelle to resolve imports of proto/foo/bar.proto to the label @com_example//proto/foo:bar_proto instead of the default @buf_deps//... resolution. ``` Test Coverage ``` bazel test //... ``` Co-Authored-By: Claude Opus 4.5 <[email protected]>
electronjoe
force-pushed
the
respect-gazelle-resolve-local
branch
from
8792ded to
50c92e3
Compare
Member
srikrsna-buf
left a comment
srikrsna-buf
left a comment
There was a problem hiding this comment.
Thank you! Left some minor style nits.
Comment on lines
+49
to
+50
| bufConfig := GetConfigForGazelleConfig(gazelleConfig) | ||
| depRepo := getRepoNameForPath(bufConfig.BufConfigFile.Pkg) |
Member
There was a problem hiding this comment.
Suggested change
| bufConfig := GetConfigForGazelleConfig(gazelleConfig) | |
| depRepo := getRepoNameForPath(bufConfig.BufConfigFile.Pkg) | |
| config := GetConfigForGazelleConfig(gazelleConfig) | |
| depRepo := getRepoNameForPath(config.BufConfigFile.Pkg) |
| } | ||
| config := GetConfigForGazelleConfig(gazelleConfig) | ||
| depRepo := getRepoNameForPath(config.BufConfigFile.Pkg) | ||
|
|
| if override, ok := resolve.FindRuleWithOverride(gazelleConfig, bufImportSpec, "buf"); ok { | ||
| return []resolve.FindResult{{Label: override}} | ||
| } | ||
|
|
srikrsna-buf
changed the title
gazelle:resolve directives
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Addresses #117.
Add support for
gazelle:resolve bufdirectives in the buf gazelle plugin'sCrossResolvefunction. This allows users to override the default@buf_deps//resolution for proto imports, enabling proper integration withlocal_path_overridemodules in bzlmod monorepos.The
CrossResolvefunction now first checks forgazelle:resolve bufdirectives using the standardresolve.FindRuleWithOverridefunction. If a matching directive is found, return that label. Otherwise, fall back to the default@buf_deps//resolution.Example Usage
# gazelle:resolve buf proto/foo/bar.proto @com_example//proto/foo:bar_protoThis directive goes in a BUILD file (typically root or parent directory) and tells gazelle to resolve imports of proto/foo/bar.proto to the label @com_example//proto/foo:bar_proto instead of the default @buf_deps//... resolution.
Test Coverage
Additionally, in the repository cited in #117, this patch addresses one (of two) issues uncovered.