abstract class RootModule extends BaseModule with MainModule
Used to mark a module in your build.mill as a top-level module, so it's
tasks 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.mill, and it must be
defined at the top level of the build.mill and not nested in any other
modules.
- Source
- RootModule.scala
- Alphabetic
- By Inheritance
- RootModule
- MainModule
- BaseModule
- BaseModule0
- Module
- BaseClass
- Cacher
- Cacher
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Type Members
- class Interp extends AnyRef
- Definition Classes
- BaseModule0
Value Members
- object millInternal extends Internal
Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill
- object interp extends Interp
- Definition Classes
- MainModule
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cachedTarget[T](t: => T)(implicit c: Enclosing): T
- Attributes
- protected[this]
- Definition Classes
- Cacher → Cacher
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val evalWatchedValues: Buffer[Watchable]
- Attributes
- protected[mill]
- Definition Classes
- BaseModule0
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def init(evaluator: Evaluator, args: String*): define.Command[Value]
The
initallows you to quickly generate a starter project.The
initallows you to quickly generate a starter project.If you run it without arguments, it displays the list of available examples.
If you pass one of listed examples, it downloads specified example from mill releases page and extracts it to working directory.
If you pass a g8 template, it will generate a project based on a Giter8 template. It prompts you to enter project name and creates a folder with that name. There are lots of templates out there for many frameworks and tools!
- Definition Classes
- MainModule
- def inspect(evaluator: Evaluator, tasks: 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def millDiscover: Discover
- Definition Classes
- RootModule → BaseModule → BaseModule0
- implicit def millImplicitBaseModule: Implicit
- Definition Classes
- BaseModule
- implicit def millModuleBasePath: BasePath
- Definition Classes
- BaseModule → Module
- def millModuleDirectChildren: Seq[define.Module]
- Definition Classes
- Module
- implicit def millModuleExternal: External
- Definition Classes
- Module
- implicit def millModuleSegments: Segments
- Definition Classes
- BaseModule → Module
- implicit def millModuleShared: Foreign
- Definition Classes
- Module
- def millOuterCtx: Ctx
- Definition Classes
- BaseClass
- def millSourcePath: Path
- Definition Classes
- BaseModule → Module
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def path(evaluator: Evaluator, src: String, dest: String): define.Command[List[String]]
Prints out some dependency path from the
srctask to thedesttask.Prints out some dependency path from the
srctask to thedesttask.If there are multiple dependency paths between
srcanddest, the path chosen is arbitrary.- Definition Classes
- MainModule
- 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
- 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
- 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
- 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
- def shutdown(): define.Command[Unit]
Shuts down mill's background server
Shuts down mill's background server
- Definition Classes
- MainModule
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Module → AnyRef → Any
- def version(): define.Command[String]
Show the mill version.
Show the mill version.
- Definition Classes
- MainModule
- 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
- 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
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val watchedValues: Buffer[Watchable]
- Attributes
- protected[mill]
- Definition Classes
- BaseModule0
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)