Packages

abstract class RootModule extends BaseModule with MainModule

Used to mark a module in your build.sc as a top-level module, so it's targets and commands can be run directly e.g. via mill run rather than prefixed by the module name mill foo.run.

Only one top-level module may be defined in your build.sc, and it must be defined at the top level of the build.sc and not nested in any other modules.

Source
RootModule.scala
Linear Supertypes
MainModule, BaseModule, define.Module, BaseClass, Cacher, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RootModule
  2. MainModule
  3. BaseModule
  4. Module
  5. BaseClass
  6. Cacher
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RootModule()(implicit baseModuleInfo: Info, millModuleEnclosing0: Enclosing, millModuleLine0: Line, millFile0: File)

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. object interp
    Definition Classes
    MainModule
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def cachedTarget[T](t: => T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher
  8. def clean(evaluator: Evaluator, targets: String*): define.Command[Seq[api.PathRef]]

    Deletes the given targets from the out directory.

    Deletes the given targets from the out directory. Providing no targets will clean everything.

    Definition Classes
    MainModule
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. val evalWatchedValues: Buffer[Watchable]
    Attributes
    protected[mill]
    Definition Classes
    MainModule
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def init(evaluator: Evaluator, args: String*): define.Command[Unit]

    The init command generates a project based on a Giter8 template.

    The init command generates a project based on a Giter8 template. It prompts you to enter project name and creates a folder with that name. You can use it to quickly generate a starter project. There are lots of templates out there for many frameworks and tools!

    Definition Classes
    MainModule
  17. def inspect(evaluator: Evaluator, targets: String*): define.Command[String]

    Displays metadata about the given task without actually running it.

    Displays metadata about the given task without actually running it.

    Definition Classes
    MainModule
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. lazy val millDiscover: Discover[RootModule.this.type]
    Definition Classes
    RootModule → MainModule → BaseModule
  20. implicit def millImplicitBaseModule: Implicit
    Definition Classes
    BaseModule
  21. implicit def millModuleBasePath: BasePath
    Definition Classes
    BaseModule → Module
  22. def millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  23. implicit def millModuleExternal: External
    Definition Classes
    Module
  24. implicit def millModuleSegments: Segments
    Definition Classes
    BaseModule → Module
  25. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  26. def millOuterCtx: Ctx
    Definition Classes
    BaseClass
  27. def millSourcePath: Path
    Definition Classes
    BaseModule → Module
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def path(evaluator: Evaluator, src: String, dest: String): define.Command[List[String]]

    Prints out some dependency path from the src task to the dest task.

    Prints out some dependency path from the src task to the dest task.

    If there are multiple dependency paths between src and dest, the path chosen is arbitrary.

    Definition Classes
    MainModule
  32. def plan(evaluator: Evaluator, targets: String*): define.Command[Array[String]]

    Given a set of tasks, prints out the execution plan of what tasks will be executed in what order, without actually executing them.

    Given a set of tasks, prints out the execution plan of what tasks will be executed in what order, without actually executing them.

    Definition Classes
    MainModule
  33. def resolve(evaluator: Evaluator, targets: String*): define.Command[List[String]]

    Resolves a mill query string and prints out the tasks it resolves to.

    Resolves a mill query string and prints out the tasks it resolves to.

    Definition Classes
    MainModule
  34. def show(evaluator: Evaluator, targets: String*): define.Command[Value]

    Runs a given task and prints the JSON result to stdout.

    Runs a given task and prints the JSON result to stdout. This is useful to integrate Mill into external scripts and tooling.

    Definition Classes
    MainModule
  35. def showNamed(evaluator: Evaluator, targets: String*): define.Command[Value]

    Runs a given task and prints the results as JSON dictionary to stdout.

    Runs a given task and prints the results as JSON dictionary to stdout. This is useful to integrate Mill into external scripts and tooling.

    Definition Classes
    MainModule
  36. def shutdown(): define.Command[Unit]

    Shuts down mill's background server

    Shuts down mill's background server

    Definition Classes
    MainModule
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  39. def version(): define.Command[String]

    Show the mill version.

    Show the mill version.

    Definition Classes
    MainModule
  40. def visualize(evaluator: Evaluator, targets: String*): define.Command[Seq[api.PathRef]]

    Renders the dependencies between the given tasks as a SVG for you to look at

    Renders the dependencies between the given tasks as a SVG for you to look at

    Definition Classes
    MainModule
  41. def visualizePlan(evaluator: Evaluator, targets: String*): define.Command[Seq[api.PathRef]]

    Renders the dependencies between the given tasks, and all their dependencies, as a SVG

    Renders the dependencies between the given tasks, and all their dependencies, as a SVG

    Definition Classes
    MainModule
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. val watchedValues: Buffer[Watchable]
    Attributes
    protected[mill]
    Definition Classes
    MainModule

Inherited from MainModule

Inherited from BaseModule

Inherited from define.Module

Inherited from BaseClass

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped