1. 索引

索引 

这是一个 sbt 构建定义中常见方法、类型和值的索引。有关命令名称,请参阅 运行。有关可用插件,请参阅 插件列表

值和类型 

依赖管理 

  • ModuleID 是依赖定义的类型。请参阅 库管理
  • Artifact 表示要构建和发布的单个工件(例如 jar 或 pom)。请参阅 库管理工件
  • Resolver 可以解析和检索依赖项。许多类型的 Resolver 也可以发布依赖项。仓库是一个密切相关的概念,通常是指依赖项的实际位置。但是,sbt 在此术语方面并不一致,仓库和解析器有时可以互换使用。
  • ModuleConfiguration 定义一组依赖项要使用的特定解析器。
  • Configuration 是 Ivy 用于对依赖项进行分组的有用结构。请参阅 ivy-configurations。它也用于 范围设置
  • CompileTestRuntimeProvidedOptional 是预定义的 配置

设置和任务 

  • Setting 描述了如何在构建中初始化特定设置。它可以使用其他设置的值或正在初始化的设置的先前值。
  • SettingsDefinition 是 build.sbt 中表达式的实际类型。这允许在一次定义中使用单个 Setting 或设置序列 (SettingList)。在 .scala 构建定义 中的类型始终只使用一个普通的 Setting
  • Initialize 描述了如何使用其他设置初始化设置,但尚未绑定到特定设置。与初始化方法和要初始化的设置结合使用时,它会生成一个完整的 Setting
  • TaskKeySettingKeyInputKey 是表示任务或设置的键。这些不是实际的任务,而是用于引用它们的键。它们可以根据范围产生 ScopedTaskScopedSettingScopedInput。这些构成了提供 Settings 方法的基础类型。
  • InputTask 解析并制表符完成用户输入,生成要运行的任务。
  • Task 是任务的类型。任务是在需要时运行的操作。这与设置形成对比,设置在项目初始化时仅运行一次。

构建结构 

方法 

设置和任务 

请参阅 入门指南 以了解更多信息。

  • :=+=++= 这些构建一个 Setting,它是 设置 系统中的基本类型。
  • value 这在定义新设置或任务时使用另一个设置或任务的值。此方法很特殊(它是一个宏),除了在上述设置定义方法(:=、…)的参数中或在独立的构造方法 Def.setting 和 Def.task 中之外,不能使用。有关详细信息,请参阅 任务图
  • in 指定被引用的设置的 范围范围 的一部分。请参阅 范围

文件和 I/O 

请参阅 RichFilePathFinder路径 以获取完整文档。

  • / 当对单个 File 调用时,这是 new File(x,y)。对于 Seq[File],这将应用于序列的每个成员。
  • *** 是选择与过滤器匹配的文件或 Seq[File] 的子项 (*) 或后代 (**) 的方法。
  • |||&&&--- 是用于组合过滤器的 方法,这些过滤器通常用于选择文件。请参阅 NameFilterFileFilter。请注意,具有这些名称的方法也存在于其他类型中,例如集合(如 Seq)和 Parser(请参阅 解析输入)。
  • pair 用于从 File 构建映射到另一个 File 或到 String 的映射。请参阅 映射文件
  • get 强制 PathFinder(一个按名称调用的数据结构)转换为严格的 Seq[File] 表示形式。这是 Scala 中的一个常见名称,由 Option 等类型使用。

依赖管理 

请参阅 库管理 以获取完整文档。

  • % 这用于构建 ModuleID
  • %% 这类似于 %,只是它标识了一个已 交叉构建 的依赖项。
  • from 用于指定依赖项的回退 URL
  • classifier 用于指定依赖项的分类器。
  • at 用于定义 Maven 样式的解析器。
  • intransitive依赖项Configuration 标记为非传递。
  • hideConfiguration 标记为内部的,并且不包含在已发布的元数据中。

解析 

这些方法用于从较小的 Parser 构建 Parser。它们严格遵循标准库的解析器组合器的名称。有关完整文档,请参阅 解析输入。这些用于 输入任务命令

  • ~~><~ 排序方法。
  • ??? 使 Parser 可选的方法。? 是后缀。
  • id 用于将 Char 或 String 字面量转换为 Parser。它通常用于触发隐式转换为 Parser。
  • ||| 选择方法。这些是 Scala 中的常见方法名称。
  • ^^^ 当 Parser 匹配时产生一个常数值。
  • +* 后缀重复方法。这些是 Scala 中的常见方法名称。
  • mapflatMap 转换 Parser 的结果。这些是 Scala 中的常见方法名称。
  • filter 限制 Parser 匹配的输入。这是 Scala 中的常见方法名称。
  • - 前缀否定。仅在原始解析器不匹配输入时匹配输入。
  • examplestoken 制表符完成
  • !!! 提供一个错误消息,用于在原始解析器不匹配输入时使用。