Mill
API
Generated with
Mill/mill/mill.kotlinlib/mill.kotlinlib.kover/KoverModule/kover

kover

mill.kotlinlib.kover.KoverModule.kover
object kover extends Module, KoverReportBaseModule

Attributes

Source
KoverModule.scala
Graph
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type
kover.type

Members list

Type members

Inherited classlikes

@Scaladoc(value = "/**\n * Miscellaneous machinery around traversing & querying the build hierarchy,\n * that should not be needed by normal users of Mill\n */")
object moduleInternal extends Internal

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Attributes

Inherited from:
Module
Source
Module.scala
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

def htmlReport(): Command[PathRef]

Attributes

Source
KoverModule.scala
def xmlReport(): Command[PathRef]

Attributes

Source
KoverModule.scala

Inherited methods

@Scaladoc(value = "/**\n * Bind a dependency ([[Dep]]) to the actual module context (e.g. the scala version and the platform suffix)\n * @return The [[BoundDep]]\n */")
def bindDependency: Task[Dep => BoundDep]

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Attributes

Returns

The BoundDep

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Customize the coursier file cache.\n *\n * This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin.\n * Doing so requires adding to coursier\'s classpath. To do this you could use the following:\n * {{{\n * override def coursierCacheCustomizer = Task.Anon {\n * Some( (fc: coursier.cache.FileCache[Task]) =>\n * fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))\n * )\n * }\n * }}}\n * @return\n */")
def coursierCacheCustomizer: Task[Option[FileCache[Task] => FileCache[Task]]]

Customize the coursier file cache.

Customize the coursier file cache.

This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin. Doing so requires adding to coursier's classpath. To do this you could use the following:

 override def coursierCacheCustomizer = Task.Anon {
    Some( (fc: coursier.cache.FileCache[Task]) =>
      fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))
    )
 }

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
def defaultResolver: Task[Resolver]

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Mill internal repositories to be used during dependency resolution\n *\n * These are not meant to be modified by Mill users, unless you really know what you\'re\n * doing.\n */")
def internalRepositories: Task[Seq[Repository]]

Mill internal repositories to be used during dependency resolution

Mill internal repositories to be used during dependency resolution

These are not meant to be modified by Mill users, unless you really know what you're doing.

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Classpath for running Kover.\n */")
def koverCliClasspath: Target[Seq[PathRef]]

Classpath for running Kover.

Classpath for running Kover.

Attributes

Inherited from:
KoverReportBaseModule
Source
KoverReportBaseModule.scala
def koverCliDep: Target[Seq[Dep]]

Attributes

Inherited from:
KoverReportBaseModule
Source
KoverReportBaseModule.scala
@Scaladoc(value = "/**\n * Reads the Kover version from system environment variable `KOVER_VERSION` or defaults to a hardcoded version.\n */")
def koverVersion: Target[String]

Reads the Kover version from system environment variable KOVER_VERSION or defaults to a hardcoded version.

Reads the Kover version from system environment variable KOVER_VERSION or defaults to a hardcoded version.

Attributes

Inherited from:
KoverReportBaseModule
Source
KoverReportBaseModule.scala
@Scaladoc(value = "/**\n * Map dependencies before resolving them.\n * Override this to customize the set of dependencies.\n */")
def mapDependencies: Task[Dependency => Dependency]

Map dependencies before resolving them. Override this to customize the set of dependencies.

Map dependencies before resolving them. Override this to customize the set of dependencies.

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
def moduleCtx: Ctx

Attributes

Inherited from:
BaseClass
Source
Module.scala
def moduleDir: Path

Attributes

Inherited from:
Module
Source
Module.scala
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
Source
Module.scala
def moduleSegments: Segments

Attributes

Inherited from:
Module
Source
Module.scala
@Scaladoc(value = "/**\n * The repositories used to resolved dependencies with [[resolveDeps()]].\n */")
def repositoriesTask: Task[Seq[Repository]]

The repositories used to resolved dependencies with resolveDeps.

The repositories used to resolved dependencies with resolveDeps.

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Customize the coursier resolution process.\n * This is rarely needed to changed, as the default try to provide a\n * highly reproducible resolution process. But sometime, you need\n * more control, e.g. you want to add some OS or JDK specific resolution properties\n * which are sometimes used by Maven and therefore found in dependency artifact metadata.\n * For example, the JavaFX artifacts are known to use OS specific properties.\n * To fix resolution for JavaFX, you could override this task like the following:\n * {{{\n * override def resolutionCustomizer = Task.Anon {\n * Some( (r: coursier.core.Resolution) =>\n * r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))\n * )\n * }\n * }}}\n * @return\n */")
def resolutionCustomizer: Task[Option[Resolution => Resolution]]

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

   override def resolutionCustomizer = Task.Anon {
     Some( (r: coursier.core.Resolution) =>
       r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))
     )
   }

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Resolution parameters, allowing to customize resolution internals\n *\n * This rarely needs to be changed. This allows to disable the new way coursier handles\n * BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:\n * {{{\n * def resolutionParams = super.resolutionParams()\n * .withEnableDependencyOverrides(Some(false))\n * }}}\n *\n * Note that versions forced with `Dep#forceVersion()` take over forced versions manually\n * set in `resolutionParams`. The former should be favored to force versions in dependency\n * resolution.\n *\n * The Scala version set via `ScalaModule#scalaVersion` also takes over any Scala version\n * provided via `ResolutionParams#scalaVersionOpt`.\n *\n * The default configuration set in `ResolutionParams#defaultConfiguration` is ignored when\n * Mill fetches dependencies to be passed to the compiler (equivalent to Maven \"compile scope\").\n * In that case, it forces the default configuration to be \"compile\". On the other hand, when\n * fetching dependencies for runtime (equivalent to Maven \"runtime scope\"), the value in\n * `ResolutionParams#defaultConfiguration` is used.\n */")
def resolutionParams: Task[ResolutionParams]

Resolution parameters, allowing to customize resolution internals

Resolution parameters, allowing to customize resolution internals

This rarely needs to be changed. This allows to disable the new way coursier handles BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:

 def resolutionParams = super.resolutionParams()
   .withEnableDependencyOverrides(Some(false))

Note that versions forced with Dep#forceVersion() take over forced versions manually set in resolutionParams. The former should be favored to force versions in dependency resolution.

The Scala version set via ScalaModule#scalaVersion also takes over any Scala version provided via ResolutionParams#scalaVersionOpt.

The default configuration set in ResolutionParams#defaultConfiguration is ignored when Mill fetches dependencies to be passed to the compiler (equivalent to Maven "compile scope"). In that case, it forces the default configuration to be "compile". On the other hand, when fetching dependencies for runtime (equivalent to Maven "runtime scope"), the value in ResolutionParams#defaultConfiguration is used.

Attributes

Inherited from:
CoursierModule
Source
CoursierModule.scala
@Scaladoc(value = "/**\n * Task that resolves the given dependencies using the repositories defined with [[repositoriesTask]].\n *\n * @param deps The dependencies to resolve.\n * @param sources If `true`, resolve source dependencies instead of binary dependencies (JARs).\n * @param artifactTypes If non-empty, pull the passed artifact types rather than the default ones from coursier\n * @return The [[PathRef]]s to the resolved files.\n */")
def resolveDeps(deps: Task[Seq[BoundDep]], sources: Boolean, artifactTypes: Option[Set[Type]]): Task[Seq[PathRef]]

Task that resolves the given dependencies using the repositories defined with repositoriesTask.

Task that resolves the given dependencies using the repositories defined with repositoriesTask.

Value parameters

artifactTypes

If non-empty, pull the passed artifact types rather than the default ones from coursier

deps

The dependencies to resolve.

sources

If true, resolve source dependencies instead of binary dependencies (JARs).

Attributes

Returns

The PathRefs to the resolved files.

Inherited from:
CoursierModule
Source
CoursierModule.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Module -> Any
Inherited from:
Module
Source
Module.scala

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Source
Module.scala
Generated with