Packages

  • package root
    Definition Classes
    root
  • package mill
    Definition Classes
    root
  • package contrib
    Definition Classes
    mill
  • package scoverage
    Definition Classes
    contrib
  • trait ScoverageModule extends Module with ScalaModule

    Adds targets to a mill.scalalib.ScalaModule to create test coverage reports.

    Adds targets to a mill.scalalib.ScalaModule to create test coverage reports.

    This module allows you to generate code coverage reports for Scala projects with Scoverage via the scoverage compiler plugin.

    To declare a module for which you want to generate coverage reports you can Extends the mill.contrib.scoverage.ScoverageModule trait when defining your Module. Additionally, you must define a submodule that extends the ScoverageTests trait that belongs to your instance of ScoverageModule.

    // You have to replace VERSION
    import $ivy.`com.lihaoyi::mill-contrib-buildinfo:VERSION`
    import mill.contrib.scoverage.ScoverageModule
    
    Object foo extends ScoverageModule  {
      def scalaVersion = "2.12.9"
      def scoverageVersion = "1.4.0"
    
      object test extends ScoverageTests {
        def ivyDeps = Agg(ivy"org.scalatest::scalatest:3.0.5")
        def testFrameworks = Seq("org.scalatest.tools.Framework")
      }
    }

    In addition to the normal tasks available to your Scala module, Scoverage Modules introduce a few new tasks and changes the behavior of an existing one.

    - mill foo.scoverage.compile # compiles your module with test instrumentation # (you don't have to run this manually, running the test task will force its invocation)

    - mill foo.test # tests your project and collects metrics on code coverage - mill foo.scoverage.htmlReport # uses the metrics collected by a previous test run to generate a coverage report in html format - mill foo.scoverage.xmlReport # uses the metrics collected by a previous test run to generate a coverage report in xml format

    The measurement data by default is available at out/foo/scoverage/dataDir/dest/, the html report is saved in out/foo/scoverage/htmlReport/dest/, and the xml report is saved in out/foo/scoverage/xmlReport/dest/.

    Definition Classes
    scoverage
  • ScoverageTests
  • Tests
  • millInternal
  • scoverage

object scoverage extends Module with ScalaModule

Linear Supertypes
ScalaModule, JavaModule, CoursierModule, GenIdeaModule, TaskModule, define.Module, Cacher, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. scoverage
  2. ScalaModule
  3. JavaModule
  4. CoursierModule
  5. GenIdeaModule
  6. TaskModule
  7. Module
  8. Cacher
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Tests extends Module with TestModule with ScalaModule
    Definition Classes
    ScalaModule

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def allSourceFiles: Target[Seq[api.PathRef]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  5. def allSources: Target[Seq[eval.PathRef]]
    Definition Classes
    scoverage → JavaModule
  6. def ammoniteReplClasspath: Target[Seq[eval.PathRef]]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  7. def ammoniteVersion: Target[String]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  8. def artifactId: T[String]
    Definition Classes
    ScalaModule → JavaModule
  9. def artifactName: T[String]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  10. def artifactScalaVersion: T[String]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  11. def artifactSuffix: T[String]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def assembly: Target[eval.PathRef]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  14. def assemblyRules: Seq[Rule]
    Definition Classes
    JavaModule
  15. def cachedTarget[T](t: ⇒ T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  17. def compile: T[CompilationResult]
    Definition Classes
    ScalaModule → JavaModule
  18. def compileClasspath: Target[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    ScalaModule → JavaModule
  19. def compileIvyDeps: Target[api.Loose.Agg[Dep]]
    Definition Classes
    scoverage → JavaModule
  20. def console(): Command[Unit]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  21. def crossFullScalaVersion: T[Boolean]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  22. def dataDir: Persistent[eval.PathRef]

    The persistent data dir used to store scoverage coverage data.

    The persistent data dir used to store scoverage coverage data. Use to store coverage data at compile-time and by the various report targets.

  23. def defaultCommandName(): String
    Definition Classes
    JavaModule → TaskModule
  24. def docJar: Target[eval.PathRef]
    Definition Classes
    ScalaModule → JavaModule
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def finalMainClass: T[String]
    Definition Classes
    JavaModule
  28. def finalMainClassOpt: T[Either[String, String]]
    Definition Classes
    JavaModule
  29. def forkArgs: Target[Seq[String]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  30. def forkEnv: Target[Map[String, String]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  31. def forkWorkingDir: Target[Path]
    Definition Classes
    JavaModule
  32. def generatedSources: Target[Seq[eval.PathRef]]
    Definition Classes
    scoverage → JavaModule
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def htmlReport(): Command[Unit]
  36. def ideaCompileOutput: T[PathRef]
    Definition Classes
    GenIdeaModule
  37. def ideaConfigFiles(ideaConfigVersion: Int): Command[Seq[IdeaConfigFile]]
    Definition Classes
    GenIdeaModule
    Annotations
    @Scaladoc()
  38. def ideaJavaModuleFacets(ideaConfigVersion: Int): Command[Seq[JavaFacet]]
    Definition Classes
    GenIdeaModule
    Annotations
    @Scaladoc()
  39. def intellijModulePath: Path
    Definition Classes
    GenIdeaModule
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def ivyDeps: Target[api.Loose.Agg[Dep]]
    Definition Classes
    scoverage → JavaModule
  42. def ivyDepsTree(inverse: Boolean): Command[Unit]
    Definition Classes
    JavaModule
  43. def jar: Target[eval.PathRef]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  44. def javacOptions: Target[Seq[String]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  45. def javadocOptions: T[Seq[String]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  46. def launcher: Target[api.PathRef]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  47. def localClasspath: Target[Seq[eval.PathRef]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  48. def mainClass: T[Option[String]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  49. def manifest: T[JarManifest]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  50. def mapDependencies: Task[(Dependency) ⇒ Dependency]
    Definition Classes
    ScalaModule → CoursierModule
  51. implicit def millModuleBasePath: BasePath
    Definition Classes
    Module
  52. lazy val millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  53. implicit def millModuleExternal: External
    Definition Classes
    Module
  54. implicit def millModuleSegments: Segments
    Definition Classes
    Module
  55. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  56. def millOuterCtx: Ctx
    Definition Classes
    Module
  57. def millSourcePath: Path
    Definition Classes
    Module
  58. def moduleDeps: Seq[JavaModule]
    Definition Classes
    scoverage → JavaModule
  59. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. def platformSuffix: T[String]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  63. def prependShellScript: T[String]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  64. def recursiveModuleDeps: Seq[JavaModule]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  65. def repl(replOptions: String*): Command[Unit]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  66. def repositories: Seq[Repository]
    Definition Classes
    scoverage → JavaModule → CoursierModule
  67. def resolveCoursierDependency: Task[(Dep) ⇒ Dependency]
    Definition Classes
    ScalaModule → CoursierModule
  68. def resolveDeps(deps: Task[Agg[Dep]], sources: Boolean): Task[Agg[eval.PathRef]]
    Definition Classes
    CoursierModule
    Annotations
    @Scaladoc()
  69. def resolvePublishDependency: Task[(Dep) ⇒ Dependency]
    Definition Classes
    ScalaModule → JavaModule
  70. def resources: Sources
    Definition Classes
    scoverage → JavaModule
  71. def run(args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  72. def runBackground(args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  73. def runClasspath: Target[Seq[eval.PathRef]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  74. def runIvyDeps: Target[api.Loose.Agg[Dep]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  75. def runLocal(args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  76. def runMain(mainClass: String, args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  77. def runMainBackground(mainClass: String, args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  78. def runMainLocal(mainClass: String, args: String*): Command[Unit]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  79. def scalaCompilerClasspath: T[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  80. def scalaDocOptions: Target[Seq[String]]
    Definition Classes
    ScalaModule
  81. def scalaDocPluginClasspath: T[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  82. def scalaDocPluginIvyDeps: Target[api.Loose.Agg[Dep]]
    Definition Classes
    ScalaModule
  83. def scalaLibraryIvyDeps: Target[api.Loose.Agg[Dep]]
    Definition Classes
    ScalaModule
  84. def scalaOrganization: T[String]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  85. def scalaVersion: Target[String]
    Definition Classes
    scoverage → ScalaModule
  86. def scalacOptions: Target[Seq[String]]

    Add the scoverage specific plugin settings (dataDir).

    Add the scoverage specific plugin settings (dataDir).

    Definition Classes
    scoverage → ScalaModule
  87. def scalacPluginClasspath: T[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    ScalaModule
    Annotations
    @Scaladoc()
  88. def scalacPluginIvyDeps: Target[api.Loose.Agg[Dep]]

    Add the scoverage scalac plugin.

    Add the scoverage scalac plugin.

    Definition Classes
    scoverage → ScalaModule
  89. def skipIdea: Boolean
    Definition Classes
    GenIdeaModule
    Annotations
    @Scaladoc()
  90. def sourceJar: Target[eval.PathRef]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  91. def sources: Sources
    Definition Classes
    scoverage → JavaModule
  92. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  93. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  94. def transitiveIvyDeps: T[api.Loose.Agg[Dep]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  95. def transitiveLocalClasspath: T[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  96. def transitiveModuleDeps: Seq[JavaModule]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  97. def unmanagedClasspath: Target[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  98. def upstreamAssembly: Target[eval.PathRef]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  99. def upstreamAssemblyClasspath: Target[api.Loose.Agg[eval.PathRef]]
    Definition Classes
    ScalaModule → JavaModule
  100. def upstreamCompileOutput: Target[Seq[CompilationResult]]
    Definition Classes
    JavaModule
    Annotations
    @Scaladoc()
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  104. def xmlReport(): Command[Unit]
  105. def zincWorker: ZincWorkerModule
    Definition Classes
    JavaModule
  106. object millInternal extends Internal
    Definition Classes
    Module
    Annotations
    @Scaladoc()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from ScalaModule

Inherited from JavaModule

Inherited from CoursierModule

Inherited from GenIdeaModule

Inherited from TaskModule

Inherited from define.Module

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped