build-module
API
Generated with
build-module/scala.build/Build

Build

scala.build.Build
See theBuild companion trait
object Build

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Build.type

Members list

Type members

Classlikes

final case class Cancelled(inputs: Inputs, options: BuildOptions, scope: Scope, reason: String) extends Build

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Build
class Object
trait Matchable
class Any
Show all
final case class Failed(inputs: Inputs, options: BuildOptions, scope: Scope, sources: Sources, artifacts: Artifacts, project: Project, diagnostics: Option[Seq[(Either[String, Path], Diagnostic)]]) extends Build

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Build
class Object
trait Matchable
class Any
Show all
final case class Successful(inputs: Inputs, options: BuildOptions, scalaParams: Option[ScalaParameters], scope: Scope, sources: Sources, artifacts: Artifacts, project: Project, output: Path, diagnostics: Option[Seq[(Either[String, Path], Diagnostic)]], generatedSources: Seq[GeneratedSource], isPartial: Boolean) extends Build

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Build
class Object
trait Matchable
class Any
Show all
final class Watcher(val watchers: ListBuffer[PathWatcher[Event]], val scheduler: ScheduledExecutorService, onChange: => Unit, onDispose: => Unit)

Attributes

Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def build(inputs: Inputs, options: BuildOptions, compilerMaker: ScalaCompilerMaker, docCompilerMakerOpt: Option[ScalaCompilerMaker], logger: Logger, crossBuilds: Boolean, buildTests: Boolean, partial: Option[Boolean], actionableDiagnostics: Option[Boolean])(using ScalaCliInvokeData): Either[BuildException, Builds]
def buildOnce(inputs: Inputs, sources: Sources, generatedSources: Seq[GeneratedSource], options: BuildOptions, scope: Scope, logger: Logger, buildClient: BloopBuildClient, compiler: ScalaCompiler, partialOpt: Option[Boolean]): Either[BuildException, Build]
def buildProject(inputs: Inputs, sources: Sources, generatedSources: Seq[GeneratedSource], options: BuildOptions, compilerJvmVersionOpt: Option[Positioned[Int]], scope: Scope, logger: Logger, artifacts: Artifacts, maybeRecoverOnError: BuildException => Option[BuildException]): Either[BuildException, Project]

Builds a Bloop project.

Builds a Bloop project.

Value parameters

compilerJvmVersionOpt

compiler JVM version (optional)

generatedSources

sources generated by Scala CLI as part of the build

inputs

inputs to be included in the project

logger

logger

maybeRecoverOnError

a function handling BuildException instances, possibly recovering them; returns None on recovery, Some(e: BuildException) otherwise

options

build options

scope

build scope for which the project is to be created

sources

sources to be included in the project

Attributes

Returns

a bloop Project

def classesDir(root: Path, projectName: String, scope: Scope, suffix: String): Path
def classesRootDir(root: Path, projectName: String): Path
def onChangeBufferedObserver(onEvent: Event => Unit): Observer[Event]
def postProcess(generatedSources: Seq[GeneratedSource], generatedSrcRoot: Path, classesDir: Path, logger: Logger, workspace: Path, updateSemanticDbs: Boolean, scalaVersion: String): Either[Seq[String], Unit]
def prepareBuild(inputs: Inputs, sources: Sources, generatedSources: Seq[GeneratedSource], options: BuildOptions, compilerJvmVersionOpt: Option[Positioned[Int]], scope: Scope, compiler: ScalaCompiler, logger: Logger, buildClient: BloopBuildClient, maybeRecoverOnError: BuildException => Option[BuildException]): Either[BuildException, (Path, Option[ScalaParameters], Artifacts, Project, Boolean)]
def projectRootDir(root: Path, projectName: String): Path
def releaseFlag(options: BuildOptions, compilerJvmVersionOpt: Option[Positioned[Int]], logger: Logger): Option[Int]
def resourcesRegistry(root: Path, projectName: String, scope: Scope): Path
def scalaNativeSupported(options: BuildOptions, inputs: Inputs, logger: Logger): Either[BuildException, Option[ScalaNativeCompatibilityError]]
def updateInputs(inputs: Inputs, options: BuildOptions, testOptions: Option[BuildOptions]): Inputs

If some options are manually overridden, append a hash of the options to the project name Using only the command-line options not the ones from the sources.

If some options are manually overridden, append a hash of the options to the project name Using only the command-line options not the ones from the sources.

Attributes

def validate(logger: Logger, options: BuildOptions): Either[BuildException, Unit]
def watch(inputs: Inputs, options: BuildOptions, compilerMaker: ScalaCompilerMaker, docCompilerMakerOpt: Option[ScalaCompilerMaker], logger: Logger, crossBuilds: Boolean, buildTests: Boolean, partial: Option[Boolean], actionableDiagnostics: Option[Boolean], postAction: () => Unit)(action: Either[BuildException, Builds] => Unit)(using ScalaCliInvokeData): Watcher
Generated with