options
API
Generated with
options/scala.build/scala.build.options

scala.build.options

package scala.build.options

Members list

Packages

package scala.build.options.packaging
package scala.build.options.publish
package scala.build.options.scalajs
package scala.build.options.validation

Type members

Classlikes

final case class BuildOptions(suppressWarningOptions: SuppressWarningOptions, scalaOptions: ScalaOptions, scalaJsOptions: ScalaJsOptions, scalaNativeOptions: ScalaNativeOptions, internalDependencies: InternalDependenciesOptions, javaOptions: JavaOptions, jmhOptions: JmhOptions, classPathOptions: ClassPathOptions, scriptOptions: ScriptOptions, internal: InternalOptions, mainClass: Option[String], testOptions: TestOptions, notForBloopOptions: PostBuildOptions, sourceGeneratorOptions: SourceGeneratorOptions, useBuildServer: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class BuildRequirements(scalaVersion: Seq[VersionRequirement], platform: Seq[PlatformRequirement], scope: Option[ScopeRequirement])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ClassPathOptions(extraRepositories: Seq[String], extraClassPath: Seq[Path], extraCompileOnlyJars: Seq[Path], extraSourceJars: Seq[Path], fetchSources: Option[Boolean], extraDependencies: ShadowingSeq[Positioned[AnyDependency]], extraCompileOnlyDependencies: ShadowingSeq[Positioned[AnyDependency]], resourcesDir: Seq[Path], resourcesVirtualDir: Seq[SubPath], scalafixDependencies: ShadowingSeq[Positioned[AnyDependency]])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class ComputeVersion extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class GitTag
object ComputeVersion

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ConfigMonoid[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConfigMonoidImpl[T]
object ConfigMonoid

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class ConfigMonoidImpl[T](zero: T)(orElseFun: (T, T) => T) extends ConfigMonoid[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConfigMonoid[T]
class Object
trait Matchable
class Any
Show all
trait HasHashData[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object HasHashData

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class HasScope[+T](scope: Scope, value: T)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait HashedType[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object HashedType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
HashedType.type
final case class InternalDependenciesOptions(addTestRunnerDependencyOpt: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InternalOptions(keepDiagnostics: Boolean, cache: Option[FileCache[Task]], localRepository: Option[String], verbosity: Option[Int], strictBloopJsonCheck: Option[Boolean], interactive: Option[() => Either[BuildException, Interactive]], javaClassNameVersionOpt: Option[String], keepResolution: Boolean, extraSourceFiles: Seq[Positioned[Path]], exclude: Seq[Positioned[String]], offline: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JavaOpt(value: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
JavaOpt.type
final case class JavaOptions(javaHomeOpt: Option[Positioned[Path]], jvmIdOpt: Option[Positioned[String]], jvmIndexOpt: Option[String], jvmIndexOs: Option[String], jvmIndexArch: Option[String], javaOpts: ShadowingSeq[Positioned[JavaOpt]], javacPluginDependencies: Seq[Positioned[AnyDependency]], javacPlugins: Seq[Positioned[Path]], javacOptions: Seq[Positioned[String]])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JmhOptions(jmhVersion: Option[String], enableJmh: Option[Boolean], runJmh: Option[Boolean])

Value parameters

enableJmh

toggle for enabling JMH dependency handling in the build (overrides runJmh when disabled)

jmhVersion

the version of JMH to be used in the build

runJmh

toggle for whether JMH should actually be runnable from this build (this value gets changed in JMH builds to detect which main class is to be called as benchmarks are being run)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
JmhOptions.type
final case class MaybeScalaVersion(versionOpt: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PackageOptions(standalone: Option[Boolean], version: Option[String], launcherApp: Option[String], maintainer: Option[String], description: Option[String], output: Option[String], packageTypeOpt: Option[PackageType], logoPath: Option[Path], macOSidentifier: Option[String], debianOptions: DebianOptions, windowsOptions: WindowsOptions, redHatOptions: RedHatOptions, dockerOptions: DockerOptions, nativeImageOptions: NativeImageOptions, useDefaultScaladocOptions: Option[Boolean], provided: Seq[AnyModule])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class PackageType extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Assembly
object Bootstrap
object DocJar
object Docker
object Js
object LibraryJar
trait Native
object Application
object LibraryStatic
object Debian
object Dmg
object Msi
object Pkg
object Rpm
object SourceJar
object Spark
Show all
object PackageType

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class Platform(val repr: String) extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object JS
object JVM
object Native
object Platform

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Platform.type
final case class PostBuildOptions(packageOptions: PackageOptions, replOptions: ReplOptions, publishOptions: PublishOptions, scalaJsLinkerOptions: ScalaJsLinkerOptions, runWithManifest: Option[Boolean], pythonSetup: Option[Boolean], python: Option[Boolean], scalaPyVersion: Option[String], addRunnerDependencyOpt: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PublishContextualOptions(repository: Option[String], repositoryIsIvy2LocalLike: Option[Boolean], sourceJar: Option[Boolean], docJar: Option[Boolean], gpgSignatureId: Option[String], gpgOptions: List[String], signer: Option[Signer], secretKey: Option[ConfigPasswordOption], secretKeyPassword: Option[ConfigPasswordOption], publicKey: Option[ConfigPasswordOption], repoUser: Option[PasswordOption], repoPassword: Option[PasswordOption], repoRealm: Option[String], computeVersion: Option[ComputeVersion], checksums: Option[Seq[String]], connectionTimeoutRetries: Option[Int], connectionTimeoutSeconds: Option[Int], responseTimeoutSeconds: Option[Int], stagingRepoRetries: Option[Int], stagingRepoWaitTimeMilis: Option[Int])

Publishing-related options, that can have different values locally and on CIs

Publishing-related options, that can have different values locally and on CIs

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PublishOptions(organization: Option[Positioned[String]], name: Option[Positioned[String]], moduleName: Option[Positioned[String]], version: Option[Positioned[String]], url: Option[Positioned[String]], license: Option[Positioned[License]], versionControl: Option[Vcs], description: Option[String], developers: Seq[Developer], scalaVersionSuffix: Option[String], scalaPlatformSuffix: Option[String], local: PublishContextualOptions, ci: PublishContextualOptions, signingCli: ScalaSigningCliOptions)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ReplOptions(useAmmoniteOpt: Option[Boolean], ammoniteVersionOpt: Option[String], ammoniteArgs: Seq[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SNNumeralVersion(major: Int, minor: Int, patch: Int)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ScalaJsMode(nameOpt: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ScalaJsOptions(version: Option[String], mode: ScalaJsMode, moduleKindStr: Option[String], checkIr: Option[Boolean], emitSourceMaps: Boolean, sourceMapsDest: Option[Path], remapEsModuleImportMap: Option[Path], dom: Option[Boolean], header: Option[String], allowBigIntsForLongs: Option[Boolean], avoidClasses: Option[Boolean], avoidLetsAndConsts: Option[Boolean], moduleSplitStyleStr: Option[String], smallModuleForPackage: List[String], esVersionStr: Option[String], noOpt: Option[Boolean], jsEmitWasm: Boolean)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ScalaNativeOptions(version: Option[String], modeStr: Option[String], ltoStr: Option[String], gcStr: Option[String], clang: Option[String], clangpp: Option[String], linkingOptions: List[String], linkingDefaults: Option[Boolean], compileOptions: List[String], compileDefaults: Option[Boolean], embedResources: Option[Boolean], buildTargetStr: Option[String], multithreading: Option[Boolean], maxDefaultNativeVersions: List[(String, String)])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ScalaNativeTarget

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ScalaOptions(scalaVersion: Option[MaybeScalaVersion], scalaBinaryVersion: Option[String], addScalaLibrary: Option[Boolean], addScalaCompiler: Option[Boolean], semanticDbOptions: SemanticDbOptions, scalacOptions: ShadowingSeq[Positioned[ScalacOpt]], extraScalaVersions: Set[String], compilerPlugins: Seq[Positioned[AnyDependency]], platform: Option[Positioned[Platform]], extraPlatforms: Map[Platform, Positioned[Unit]], defaultScalaVersion: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ScalaSigningCliOptions(javaArgs: Seq[String], forceExternal: Option[Boolean], forceJvm: Option[Boolean], signingCliVersion: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ScalaVersionUtil

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class ScalacOpt(value: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ScalacOpt.type
sealed abstract class Scope(val name: String, index: Int) extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Main
object Test
object Scope

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Scope.type
final case class ScriptOptions(forceObjectWrapper: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SemanticDbOptions(generateSemanticDbs: Option[Boolean], semanticDbTargetRoot: Option[Path], semanticDbSourceRoot: Option[Path])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ShadowingSeq[T]

Seq ensuring some of its values are unique according to some key

Seq ensuring some of its values are unique according to some key

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SourceGeneratorOptions(useBuildInfo: Option[Boolean], projectVersion: Option[String], computeVersion: Option[ComputeVersion])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SuppressWarningOptions(suppressDirectivesInMultipleFilesWarning: Option[Boolean], suppressOutdatedDependencyWarning: Option[Boolean], suppressExperimentalFeatureWarning: Option[Boolean], suppressDeprecatedFeatureWarning: Option[Boolean])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TestOptions(frameworkOpt: Option[String], testOnly: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class WithBuildRequirements[+T](requirements: BuildRequirements, value: T)

Attributes

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

Attributes

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