mill-contrib-scoverage
API
Generated with
mill-contrib-scoverage/mill.contrib.scoverage/ScoverageReport

ScoverageReport

mill.contrib.scoverage.ScoverageReport
@Scaladoc(value = "/**\n * Allows the aggregation of coverage reports across multi-module projects.\n *\n * Once tests have been run across all modules, this collects reports from\n * all modules that extend [[mill.contrib.scoverage.ScoverageModule]]. Simply\n * define a module that extends [[mill.contrib.scoverage.ScoverageReport]] and\n * call one of the available \"report all\" functions.\n *\n * For example, define the following `scoverage` module and use the relevant\n * reporting option to generate a report:\n * {{{\n * object scoverage extends ScoverageReport {\n * override def scalaVersion = \" \"\n * override def scoverageVersion = \" \"\n * }\n * }}}\n *\n * - mill __.test # run tests for all modules\n * - mill scoverage.htmlReportAll # generates report in html format for all modules\n * - mill scoverage.xmlReportAll # generates report in xml format for all modules\n * - mill scoverage.xmlCoberturaReportAll # generates report in Cobertura\'s xml format for all modules\n * - mill scoverage.consoleReportAll # reports to the console for all modules\n *\n * The aggregated report will be available at either `out/scoverage/htmlReportAll.dest/`\n * for html reports or `out/scoverage/xmlReportAll.dest/` for xml reports.\n */")
trait ScoverageReport extends Module

Allows the aggregation of coverage reports across multi-module projects.

Once tests have been run across all modules, this collects reports from all modules that extend mill.contrib.scoverage.ScoverageModule. Simply define a module that extends mill.contrib.scoverage.ScoverageReport and call one of the available "report all" functions.

For example, define the following scoverage module and use the relevant reporting option to generate a report:

object scoverage extends ScoverageReport {
 override def scalaVersion     = "<scala-version>"
 override def scoverageVersion = "<scoverage-version>"
}
  • mill __.test # run tests for all modules
  • mill scoverage.htmlReportAll # generates report in html format for all modules
  • mill scoverage.xmlReportAll # generates report in xml format for all modules
  • mill scoverage.xmlCoberturaReportAll # generates report in Cobertura's xml format for all modules
  • mill scoverage.consoleReportAll # reports to the console for all modules

The aggregated report will be available at either out/scoverage/htmlReportAll.dest/ for html reports or out/scoverage/xmlReportAll.dest/ for xml reports.

Attributes

Graph
Supertypes
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

@Scaladoc(value = "/** We use this only to get access to the right classpaths */")
object workerModule extends ScoverageModule

We use this only to get access to the right classpaths

We use this only to get access to the right classpaths

Attributes

Supertypes
trait ScalaModule
trait ScalaModuleApi
trait ScalaModuleBase
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait GenIdeaModule
trait GenIdeaModuleApi
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorkerModule
trait JavaHomeModule
trait CoursierModule
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

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
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Abstract methods

def scalaVersion: Simple[String]
def scoverageVersion: Simple[String]

Concrete methods

@Scaladoc(value = "/** Reports to the console for all modules */")
def consoleReportAll(evaluator: Evaluator, sources: String, dataTasks: String): Command[PathRef]

Reports to the console for all modules

Reports to the console for all modules

Attributes

@Scaladoc(value = "/** Generates report in html format for all modules */")
def htmlReportAll(evaluator: Evaluator, sources: String, dataTasks: String): Command[PathRef]

Generates report in html format for all modules

Generates report in html format for all modules

Attributes

def reportTask(evaluator: Evaluator, reportType: ReportType, sources: String, dataTaskStrings: String): Task[PathRef]
@Scaladoc(value = "/** Generates report in Cobertura\'s xml format for all modules */")
def xmlCoberturaReportAll(evaluator: Evaluator, sources: String, dataTasks: String): Command[PathRef]

Generates report in Cobertura's xml format for all modules

Generates report in Cobertura's xml format for all modules

Attributes

@Scaladoc(value = "/** Generates report in xml format for all modules */")
def xmlReportAll(evaluator: Evaluator, sources: String, dataTasks: String): Command[PathRef]

Generates report in xml format for all modules

Generates report in xml format for all modules

Attributes

Inherited methods

def moduleCtx: ModuleCtx

Attributes

Inherited from:
BaseClass
def moduleDir: Path

Attributes

Inherited from:
Module
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
def moduleSegments: Segments

Attributes

Inherited from:
Module
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
Generated with