Add includeFilter and excludeFilter as a posibility to decide what .proto's to generate
#29
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
…e what protobufs to use in the code generation
|
By they way. This pull request does not include an update to README.MD. Let me know if you consider it important to document (it's kind of expected behaviour, though) |
|
The change looks pretty straightforward, will it be possible to merge it? |
|
What is blocking this? |
|
+1 |
eed3si9n
added a commit
to eed3si9n/sbt-protobuf
that referenced
this pull request
Mar 5, 2024
**Problem** When compiling complex protobuf schema, you often run into a situation where you need some external schema during the compilation, but you don't necessarily want to include the resulting Java output as your own output because there's already a precompiled or well-known bytecode version of the class. A good example of this is classes under com/google/protobuf, but there are others as well. In theory sbt#29 has added excludeFilter support, but in practice sbt's file filter doesn't work for directory name matching. **Solution** This reimplements the protobuf file filtering using the new Glob, which can match directory names. As a demonstration, `protobufExcludeFilters` is initialized to glob `Glob(d.toPath()) / "google" / "protobuf" / "*.proto"`. This will filter out protobuf sources which are precompiled in "com.google.protobuf" % "protobuf-java".
Merged
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.
Hello
Thanks for this great plugin.
includeFilterandexcludeFilterare common among plugins that generate code. In this particular case it would allow us to select what protos we want to ignore or "compile".It's useful especially when having dependencies with a number of protos but we are only interested in only a few. Also when some libraries contain protos and also the java classes and we do not want to re-compile them in order to avoid duplicates in our classpath
An example (that I already use) would be:
(excludeFilter in PB.protobufConfig) := "value-types.proto" || "documentation.proto"That would include all protos except "value-types.proto" and "documentation.proto"
The default setup doesn't modify the existing filter. This is: "*.proto"
For more information about include and exclude filter, please have a look to: http://www.scala-sbt.org/0.13/docs/Howto-Customizing-Paths.html#Include%2Fexclude+files+in+the+source+directory
Regards