This is an index of common methods, types, and values you might find in an sbt build definition. For command names, see Running. For available plugins, see the plugins list.
Optionalare predefined configurations.
See the Getting Started Guide for details.
++=These construct a Setting, which is the fundamental type in the settings system.
valueThis uses the value of another setting or task in the definition of a new setting or task. This method is special (it is a macro) and cannot be used except in the argument of one of the setting definition methods above (:=, …) or in the standalone construction methods Def.setting and Def.task. See Task-Graph for details.
inspecifies the Scope or part of the Scope of a setting being referenced. See scopes.
See RichFile, PathFinder, and Paths for the full documentation.
/When called on a single File, this is
new File(x,y). For Seq[File], this is applied for each member of the sequence..
**are methods for selecting children (
*) or descendants (
**) of a File or Seq[File] that match a filter.
--are methods for combining filters, which are often used for selecting Files. See NameFilter and FileFilter. Note that methods with these names also exist for other types, such as collections (like Seq) and Parser (see Parsing Input).
pairUsed to construct mappings from a
Fileor to a String. See Mapping Files.
getforces a PathFinder (a call-by-name data structure) to a strict
Seq[File]representation. This is a common name in Scala, used by types like Option.
See Library Management for full documentation.
%This is used to build up a ModuleID.
%%This is similar to
%except that it identifies a dependency that has been cross built.
fromUsed to specify the fallback URL for a dependency
classifierUsed to specify the classifier for a dependency.
atUsed to define a Maven-style resolver.
intransitiveMarks a dependency or Configuration as being intransitive.
hideMarks a Configuration as internal and not to be included in the published metadata.
These methods are used to build up Parsers from smaller Parsers. They closely follow the names of the standard library’s parser combinators. See Parsing Input for the full documentation. These are used for Input Tasks and Commands.
?Methods for making a Parser optional.
idUsed for turning a Char or String literal into a Parser. It is generally used to trigger an implicit conversion to a Parser.
||Choice methods. These are common method names in Scala.
^^^Produces a constant value when a Parser matches.
*Postfix repetition methods. These are common method names in Scala.
flatMapTransforms the result of a Parser. These are common method names in Scala.
filterRestricts the inputs that a Parser matches on. This is a common method name in Scala.
-Prefix negation. Only matches the input when the original parser doesn’t match the input.
!!!Provides an error message to use when the original parser doesn’t match the input.