Mill
API
Generated with
Mill/mill/mill.main/RootModule

RootModule

mill.main.RootModule
See theRootModule companion object
@Scaladoc(value = "/**\n * Used to mark a module in your `build.mill` as a top-level module, so it\'s\n * tasks can be run directly e.g. via `mill run` rather than\n * prefixed by the module name `mill foo.run`.\n *\n * Only one top-level module may be defined in your `build.mill`, and it must be\n * defined at the top level of the `build.mill` and not nested in any other\n * modules.\n */")
abstract class RootModule()(implicit baseModuleInfo: Info, millModuleEnclosing0: Enclosing, millModuleLine0: Line, millFile0: File) extends BaseModule, 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.

Attributes

Companion
object
Source
RootModule.scala
Graph
Supertypes
trait MainModule
class BaseModule
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

object interp

Attributes

Inherited from:
MainModule
Source
MainModule.scala
Supertypes
class Object
trait Matchable
class Any
@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
Source
Module.scala
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

def millDiscover: Discover

Attributes

Source
RootModule.scala

Inherited methods

@Scaladoc(value = "/**\n * Deletes the given targets from the out directory. Providing no targets\n * will clean everything.\n */")
def clean(evaluator: Evaluator, targets: String*): Command[Seq[PathRef]]

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

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

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * The `init` allows you to quickly generate a starter project.\n *\n * If you run it without arguments, it displays the list of available examples.\n *\n * If you pass one of listed examples, it downloads specified example from mill releases page and extracts it to working directory.\n *\n * If you pass a g8 template, it will generate a project based on a Giter8 template.\n * It prompts you to enter project name and creates a folder with that name.\n * There are lots of templates out there for many frameworks and tools!\n */")
def init(evaluator: Evaluator, args: String*): Command[Unit]

The init allows you to quickly generate a starter project.

The init allows 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!

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Displays metadata about the given task without actually running it.\n */")
def inspect(evaluator: Evaluator, tasks: String*): Command[String]

Displays metadata about the given task without actually running it.

Displays metadata about the given task without actually running it.

Attributes

Inherited from:
MainModule
Source
MainModule.scala
def moduleCtx: Ctx

Attributes

Inherited from:
BaseModule
Source
BaseModule.scala
def moduleDir: Path

Attributes

Inherited from:
Module
Source
Module.scala
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
Source
Module.scala
def moduleSegments: Segments

Attributes

Inherited from:
Module
Source
Module.scala
@Scaladoc(value = "/**\n * Prints out some dependency path from the `src` task to the `dest` task.\n *\n * If there are multiple dependency paths between `src` and `dest`, the path\n * chosen is arbitrary.\n */")
def path(evaluator: Evaluator, src: String, dest: String): 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.

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Given a set of tasks, prints out the execution plan of what tasks will be\n * executed in what order, without actually executing them.\n */")
def plan(evaluator: Evaluator, targets: String*): 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.

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Resolves a mill query string and prints out the tasks it resolves to.\n */")
def resolve(evaluator: Evaluator, targets: String*): 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.

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Runs a given task and prints the JSON result to stdout. This is useful\n * to integrate Mill into external scripts and tooling.\n */")
def show(evaluator: Evaluator, targets: String*): Command[Value]

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

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

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Runs a given task and prints the results as JSON dictionary to stdout. This is useful\n * to integrate Mill into external scripts and tooling.\n */")
def showNamed(evaluator: Evaluator, targets: String*): Command[Value]

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

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

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Shuts down mill\'s background server\n */")
def shutdown(): Command[Unit]

Shuts down mill's background server

Shuts down mill's background server

Attributes

Inherited from:
MainModule
Source
MainModule.scala
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
Source
Module.scala
@Scaladoc(value = "/**\n * Show the mill version.\n */")
def version(): Command[String]

Show the mill version.

Show the mill version.

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Renders the dependencies between the given tasks as a SVG for you to look at\n */")
def visualize(evaluator: Evaluator, targets: String*): Command[Seq[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

Attributes

Inherited from:
MainModule
Source
MainModule.scala
@Scaladoc(value = "/**\n * Renders the dependencies between the given tasks, and all their dependencies, as a SVG\n */")
def visualizePlan(evaluator: Evaluator, targets: String*): Command[Seq[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

Attributes

Inherited from:
MainModule
Source
MainModule.scala

Inherited fields

@Scaladoc(value = "/**\n * Commands related to selective execution, where Mill runs tasks selectively\n * depending on what task inputs or implementations changed\n */")
lazy val selective: SelectiveExecutionModule

Commands related to selective execution, where Mill runs tasks selectively depending on what task inputs or implementations changed

Commands related to selective execution, where Mill runs tasks selectively depending on what task inputs or implementations changed

Attributes

Inherited from:
MainModule
Source
MainModule.scala

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Source
Module.scala
Generated with