sbt
package sbt
- Alphabetic
- Public
- All
Type Members
-
final
case class
BuildRef(build: URI) extends BuildReference with ResolvedReference with Product with Serializable
Uniquely identifies a build by a URI.
-
sealed
trait
BuildReference extends Reference
Identifies a build.
- final case class ConfigKey(name: String) extends Product with Serializable
- sealed trait DelegateIndex extends AnyRef
- sealed trait InitializeImplicits extends InitializeImplicits0
- sealed trait InitializeImplicits0 extends AnyRef
-
sealed
trait
InputKey[T] extends Scoped with sbt.Def.KeyedInitialize[InputTask[T]] with ScopingSetting[InputKey[T]] with DefinableSetting[InputTask[T]]
Identifies an input task.
Identifies an input task. An input task parses input and produces a task to run. It consists of three parts: the scope, the name, and the type of the value produced by an input task associated with this key. The scope is represented by a value of type Scope. The name and the type are represented by a value of type
AttributeKey[InputTask[T]]
. Instances are constructed using the companion object. -
final
class
InputTask[T] extends AnyRef
Parses input and produces a task to run.
Parses input and produces a task to run. Constructed using the companion object.
-
final
case class
LocalProject(project: String) extends ProjectReference with Product with Serializable
Identifies a project in the current build context.
-
final
case class
ProjectRef(build: URI, project: String) extends ProjectReference with ResolvedReference with Product with Serializable
Uniquely references a project by a URI and a project identifier String.
-
sealed
trait
ProjectReference extends Reference
Identifies a project.
- final class PromiseWrap[A] extends AnyRef
-
sealed
trait
Reference extends AnyRef
Identifies a project or build.
-
sealed
trait
ResolvedReference extends Reference
A fully resolved, unique identifier for a project or build.
-
final
case class
RootProject(build: URI) extends ProjectReference with Product with Serializable
Identifies the root project in the specified build.
- final case class Scope(project: ScopeAxis[Reference], config: ScopeAxis[ConfigKey], task: ScopeAxis[AttributeKey[_]], extra: ScopeAxis[AttributeMap]) extends Product with Serializable
- sealed trait ScopeAxis[+S] extends AnyRef
-
final
case class
ScopeMask(project: Boolean = true, config: Boolean = true, task: Boolean = true, extra: Boolean = true) extends Product with Serializable
Specifies the Scope axes that should be used for an operation.
Specifies the Scope axes that should be used for an operation.
true
indicates an axis should be used. -
sealed
trait
Scoped extends Equals
An abstraction on top of Settings for build configuration and task definition.
-
sealed
trait
ScopedTaskable[T] extends Scoped with Taskable[T]
A common type for SettingKey and TaskKey so that both can be used as inputs to tasks.
-
final
case class
Select[S](s: S) extends ScopeAxis[S] with Product with Serializable
Select is a type constructor that is used to wrap type
S
to make a scope component, equivalent of Some in Option. -
sealed abstract
class
SettingKey[T] extends ScopedTaskable[T] with sbt.Def.KeyedInitialize[T] with ScopingSetting[SettingKey[T]] with DefinableSetting[T]
Identifies a setting.
Identifies a setting. It consists of three parts: the scope, the name, and the type of a value associated with this key. The scope is represented by a value of type Scope. The name and the type are represented by a value of type
AttributeKey[T]
. Instances are constructed using the companion object. -
trait
SlashSyntax extends AnyRef
SlashSyntax implements the slash syntax to scope keys for build.sbt DSL.
SlashSyntax implements the slash syntax to scope keys for build.sbt DSL. The implicits are set up such that the order that the scope components must appear in the order of the project axis, the configuration axis, and the task axis. This ordering is the same as the shell syntax.
Global / cancelable := true ThisBuild / scalaVersion := "2.12.2" Test / test := () console / scalacOptions += "-deprecation" Compile / console / scalacOptions += "-Ywarn-numeric-widen" projA / Compile / console / scalacOptions += "-feature" Zero / Zero / name := "foo"
Example: -
sealed abstract
class
TaskKey[T] extends ScopedTaskable[T] with sbt.Def.KeyedInitialize[Task[T]] with ScopingSetting[TaskKey[T]] with DefinableTask[T]
Identifies a task.
Identifies a task. It consists of three parts: the scope, the name, and the type of the value computed by a task associated with this key. The scope is represented by a value of type Scope. The name and the type are represented by a value of type
AttributeKey[Task[T]]
. Instances are constructed using the companion object. - trait TaskMacroExtra extends AnyRef
-
sealed
trait
Taskable[T] extends AnyRef
A SettingKey, TaskKey or
Initialize[Task]
that can be converted into anInitialize[Task]
. - sealed trait TaskableImplicits extends AnyRef
-
trait
TupleSyntax extends AnyRef
The sbt 0.10 style DSL was deprecated in 0.13.13, favouring the use of the '.value' macro.
The sbt 0.10 style DSL was deprecated in 0.13.13, favouring the use of the '.value' macro.
See https://www.scala-sbt.org/1.x/docs/Migrating-from-sbt-013x.html#Migrating+from+sbt+0.12+style for how to migrate.
-
class
sbtUnchecked extends Annotation
An annotation to designate that the annotated entity should not be considered for additional sbt compiler checks.
An annotation to designate that the annotated entity should not be considered for additional sbt compiler checks. These checks ensure that the DSL is predictable and prevents users from doing dangerous things at the cost of a stricter code structure.
- Since
1.0.0
Value Members
- object Append
- object ConfigKey extends Serializable
-
object
Def extends Init[Scope] with TaskMacroExtra with InitializeImplicits
A concrete settings system that uses
sbt.Scope
for the scope type. -
object
InputKey
Constructs InputKeys, which are associated with input tasks to define a setting.
- object InputTask
- object KeyRanks
-
object
LocalRootProject extends ProjectReference with Product with Serializable
Identifies the root project in the current build context.
- object Previous
- object ProjectRef extends Serializable
- object Reference
- object Remove
- object RootProject extends Serializable
- object Scope extends Serializable
- object ScopeAxis
-
object
Scoped
Methods and types related to constructing settings, including keys, scopes, and initializations.
-
object
SettingKey
Constructs SettingKeys, which are associated with a value to define a basic setting.
- object SlashSyntax
-
object
TaskKey
Constructs TaskKeys, which are associated with tasks to define a setting.
- object Taskable extends TaskableImplicits
-
object
This extends ScopeAxis[Nothing] with Product with Serializable
This is a scope component that represents not being scoped by the user, which later could be further scoped automatically by sbt.
-
object
ThisBuild extends BuildReference with Product with Serializable
Identifies the build for the current context.
-
object
ThisProject extends ProjectReference with Product with Serializable
Identifies the project for the current context.
- object TupleSyntax extends TupleSyntax
-
object
Zero extends ScopeAxis[Nothing] with Product with Serializable
Zero is a scope component that represents not scoping.
Zero is a scope component that represents not scoping. It is a universal fallback component that is strictly weaker than any other values on a scope axis.