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

scala.build

package scala.build

Members list

Packages

package scala.build.bsp
package scala.build.compiler
package scala.build.input
package scala.build.internal
package scala.build.postprocessing
package scala.build.preprocessing

Type members

Classlikes

object Bloop

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Bloop.type
trait BloopBuildClient extends BuildClient

Attributes

Companion
object
Supertypes
trait BuildClient
class Object
trait Matchable
class Any
Known subtypes
class BspClient
object BloopBuildClient

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Cancelled
class Failed
class Successful
object Build

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Build.type
final case class BuildThreads(bloop: BloopThreads, fileWatcher: ScheduledExecutorService)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BuildThreads

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Builds(builds: Seq[Build], crossBuilds: Seq[Seq[Build]], docBuilds: Seq[Build], docCrossBuilds: Seq[Seq[Build]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CollectionOps

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class ConsoleBloopBuildClient(logger: Logger, keepDiagnostics: Boolean, generatedSources: Map[Scope, Seq[GeneratedSource]]) extends BloopBuildClient

Attributes

Companion
object
Supertypes
trait BuildClient
class Object
trait Matchable
class Any
object ConsoleBloopBuildClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final case class CrossKey(optionsKey: Option[CrossKey], scope: Scope)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CrossSources(paths: Seq[WithBuildRequirements[(Path, RelPath)]], inMemory: Seq[WithBuildRequirements[InMemory]], defaultMainElemPath: Option[Path], resourceDirs: Seq[WithBuildRequirements[Path]], buildOptions: Seq[WithBuildRequirements[BuildOptions]], unwrappedScripts: Seq[WithBuildRequirements[UnwrappedScript]])

Information gathered from preprocessing command inputs - sources (including unwrapped scripts) and build options from using directives

Information gathered from preprocessing command inputs - sources (including unwrapped scripts) and build options from using directives

Value parameters

buildOptions

build options from sources

inMemory

in memory sources (e.g. snippets) wrapped in their build requirements

paths

paths and realtive paths to sources on disk, wrapped in their build requirements

unwrappedScripts

in memory script sources, their code must be wrapped before compiling

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CrossSources

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Directories

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class OsLocations
class SubDir
object Directories

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class GeneratedSource(generated: Path, reportingPath: Either[String, Path], wrapperParamsOpt: Option[WrapperParams])

Represents a source that's not originally in the user's workspace, yet it's a part of the project. It can either be synthetically generated by Scala CLI, e.g. BuildInfo or just modified, e.g. script wrappers

Represents a source that's not originally in the user's workspace, yet it's a part of the project. It can either be synthetically generated by Scala CLI, e.g. BuildInfo or just modified, e.g. script wrappers

Value parameters

generated

path to the file created by Scala CLI

reportingPath

the origin of the source:

  • Left(String): there's no path that corresponds to the source it may be a snippet or a gist etc.
  • Right(os.Path): this source has been generated based on a file at this path
wrapperParamsOpt

if the generated source is a script wrapper then the params are present here

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LocalRepo

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
LocalRepo.type
class PersistentDiagnosticLogger(parent: Logger) extends Logger

Used to collect and send diagnostics to the build client when operating as a BSP

Used to collect and send diagnostics to the build client when operating as a BSP

Attributes

Supertypes
trait Logger
class Object
trait Matchable
class Any
final case class Project(workspace: Path, directory: Path, argsFilePath: Path, classesDir: Path, scaladocDir: Path, scalaCompiler: Option[ScalaCompilerParams], scalaJsOptions: Option[JsConfig], scalaNativeOptions: Option[NativeConfig], projectName: String, classPath: Seq[Path], sources: Seq[Path], resolution: Option[Resolution], resourceDirs: Seq[Path], javaHomeOpt: Option[Path], scope: Scope, javacOptions: List[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Project

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Project.type
final case class ReplArtifacts(replArtifacts: Seq[(String, Path)], depArtifacts: Seq[(String, Path)], extraClassPath: Seq[Path], extraSourceJars: Seq[Path], replMainClass: String, replJavaOpts: Seq[String], addSourceJars: Boolean, includeExtraCpOnReplCp: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReplArtifacts

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ScalaCompilerParams(scalaVersion: String, scalaBinaryVersion: String, scalacOptions: Seq[String], compilerClassPath: Seq[Path], bridgeJarsOpt: Option[Seq[Path]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ScopedSources(paths: Seq[HasScope[(Path, RelPath)]], inMemory: Seq[HasScope[InMemory]], defaultMainElemPath: Option[Path], resourceDirs: Seq[HasScope[Path]], buildOptions: Seq[HasScope[BuildOptions]], unwrappedScripts: Seq[HasScope[UnwrappedScript]])

Information gathered from preprocessing command inputs - sources (including unwrapped scripts) and build options from using directives. Only scope requirements remain in this object after resolving them in CrossSources.scopedSources

Information gathered from preprocessing command inputs - sources (including unwrapped scripts) and build options from using directives. Only scope requirements remain in this object after resolving them in CrossSources.scopedSources

Value parameters

buildOptions

build options sources with the scope they belong to

inMemory

in memory sources (e.g. snippets) with the scope they belong to

paths

paths and relative paths to sources on disk with the scope they belong to

unwrappedScripts

in memory script sources with the scope they belong to, their code must be wrapped before compiling

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Sources(paths: Seq[(Path, RelPath)], inMemory: Seq[InMemory], defaultMainClass: Option[String], resourceDirs: Seq[Path], buildOptions: BuildOptions)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Sources

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Sources.type
Generated with