sbtの設定のカスタマイズ

このページでは、基本的な使い方以外のsbtの設定について説明します。

コンパイル対象のprotobufディレクトリを追加

以下のように PB.protoSources に追加します。

Compile / PB.protoSources += file("新たにコンパイル対象に追加したいディレクトリへのpath")

参照するprotobufディレクトリを追加

protocの-Iの引数に相当するものです。それほど多くないパターンかもしれませんが、つまり

  • すでにScalaPBによって生成済みのScalaコードと、そのScalaコードをコンパイルしたものが存在include
  • そのScalaコードの生成元となった.protoのメッセージの定義などを参照しつつ、それに依存したさらに別のメッセージやサービスを定義してScalaコード生成をしたい

というような場合です。設定方法は、以下のようにincludePathsというKeyに対してディレクトリを追加します。

Compile / PB.includePaths += file("参照したいprotoファイルが置いてあるディレクトリ")

includePathsに限らず、おそらく他のprotocに渡されるkeyに関しても共通ですが、 古いScalaPBでは.getCanonicalFile の呼び出しが必要になる可能性がありますgetCanonicalFile。

コンパイルする.protoファイルのフィルター

以下のようにexcludeFilterというkeyを設定すると、特定の.protoファイルをコンパイル対象から除外することが可能です。 exclude

PB.generate / excludeFilter := {
  // ここにfilterの定義を書く
  "*Foo.proto"
}

excludeFilterは、Key自体はsbtの標準でありSettingKey[FileFilter]という型です。

文字列を書くと、正規表現のようなものと認識されるimplicit defがあったり

それ以外にもいろいろな種類のfilterが書けます。詳細は以下のコードなどを参考にしてください。

jarの中に.protoファイルを含める

ScalaPBでコード生成したものを含んだものをライブラリとして提供する場合や、 コード生成をするsbtのモジュールが複数あってそれらに依存関係があるときは、 以下のような設定resource-protoを追加しておき、リソースとして.protoファイルを含めておくとよいでしょう。

Compile / unmanagedResourceDirectories ++= (Compile / PB.protoSources).value

jarの中にある.protoファイルを参照する

sbt-protobufのpluginには、自動でそのための機能が存在します。以下のように、参照したい.protoファイルが含まれているjarを% "protobuf"をつけてlibraryDependenciesを書くだけです。

libraryDependencies += "com.example" %% "example" % "0.1.0" % "protobuf"
include. 外部ライブラリとして、もしくはsbtのマルチプロジェクトの一部として、という意味 ↩
getCanonicalFile. sbt plugin側で自動で呼び出せばいいと思ったので、pull requestしてmerge済みです。ScalaPB 0.5.21以降は必要ないはずです https://github.com/sbt/sbt-protobuf/pull/35 ↩
exclude. ただしsbt-scalapbが依存しているsbt-protobufが、0.5.0以降である必要があります。sbt-scalapb 0.5.21以降対応済みのはずです https://github.com/scalapb/sbt-scalapb/pull/8 https://github.com/scalapb/ScalaPB/issues/24 https://github.com/sbt/sbt-protobuf/pull/29 ↩
resource-proto. あくまで標準のprotoファイル用のディレクトリ以下のファイルを含める場合の設定例なので、標準以外の場所のprotoファイルを含めたい場合は設定を変えてください ↩

results matching ""

    No results matching ""