Skip to content

Add PB.importRoot setting and implementation #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add PB.importRoot setting and implementation #346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## [1.0.8]
* Add option `PB.importRoot` (defaults to `PB.protoSources`) that allows you to set the directory
that protobuf `import`s will be evaluated in.

## [1.0.7]
* Update default protoc to 3.21.7

Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,9 @@ libraryDependencies ++= Seq(
// Changing where to look for protos to compile (default src/main/protobuf):
Compile / PB.protoSources := Seq(sourceDirectory.value / "somewhere")

// Changing where to look for relative `import`s (defaults to `PB.protoSources`):
Compile / PB.importRoot := (Compile / baseDirectory).value / "protos"

// Additional options to pass to protoc:
Compile / PB.protocOptions := Seq("-xyz")

Expand Down
10 changes: 9 additions & 1 deletion src/main/scala/sbtprotoc/ProtocPlugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ object ProtocPlugin extends AutoPlugin {
)
val recompile = TaskKey[Boolean]("protoc-recompile")

val importRoot = SettingKey[File](
"protobuf-import-root",
"Directory to use when resolving .proto import directives."
)

val Target = protocbridge.Target
val gens = protocbridge.gens
val ProtocPlugin = "protoc-plugin"
Expand Down Expand Up @@ -313,7 +318,10 @@ object ProtocPlugin extends AutoPlugin {
PB.manifestProcessing := true,
PB.includePaths := (
PB.includePaths.?.value.getOrElse(Nil) ++
PB.protoSources.value ++
(PB.importRoot.?.value match {
case None => PB.protoSources.value
case Some(root) => Seq(root)
}) ++
Seq(PB.externalIncludePath.value, PB.externalSourcePath.value) ++
protocIncludeDependencies.value,
).distinct,
Expand Down