trait ZincWorkerModule extends BaseClass with Module with OfflineSupportModule with CoursierModule

A module managing an in-memory Zinc Scala incremental compiler

Source
ZincWorkerModule.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZincWorkerModule
  2. CoursierModule
  3. OfflineSupportModule
  4. Module
  5. BaseClass
  6. Cacher
  7. Cacher
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. object millInternal 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

    Definition Classes
    Module
    Annotations
    @internal()
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def backgroundWrapperClasspath: T[Agg[api.PathRef]]
  7. def bindDependency: define.Task[(Dep) => BoundDep]

    Bind a dependency (Dep) to the actual module context (e.g.

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

    returns

    The BoundDep

    Definition Classes
    CoursierModule
  8. def cachedTarget[T](t: => T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher → Cacher
  9. def classpath: T[Agg[api.PathRef]]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. def compilerInterfaceClasspath(scalaVersion: String, scalaOrganization: String, repositories: Seq[Repository]): Result[Agg[api.PathRef]]
  12. def coursierCacheCustomizer: define.Task[Option[(FileCache[coursier.util.Task]) => FileCache[coursier.util.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))
       )
    }
    Definition Classes
    CoursierModule
  13. def defaultResolver: define.Task[Resolver]
    Definition Classes
    CoursierModule
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def javaHome: T[Option[api.PathRef]]

    Optional custom Java Home for the ZincWorker to use

    Optional custom Java Home for the ZincWorker to use

    If this value is None, then the ZincWorker uses the same Java used to run the current mill instance.

  20. def jvmId: define.Target[String]
  21. def jvmIndexVersion: define.Target[String]
  22. def mapDependencies: define.Task[(coursier.Dependency) => coursier.Dependency]

    Map dependencies before resolving them.

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

    Definition Classes
    CoursierModule
  23. implicit def millModuleBasePath: BasePath
    Definition Classes
    Module
  24. def millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  25. implicit def millModuleExternal: External
    Definition Classes
    Module
  26. implicit def millModuleSegments: Segments
    Definition Classes
    Module
  27. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  28. def millOuterCtx: Ctx
    Definition Classes
    BaseClass
  29. def millSourcePath: Path
    Definition Classes
    Module
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. def overrideScalaLibrary(scalaVersion: String, scalaOrganization: String)(dep: coursier.Dependency): coursier.Dependency
  34. def prepareOffline(all: Flag): Command[Unit]

    Prepare the module for working offline.

    Prepare the module for working offline. This should typically fetch (missing) resources like ivy dependencies.

    all

    If true, it also fetches resources not always needed.

    Definition Classes
    ZincWorkerModuleOfflineSupportModule
  35. def prepareOfflineCompiler(scalaVersion: String, scalaOrganization: String): Command[Unit]
  36. def repositoriesTask: define.Task[Seq[Repository]]

    The repositories used to resolved dependencies with resolveDeps().

    The repositories used to resolved dependencies with resolveDeps().

    Definition Classes
    CoursierModule
  37. def resolutionCustomizer: define.Task[Option[(Resolution) => Resolution]]

    Customize the coursier resolution process.

    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))
      )
    }
    Definition Classes
    CoursierModule
  38. def resolutionParams: define.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.

    Definition Classes
    CoursierModule
  39. def resolveDeps(deps: define.Task[Agg[BoundDep]], sources: Boolean = false, artifactTypes: Option[Set[Type]] = None): define.Task[Agg[api.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.

    deps

    The dependencies to resolve.

    sources

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

    artifactTypes

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

    returns

    The PathRefs to the resolved files.

    Definition Classes
    CoursierModule
  40. def scalaCompilerBridgeJar(scalaVersion: String, scalaOrganization: String, repositories: Seq[Repository]): Result[(Option[Agg[api.PathRef]], api.PathRef)]
  41. def scalalibClasspath: T[Agg[api.PathRef]]
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def testrunnerEntrypointClasspath: T[Agg[api.PathRef]]
  44. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. def worker: Worker[ZincWorkerApi]
  49. def zincLogDebug: T[Boolean]

Deprecated Value Members

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

    (Since version 9)

  2. def resolveCoursierDependency: define.Task[(Dep) => coursier.Dependency]
    Definition Classes
    CoursierModule
    Annotations
    @deprecated
    Deprecated

    (Since version Mill after 0.11.0-M0) To be replaced by bindDependency

  3. def resolveDeps(deps: define.Task[Agg[BoundDep]], sources: Boolean): define.Task[Agg[api.PathRef]]
    Definition Classes
    CoursierModule
    Annotations
    @deprecated
    Deprecated

    (Since version Mill after 0.12.0-RC3) Use the override accepting artifactTypes

Inherited from CoursierModule

Inherited from OfflineSupportModule

Inherited from define.Module

Inherited from BaseClass

Inherited from Cacher

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped