Packages

o

sbt

Def

object Def extends Init[Scope] with TaskMacroExtra with InitializeImplicits

A concrete settings system that uses sbt.Scope for the scope type.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Def
  2. InitializeImplicits
  3. InitializeImplicits0
  4. TaskMacroExtra
  5. Init
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Classpath = Seq[Attributed[File]]
  2. type CompiledMap = Map[ScopedKey[_], Compiled[_]]
    Definition Classes
    Init
  3. final class InitOps[T] extends AnyVal
  4. final class InitTaskOps[T] extends AnyVal
  5. type MapConstant = ~>[ScopedKey, Option]
    Definition Classes
    Init
  6. type MapScoped = ~>[ScopedKey, ScopedKey]
    Definition Classes
    Init
  7. type ScopeLocal = (ScopedKey[_]) ⇒ Seq[Setting[_]]
    Definition Classes
    Init
  8. type ScopedMap = IMap[ScopedKey, SettingSeq]
    Definition Classes
    Init
  9. type SettingSeq[T] = Seq[Setting[T]]
    Definition Classes
    Init
  10. type ValidateRef = ~>[ScopedKey, ValidatedRef]
    Definition Classes
    Init
  11. type ValidatedInit[T] = Either[Seq[Undefined], Initialize[T]]
    Definition Classes
    Init
  12. type ValidatedRef[T] = Either[Undefined, ScopedKey[T]]
    Definition Classes
    Init
  13. type VirtualClasspath = Seq[Attributed[VirtualFile]]
  14. final class Compiled[T] extends AnyRef
    Definition Classes
    Init
  15. final class Flattened extends AnyRef
    Definition Classes
    Init
  16. sealed trait Initialize[T] extends AnyRef

    Abstractly defines a value of type T.

    Abstractly defines a value of type T.

    Specifically it defines a node in a task graph, where the dependencies represents dependent nodes, and evaluate represents the calculation based on the existing body of knowledge.

    T

    the type of the value this defines.

    Definition Classes
    Init
  17. sealed trait Keyed[S, T] extends Initialize[T]

    An Initialize[T] associated with a ScopedKey[S].

    An Initialize[T] associated with a ScopedKey[S].

    S

    the type of the associated ScopedKey

    T

    the type of the value this Initialize defines.

    Definition Classes
    Init
  18. trait KeyedInitialize[T] extends Keyed[T, T]

    A Keyed where the type of the value and the associated ScopedKey are the same.

    A Keyed where the type of the value and the associated ScopedKey are the same.

    T

    the type of both the value this Initialize defines and the type of the associated ScopedKey.

    Definition Classes
    Init
  19. final class RuntimeUndefined extends RuntimeException
    Definition Classes
    Init
  20. sealed case class ScopedKey[T](scope: ScopeType, key: AttributeKey[T]) extends KeyedInitialize[T] with Product with Serializable
    Definition Classes
    Init
  21. sealed class Setting[T] extends SettingsDefinition
    Definition Classes
    Init
  22. final class SettingList extends SettingsDefinition
    Definition Classes
    Init
  23. sealed trait SettingsDefinition extends AnyRef
    Definition Classes
    Init
  24. final class Undefined extends AnyRef
    Definition Classes
    Init
  25. final class Uninitialized extends Exception
    Definition Classes
    Init

Value Members

  1. def Undefined(defining: Setting[_], referencedKey: ScopedKey[_]): Undefined
    Definition Classes
    Init
  2. def Uninitialized(validKeys: Seq[ScopedKey[_]], delegates: (Scope) ⇒ Seq[Scope], keys: Seq[Undefined], runtime: Boolean)(implicit display: Show[ScopedKey[_]]): Uninitialized
    Definition Classes
    Init
  3. def add[T](m: ScopedMap, s: Setting[T]): ScopedMap
    Definition Classes
    Init
  4. def addLocal(init: Seq[Setting[_]])(implicit scopeLocal: ScopeLocal): Seq[Setting[_]]
    Definition Classes
    Init
  5. def app[K[L[x]], T](inputs: K[Initialize])(f: (K[internal.util.Types.Id]) ⇒ T)(implicit alist: AList[K]): Initialize[T]
    Definition Classes
    Init
  6. def append[T](ss: Seq[Setting[T]], s: Setting[T]): Seq[Setting[T]]
    Definition Classes
    Init
  7. def asFunction[T](s: Settings[Scope]): (ScopedKey[T]) ⇒ T
    Definition Classes
    Init
  8. def asTransform(s: Settings[Scope]): ~>[ScopedKey, internal.util.Types.Id]
    Definition Classes
    Init
  9. def bind[S, T](in: Initialize[S])(f: (S) ⇒ Initialize[T]): Initialize[T]
    Definition Classes
    Init
  10. lazy val capturedTransformations: Initialize[~>[Initialize, Initialize]]

    The result of this initialization is the composition of applied transformations.

    The result of this initialization is the composition of applied transformations. This can be useful when dealing with dynamic Initialize values.

    Definition Classes
    Init
  11. def compile(sMap: ScopedMap): CompiledMap
    Definition Classes
    Init
  12. def compiled(init: Seq[Setting[_]], actual: Boolean = true)(implicit delegates: (Scope) ⇒ Seq[Scope], scopeLocal: ScopeLocal, display: Show[ScopedKey[_]]): CompiledMap
    Definition Classes
    Init
  13. def definedAtString(settings: Seq[Setting[_]]): String
    Definition Classes
    Init
  14. def delegate(sMap: ScopedMap)(implicit delegates: (Scope) ⇒ Seq[Scope], display: Show[ScopedKey[_]]): ScopedMap
    Definition Classes
    Init
  15. final def derive[T](s: Setting[T], allowDynamic: Boolean = false, filter: (Scope) ⇒ Boolean = const(true), trigger: (AttributeKey[_]) ⇒ Boolean = const(true), default: Boolean = false): Setting[T]

    Constructs a derived setting that will be automatically defined in every scope where one of its dependencies is explicitly defined and the where the scope matches filter.

    Constructs a derived setting that will be automatically defined in every scope where one of its dependencies is explicitly defined and the where the scope matches filter. A setting initialized with dynamic dependencies is only allowed if allowDynamic is true. Only the static dependencies are tracked, however. Dependencies on previous values do not introduce a derived setting either.

    Definition Classes
    Init
  16. def deriveAllowed[T](s: Setting[T], allowDynamic: Boolean): Option[String]
    Definition Classes
    DefInit
  17. def displayBuildRelative(currentBuild: URI, project: Reference): String
  18. def displayFull(scoped: ScopedKey[_], keyNameColor: Option[String]): String
  19. def displayFull(scoped: ScopedKey[_]): String
  20. def displayMasked(scoped: ScopedKey[_], mask: ScopeMask, showZeroConfig: Boolean): String
  21. def displayMasked(scoped: ScopedKey[_], mask: ScopeMask): String
  22. def displayRelative2(current: ProjectRef, project: Reference): String
  23. def displayRelativeReference(current: ProjectRef, project: Reference): String

    Returns a String expression for the given Reference (BuildRef, ProjectRef, etc) relative to the current project.

  24. def empty(implicit delegates: (Scope) ⇒ Seq[Scope]): Settings[Scope]
    Definition Classes
    Init
  25. def flattenLocals(compiled: CompiledMap): Map[ScopedKey[_], Flattened]
    Definition Classes
    Init
  26. def getValue[T](s: Settings[Scope], k: ScopedKey[T]): T
    Definition Classes
    Init
  27. def grouped(init: Seq[Setting[_]]): ScopedMap
    Definition Classes
    Init
  28. def guessIntendedScope(validKeys: Seq[ScopedKey[_]], delegates: (Scope) ⇒ Seq[Scope], key: ScopedKey[_]): Option[ScopedKey[_]]
    Definition Classes
    Init
  29. def ifS[A](x: Initialize[Task[Boolean]])(t: Initialize[Task[A]])(e: Initialize[Task[A]]): Initialize[Task[A]]
  30. implicit def initOps[T](x: Initialize[T]): InitOps[T]
    Definition Classes
    InitializeImplicits0
  31. implicit def initTaskOps[T](x: Initialize[Task[T]]): InitTaskOps[T]
    Definition Classes
    InitializeImplicits
  32. macro def inputKey[T](description: String): InputKey[T]
  33. macro def inputTask[T](t: T): Initialize[InputTask[T]]
  34. macro def inputTaskDyn[T](t: Initialize[Task[T]]): Initialize[InputTask[T]]
  35. def intersect(s1: Scope, s2: Scope)(implicit delegates: (Scope) ⇒ Seq[Scope]): Option[Scope]

    Intersects two scopes, returning the more specific one if they intersect, or None otherwise.

    Intersects two scopes, returning the more specific one if they intersect, or None otherwise.

    Definition Classes
    DefInit
  36. implicit def macroPrevious[T](in: TaskKey[T]): MacroPrevious[T]
  37. implicit def macroValueI[T](in: Initialize[T]): MacroValue[T]
  38. implicit def macroValueIInT[T](in: Initialize[InputTask[T]]): InputEvaluated[T]
  39. implicit def macroValueIT[T](in: Initialize[Task[T]]): MacroValue[T]
  40. implicit def macroValueIn[T](in: InputTask[T]): InputEvaluated[T]
    Definition Classes
    TaskMacroExtra
  41. implicit def macroValueT[T](in: Task[T]): MacroValue[T]
    Definition Classes
    TaskMacroExtra
  42. def makeWithCompiledMap(init: Seq[Setting[_]])(implicit delegates: (Scope) ⇒ Seq[Scope], scopeLocal: ScopeLocal, display: Show[ScopedKey[_]]): (CompiledMap, Settings[Scope])
    Definition Classes
    Init
  43. def map[S, T](in: Initialize[S])(f: (S) ⇒ T): Initialize[T]
    Definition Classes
    Init
  44. def mapScope(f: (Scope) ⇒ Scope): MapScoped
    Definition Classes
    Init
  45. def optional[T, U](i: Initialize[T])(f: (Option[T]) ⇒ U): Initialize[U]
    Definition Classes
    Init
  46. implicit def parserInitStateToInput[T](p: Initialize[(State) ⇒ Parser[T]]): ParserInput[T]
  47. implicit def parserInitToInput[T](p: Initialize[Parser[T]]): ParserInput[T]
  48. implicit def parserToInput[T](in: Parser[T]): ParserInput[T]
    Definition Classes
    TaskMacroExtra
  49. def promise[A]: PromiseWrap[A]

    Returns PromiseWrap[A], which is a wrapper around scala.concurrent.Promise.

    Returns PromiseWrap[A], which is a wrapper around scala.concurrent.Promise. When a task is typed promise (e.g. Def.Initialize[Task[PromiseWrap[A]]]),an implicit method called await is injected which will run in a thread outside of concurrent restriction budget.

  50. def pure[T](value: () ⇒ T): Initialize[T]
    Definition Classes
    Init
  51. def refinedDistance(delegates: (Scope) ⇒ Seq[Scope], a: ScopedKey[_], b: ScopedKey[_]): Option[Int]
    Definition Classes
    Init
  52. val resolvedScoped: SettingKey[ScopedKey[_]]
  53. val runBefore: AttributeKey[Seq[Task[_]]]
  54. macro def setting[T](t: T): Initialize[T]
  55. def setting[T](key: ScopedKey[T], init: Initialize[T], pos: SourcePosition = NoPosition): Setting[T]
    Definition Classes
    Init
  56. macro def settingDyn[T](t: Initialize[T]): Initialize[T]
  57. macro def settingKey[T](description: String): SettingKey[T]
  58. def settings(ss: SettingsDefinition*): Seq[Setting[_]]
  59. def showBuildRelativeKey2(currentBuild: URI, keyNameColor: Option[String] = None): Show[ScopedKey[_]]
  60. def showFullKey(keyNameColor: Option[String]): Show[ScopedKey[_]]

    The Show instance used when a detailed String needs to be generated.

    The Show instance used when a detailed String needs to be generated. It is typically used when no context is available.

  61. lazy val showFullKey: Show[ScopedKey[_]]

    The Show instance used when a detailed String needs to be generated.

    The Show instance used when a detailed String needs to be generated. It is typically used when no context is available.

    Definition Classes
    DefInit
  62. def showRelativeKey2(current: ProjectRef, keyNameColor: Option[String] = None): Show[ScopedKey[_]]
  63. def showUndefined(u: Undefined, validKeys: Seq[ScopedKey[_]], delegates: (Scope) ⇒ Seq[Scope])(implicit display: Show[ScopedKey[_]]): String
    Definition Classes
    Init
  64. def sort(cMap: CompiledMap): Seq[Compiled[_]]
    Definition Classes
    Init
  65. def spaceDelimited(argLabel: String = "<arg>"): Parser[Seq[String]]

    A default Parser for splitting input into space-separated arguments.

    A default Parser for splitting input into space-separated arguments. argLabel is an optional, fixed label shown for an argument during tab completion.

  66. implicit def stateParserToInput[T](in: (State) ⇒ Parser[T]): ParserInput[T]
    Definition Classes
    TaskMacroExtra
  67. macro def task[T](t: T): Initialize[Task[T]]
  68. macro def taskDyn[T](t: Initialize[Task[T]]): Initialize[Task[T]]
  69. macro def taskIf[T](a: T): Initialize[Task[T]]
  70. macro def taskKey[T](description: String): TaskKey[T]
  71. implicit def taskMacroValueIT[T](in: Initialize[Task[T]]): MacroTaskValue[T]
  72. def toIParser[T](p: Initialize[InputTask[T]]): Initialize[(State) ⇒ Parser[Task[T]]]
  73. def toISParser[T](p: Initialize[Parser[T]]): Initialize[(State) ⇒ Parser[T]]
  74. def toITask[T](i: Initialize[T]): Initialize[Task[T]]

    Lifts the result of a setting initialization into a Task.

  75. def toSParser[T](p: Parser[T]): (State) ⇒ Parser[T]
  76. val triggeredBy: AttributeKey[Seq[Task[_]]]
  77. def uniform[S, T](inputs: Seq[Initialize[S]])(f: (Seq[S]) ⇒ T): Initialize[T]
    Definition Classes
    Init
  78. def unit(a: Any): Unit

    This works around Scala 2.12.12's "a pure expression does nothing in statement position"

    This works around Scala 2.12.12's "a pure expression does nothing in statement position"

    Def.unit(copyResources.value)
    Def.unit(compile.value)
  79. def update[T](key: ScopedKey[T])(f: (T) ⇒ T): Setting[T]
    Definition Classes
    Init
  80. def value[T](value: ⇒ T): Initialize[T]
    Definition Classes
    Init
  81. def valueStrict[T](value: T): Initialize[T]
    Definition Classes
    Init
  82. def withColor(s: String, color: Option[String], useColor: Boolean): String
  83. def withColor(s: String, color: Option[String]): String
  84. object DefaultSetting
    Definition Classes
    Init
  85. object Initialize
    Definition Classes
    Init
  86. object SettingsDefinition
    Definition Classes
    Init

Deprecated Value Members

  1. def displayBuildRelative(currentBuild: URI, multi: Boolean, project: Reference): String
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1.1) Use variant without multi

  2. def displayRelative(current: ProjectRef, multi: Boolean, project: Reference): String
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1.1) Use displayRelative2 which doesn't take the unused multi param

  3. def make(init: Seq[Setting[_]])(implicit delegates: (Scope) ⇒ Seq[Scope], scopeLocal: ScopeLocal, display: Show[ScopedKey[_]]): Settings[Scope]
    Definition Classes
    Init
    Annotations
    @deprecated
    Deprecated

    (Since version 1.4.0) Use makeWithCompiledMap

  4. def showBuildRelativeKey(currentBuild: URI, multi: Boolean, keyNameColor: Option[String] = None): Show[ScopedKey[_]]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1.1) Use showBuildRelativeKey2 which doesn't take the unused multi param

  5. def showRelativeKey(current: ProjectRef, multi: Boolean, keyNameColor: Option[String] = None): Show[ScopedKey[_]]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1.1) Use showRelativeKey2 which doesn't take the unused multi param