mill.scalalib

package mill.scalalib

Members list

Type members

Classlikes

case class Assembly(pathRef: PathRef, addedEntries: Int)

Attributes

Companion
object
Source
Assembly.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Assembly

Attributes

Companion
class
Source
Assembly.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Assembly.type
trait AssemblyModule extends Module

Core configuration required to compile a single Java compilation target

Core configuration required to compile a single Java compilation target

Attributes

Source
AssemblyModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
trait BomModule extends JavaModule

A module that consists solely of dependency management

A module that consists solely of dependency management

To be used by other modules via JavaModule#bomModuleDeps

Attributes

Source
JavaModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
case class BoundDep(dep: Dependency, force: Boolean)

Same as Dep but with already bound cross and platform settings.

Same as Dep but with already bound cross and platform settings.

Attributes

Companion
object
Source
Dep.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BoundDep

Attributes

Companion
class
Source
Dep.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BoundDep.type
trait CoursierModule extends Module

This module provides the capability to resolve (transitive) dependencies from (remote) repositories.

This module provides the capability to resolve (transitive) dependencies from (remote) repositories.

It's mainly used in JavaModule, but can also be used stand-alone, in which case you must provide repositories by overriding CoursierModule.repositoriesTask.

Attributes

Companion
object
Source
CoursierModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Companion
trait
Source
CoursierModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait CrossModuleBase extends ScalaModule, Module[String]

Attributes

Source
CrossModuleBase.scala
Supertypes
trait Module[String]
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Source
CrossSbtModule.scala
Supertypes
trait Module[String]
trait SbtModule
trait MavenModule
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

A ScalaModule which is suited to be used with mill.define.Cross. It supports additional source directories with the scala version pattern as suffix (src-{scalaversionprefix}), e.g.

A ScalaModule which is suited to be used with mill.define.Cross. It supports additional source directories with the scala version pattern as suffix (src-{scalaversionprefix}), e.g.

  • src
  • src-2.11
  • src-2.12.3

Attributes

Source
CrossScalaModule.scala
Supertypes
trait Module[String]
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Adds version range specific sources when mixed-in to a cross module like CrossScalaModule or CrossSbtModule. It is useful when a Scala version specific breaking change requires two implementations of the same code for the cross versions before and after a specific version. For example, migrating to Scala 2.13 it is usually needed to define some version specific code for Scala 2.12- (all the versions less or equal 2.12) and for Scala 2.13+ (all the versions greater or equal to 2.13). Mixing CrossScalaVersionRanges into a CrossScalaModule will automatically add the src-2.13+ and src-2.12-, based on the crossScalaVersion.

Adds version range specific sources when mixed-in to a cross module like CrossScalaModule or CrossSbtModule. It is useful when a Scala version specific breaking change requires two implementations of the same code for the cross versions before and after a specific version. For example, migrating to Scala 2.13 it is usually needed to define some version specific code for Scala 2.12- (all the versions less or equal 2.12) and for Scala 2.13+ (all the versions greater or equal to 2.13). Mixing CrossScalaVersionRanges into a CrossScalaModule will automatically add the src-2.13+ and src-2.12-, based on the crossScalaVersion.

Attributes

Source
CrossScalaVersionRanges.scala
Supertypes
trait Module[String]
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
sealed trait CrossVersion

Attributes

Companion
object
Source
Dep.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Binary
class Constant
class Full
object CrossVersion

Attributes

Companion
trait
Source
Dep.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Dep(dep: Dependency, cross: CrossVersion, force: Boolean)

Attributes

Companion
object
Source
Dep.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Dep

Attributes

Companion
class
Source
Dep.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Dep.type
implicit class DepSyntax(ctx: StringContext)

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
object Dependency extends ExternalModule

Attributes

Source
Dependency.scala
Supertypes
class BaseModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type
Dependency.type
object GenIdeaImpl

Attributes

Companion
class
Source
GenIdeaImpl.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait GenIdeaModule extends Module

Module specific configuration of the Idea project file generator.

Module specific configuration of the Idea project file generator.

Attributes

Companion
object
Source
GenIdeaModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
object GenIdeaModule

Attributes

Companion
trait
Source
GenIdeaModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type

Arguments for the ivDepsTree command.

Arguments for the ivDepsTree command.

Value parameters

inverse

Invert the tree representation, so that the root is on the bottom.

whatDependsOn

possible list of modules (org:artifact) to target in the tree in order to see where a dependency stems from.

withCompile

Include the compile-time only dependencies (compileIvyDeps, provided scope) into the tree.

withRuntime

Include the runtime dependencies (runIvyDeps, runtime scope) into the tree.

Attributes

Companion
object
Source
IvyDepsTreeArgs.scala
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
class
Source
IvyDepsTreeArgs.scala
Supertypes
class Object
trait Matchable
class Any
Self type

Core configuration required to compile a single Java compilation target

Core configuration required to compile a single Java compilation target

Attributes

Companion
object
Source
JavaModule.scala
Supertypes
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
object JavaModule

Attributes

Companion
trait
Source
JavaModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type
JavaModule.type
trait JlinkModule extends JavaModule

Support building modular runtime images with the jlink tool, which is included in JDK 9 and later.

Support building modular runtime images with the jlink tool, which is included in JDK 9 and later.

The official jlink docs: https://docs.oracle.com/en/java/javase/23/docs/specs/man/jlink.html

Attributes

Source
JlinkModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
trait JpackageModule extends JavaModule

Support for building a native package / installer with the jpackage tool which comes bundled with JDK 14 and later.

Support for building a native package / installer with the jpackage tool which comes bundled with JDK 14 and later.

The official jpackage docs: https://docs.oracle.com/en/java/javase/23/docs/specs/man/jpackage.html

Attributes

Source
JpackageModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Attributes

Companion
object
Source
JsonFormatters.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion
trait
Source
JsonFormatters.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object Lib

Attributes

Source
Lib.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Lib.type
trait MavenModule extends JavaModule

A JavaModule with a Maven compatible directory layout.

A JavaModule with a Maven compatible directory layout.

Attributes

See also

SbtModule if you need a scala module with Maven layout.

Source
MavenModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type

Provides a task to build a native executable using Graal VM.

Provides a task to build a native executable using Graal VM.

It is recommended to specify a custom JDK that includes the native-image Tool.

trait AppModule extends NativeImageModule {
 def zincWorker = ModuleRef(ZincWorkerGraalvm)

 object ZincWorkerGraalvm extends ZincWorkerModule {
   def jvmId = "graalvm-community:23.0.1"
 }
}

Attributes

Source
NativeImageModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Attributes

Source
PlatformModuleBase.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

A ScalaModule intended for defining .jvm/.js/.native submodules It supports additional source directories per platform, e.g. src-jvm/ or src-js/ and can be used inside a CrossScalaModule.Base, to get one source folder per platform per version e.g. src-2.12-jvm/.

A ScalaModule intended for defining .jvm/.js/.native submodules It supports additional source directories per platform, e.g. src-jvm/ or src-js/ and can be used inside a CrossScalaModule.Base, to get one source folder per platform per version e.g. src-2.12-jvm/.

Adjusts the millSourcePath and artifactNameParts to ignore the last path segment, which is assumed to be the name of the platform the module is built against and not something that should affect the filesystem path or artifact name

Attributes

Source
PlatformScalaModule.scala
Supertypes
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
trait PublishModule extends JavaModule

Configuration necessary for publishing a Scala module to Maven Central or similar

Configuration necessary for publishing a Scala module to Maven Central or similar

Attributes

Companion
object
Source
PublishModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

Attributes

Companion
trait
Source
PublishModule.scala
Supertypes
trait TaskModule
class BaseModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type
trait RunModule extends WithZincWorker

Attributes

Companion
object
Source
RunModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
object RunModule

Attributes

Companion
trait
Source
RunModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type
RunModule.type

A ScalaModule with sbt compatible directory layout.

A ScalaModule with sbt compatible directory layout.

Attributes

Source
SbtModule.scala
Supertypes
trait MavenModule
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Core configuration required to compile a single Scala compilation target

Core configuration required to compile a single Scala compilation target

Attributes

Source
ScalaModule.scala
Supertypes
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type

Attributes

Companion
trait
Source
SemanticDbJavaModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion
object
Source
TestModule.scala
Supertypes
trait TaskModule
trait RunModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
object TestModule

Attributes

Companion
trait
Source
TestModule.scala
Supertypes
class Object
trait Matchable
class Any
Self type
TestModule.type
trait UnidocModule extends ScalaModule

Mix this in to any ScalaModule to provide a unidocSite target that can be used to build a unified scaladoc site for this module and all of its transitive dependencies

Mix this in to any ScalaModule to provide a unidocSite target that can be used to build a unified scaladoc site for this module and all of its transitive dependencies

Attributes

Source
UnidocModule.scala
Supertypes
trait ScalaModule
trait JavaModule
trait RunModule
trait TaskModule
trait BspModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
sealed trait UnresolvedPath

An unresolved path is relative to some unspecified destination which depends on the actual configuration at evaluation time. Hence, you need to call resolve with an instance of mill.eval.EvaluatorPathsResolver to get the final os.Path.

An unresolved path is relative to some unspecified destination which depends on the actual configuration at evaluation time. Hence, you need to call resolve with an instance of mill.eval.EvaluatorPathsResolver to get the final os.Path.

Attributes

Companion
object
Source
UnresolvedPath.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DestPath
class ResolvedPath

Attributes

Companion
trait
Source
UnresolvedPath.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait WithZincWorker extends Module

Common trait for modules that use either a custom or a globally shared ZincWorkerModule.

Common trait for modules that use either a custom or a globally shared ZincWorkerModule.

Attributes

Source
WithZincWorker.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
@Scaladoc(value = "/**\n * A default implementation of [[ZincWorkerModule]]\n */")

A default implementation of ZincWorkerModule

A default implementation of ZincWorkerModule

Attributes

Companion
trait
Source
ZincWorkerModule.scala
Supertypes
class BaseModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

A module managing an in-memory Zinc Scala incremental compiler

A module managing an in-memory Zinc Scala incremental compiler

Attributes

Companion
object
Source
ZincWorkerModule.scala
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Deprecated classlikes

object GenIdea extends ExternalModule

Attributes

Deprecated
true
Source
GenIdea.scala
Supertypes
class BaseModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type
GenIdea.type
case class GenIdeaImpl(evaluator: Evaluator, ctx: Log & Home, rootModule: BaseModule, discover: Discover)

This class is outdated and unmaintained. Please use mill.idea.GenIdeaImpl instead.

This class is outdated and unmaintained. Please use mill.idea.GenIdeaImpl instead.

Attributes

Companion
object
Deprecated
true
Source
GenIdeaImpl.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Implicits

Implicits

final implicit def DepSyntax(ctx: StringContext): DepSyntax

Attributes

Source
package.scala

Inherited implicits

implicit lazy val activationFormat: ReadWriter[Activation]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val activationOsFormat: ReadWriter[Os]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val attrFormat: ReadWriter[Attributes]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val bomDepFormat: ReadWriter[BomDependency]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val classifierFormat: ReadWriter[Classifier]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val configurationFormat: ReadWriter[Configuration]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val depFormat: ReadWriter[Dependency]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val depMgmtKeyFormat: ReadWriter[Key]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val depMgmtValuesFormat: ReadWriter[Values]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val exclusionDataFormat: ReadWriter[ExclusionData]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val extensionFormat: ReadWriter[Extension]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val infoDeveloperFormat: ReadWriter[Developer]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val infoFormat: ReadWriter[Info]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val infoLicenseFormat: ReadWriter[License]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val infoScmFormat: ReadWriter[Scm]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val minimizedExclusionsFormat: ReadWriter[MinimizedExclusions]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val modFormat: ReadWriter[Module]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val modNameFormat: ReadWriter[ModuleName]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val orgFormat: ReadWriter[Organization]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val overridesFormat: ReadWriter[Overrides]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val profileFormat: ReadWriter[Profile]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val projectFormat: ReadWriter[Project]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val publicationFormat: ReadWriter[Publication]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val snapshotVersionFormat: ReadWriter[SnapshotVersion]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val snapshotVersioningFormat: ReadWriter[SnapshotVersioning]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val typeFormat: ReadWriter[Type]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val versionFormat: ReadWriter[Version]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val versionInternalFormat: ReadWriter[VersionInterval]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val versionsDateTimeFormat: ReadWriter[DateTime]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala
implicit lazy val versionsFormat: ReadWriter[Versions]

Attributes

Inherited from:
JsonFormatters
Source
JsonFormatters.scala