1. インデックス

インデックス 

これは、sbtビルド定義で見られる可能性のある一般的なメソッド、型、および値のインデックスです。コマンド名については、実行を参照してください。利用可能なプラグインについては、プラグインリストを参照してください。

値と型 

依存関係管理 

  • ModuleIDは、依存関係定義の型です。ライブラリ管理を参照してください。
  • Artifactは、ビルドおよび公開される単一のアーティファクト(jarやpomなど)を表します。ライブラリ管理およびアーティファクトを参照してください。
  • Resolverは、依存関係を解決および取得できます。多くのタイプのリゾルバーは、依存関係を公開することもできます。リポジトリは、通常、依存関係の実際の場所を指す密接に関連した概念です。ただし、sbtはこの用語と一貫性がなく、リポジトリとリゾルバーは時々同じ意味で使用されます。
  • ModuleConfigurationは、依存関係のグループに使用する特定のリゾルバーを定義します。
  • Configurationは、依存関係をグループ化するための便利なIvy構成です。ivy-configurationsを参照してください。スコープ設定にも使用されます。
  • CompileTestRuntimeProvided、およびOptionalは、定義済みの構成です。

設定とタスク 

  • Settingは、ビルド内の特定の設定を初期化する方法を記述します。他の設定の値または初期化される設定の以前の値を使用できます。
  • SettingsDefinitionは、build.sbt内の式の実際の型です。これにより、単一のSettingまたは一連の設定(SettingList)を一度に定義できます。.scalaビルド定義の型は、常に単なるSettingを使用します。
  • Initializeは、他の設定を使用して設定を初期化する方法を記述しますが、特定の設定にはまだバインドされていません。初期化メソッドと初期化する設定と組み合わせて、完全なSettingを生成します。
  • TaskKeySettingKey、およびInputKeyは、タスクまたは設定を表すキーです。これらは実際のタスクではなく、それらを参照するために使用されるキーです。これらは、ScopedTaskScopedSetting、およびScopedInputを生成するようにスコープできます。これらは、設定メソッドを提供する基本型を形成します。
  • InputTaskは、ユーザー入力を解析およびタブ補完し、実行するタスクを生成します。
  • Taskはタスクの型です。タスクは、オンデマンドで実行されるアクションです。これは、プロジェクトの初期化時に1回実行される設定とは対照的です。

ビルド構造 

  • AutoPluginは、sbt プラグインに実装されるトレイトです。
  • Projectは、ビルド内の単一のモジュールを宣言するトレイトおよびコンパニオンオブジェクトの両方です。.scalaビルド定義を参照してください。
  • Keysは、設定とタスクのすべての組み込みキーを提供するオブジェクトです。
  • Stateには、ビルドの完全な状態が含まれています。主にコマンド、場合によっては入力タスクで使用されます。状態とアクションも参照してください。

メソッド 

設定とタスク 

詳細については、入門ガイドを参照してください。

  • :=+=++= これらは、Settingを構築します。これは、設定システムにおける基本的な型です。
  • value これは、新しい設定またはタスクの定義で、別の設定またはタスクの値を使用します。このメソッドは特別であり(マクロです)、上記の設定定義メソッド(:=、…)の引数内、またはスタンドアロンの構築メソッドDef.settingとDef.task以外では使用できません。詳細については、タスクグラフを参照してください。
  • inは、参照される設定のスコープまたはスコープの一部を指定します。スコープを参照してください。

ファイルとIO 

完全なドキュメントについては、RichFilePathFinder、およびパスを参照してください。

  • / 単一のFileで呼び出されると、これはnew File(x,y)です。Seq[File]の場合、これはシーケンスの各メンバーに適用されます。
  • ***は、フィルターに一致するFileまたはSeq[File]の子(*)または子孫(**)を選択するためのメソッドです。
  • |||&&&-、および--は、ファイルを選択するためによく使用されるフィルターを組み合わせるためのメソッドです。NameFilterおよびFileFilterを参照してください。これらの名前のメソッドは、コレクション(Seqなど)やParser入力の解析を参照)などの他の型にも存在することに注意してください。
  • pair Fileから別のFileまたはStringへのマッピングを構築するために使用されます。ファイルの対応付けを参照してください。
  • getは、PathFinder(名前による呼び出しデータ構造)を厳密なSeq[File]表現に強制します。これはScalaで一般的な名前であり、Optionのような型で使用されます。

依存関係管理 

完全なドキュメントについては、ライブラリ管理を参照してください。

  • % これは、ModuleIDを構築するために使用されます。
  • %% これは%と似ていますが、クロスビルドされた依存関係を識別する点が異なります。
  • from 依存関係のフォールバックURLを指定するために使用されます
  • classifier 依存関係のclassifierを指定するために使用されます。
  • at Mavenスタイルのリゾルバーを定義するために使用されます。
  • intransitive 依存関係または構成を推移的でないとしてマークします。
  • hide 構成を内部としてマークし、公開されるメタデータに含めないようにします。

パース 

これらのメソッドは、小さなParserからParserを構築するために使用されます。これらは、標準ライブラリのパーサーコンビネータの名前と密接に対応しています。詳細については、入力のパースを参照してください。これらは、入力タスクコマンドに使用されます。

  • ~, ~>, <~ シーケンスメソッド。
  • ??, ? Parserをオプションにするためのメソッド。?は後置です。
  • id CharまたはStringリテラルをParserに変換するために使用されます。通常、Parserへの暗黙的な変換をトリガーするために使用されます。
  • |, || 選択メソッド。これらはScalaで一般的なメソッド名です。
  • ^^^ Parserが一致したときに定数を生成します。
  • +, * 後置反復メソッド。これらはScalaで一般的なメソッド名です。
  • map, flatMap Parserの結果を変換します。これらはScalaで一般的なメソッド名です。
  • filter Parserが一致する入力を制限します。これはScalaで一般的なメソッド名です。
  • - 前置否定。元のパーサーが入力と一致しない場合にのみ、入力と一致します。
  • examples, token タブ補完
  • !!! 元のパーサーが入力と一致しない場合に使用するエラーメッセージを提供します。