Mill
API
Generated with
Mill/mill/mill.scalalib/RunModule

RunModule

mill.scalalib.RunModule
See theRunModule companion object
trait RunModule extends WithZincWorker

Attributes

Companion
object
Source
RunModule.scala
Graph
Supertypes
trait Module
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
trait JavaModule
trait JavaTests
trait KotlinTests
trait KotestTests
trait KspTests
trait MavenTests
trait SbtTests
trait ScalaTests
trait ScalaJSTests
trait KtfmtModule
object KtfmtModule
trait KotlinModule
trait DetektModule
trait KoverModule
trait KspModule
trait BomModule
trait JlinkModule
trait MavenModule
trait SbtModule
trait ScalaModule
trait UnidocModule
trait TestModule
trait AndroidJUnit
trait Junit4
trait Junit5
trait Munit
trait ScalaCheck
trait ScalaTest
trait Specs2
trait TestNg
trait Utest
trait Weaver
trait ZioTest
Show all

Members list

Type members

Inherited classlikes

@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 allLocalMainClasses: Target[Seq[String]]

Attributes

Source
RunModule.scala
def finalMainClass: Target[String]

Attributes

Source
RunModule.scala
def finalMainClassOpt: Target[Either[String, String]]

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Any command-line parameters you want to pass to the forked JVM.\n */")
def forkArgs: Target[Seq[String]]

Any command-line parameters you want to pass to the forked JVM.

Any command-line parameters you want to pass to the forked JVM.

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Any environment variables you want to pass to the forked JVM.\n */")
def forkEnv: Target[Map[String, String]]

Any environment variables you want to pass to the forked JVM.

Any environment variables you want to pass to the forked JVM.

Attributes

Source
RunModule.scala
def forkWorkingDir: Target[Path]

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Builds a command-line \"launcher\" file that can be used to run this module\'s\n * code, without the Mill process. Useful for deployment & other places where\n * you do not want a build tool running\n */")
def launcher: Target[PathRef]

Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process. Useful for deployment & other places where you do not want a build tool running

Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process. Useful for deployment & other places where you do not want a build tool running

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * The elements of the run classpath which are local to this module.\n * This is typically the output of a compilation step and bundles runtime resources.\n */")
def localRunClasspath: Target[Seq[PathRef]]

The elements of the run classpath which are local to this module. This is typically the output of a compilation step and bundles runtime resources.

The elements of the run classpath which are local to this module. This is typically the output of a compilation step and bundles runtime resources.

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Allows you to specify an explicit main class to use for the `run` command.\n * If none is specified, the classpath is searched for an appropriate main\n * class to use if one exists.\n */")
def mainClass: Target[Option[String]]

Allows you to specify an explicit main class to use for the run command. If none is specified, the classpath is searched for an appropriate main class to use if one exists.

Allows you to specify an explicit main class to use for the run command. If none is specified, the classpath is searched for an appropriate main class to use if one exists.

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Runs this module\'s code in a subprocess and waits for it to finish\n */")
def run(args: Task[Args]): Command[Unit]

Runs this module's code in a subprocess and waits for it to finish

Runs this module's code in a subprocess and waits for it to finish

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * If true, stdout and stderr of the process executed by `runBackground`\n * or `runMainBackground` is sent to mill\'s stdout/stderr (which usually\n * flow to the console).\n *\n * If false, output will be directed to files `stdout.log` and `stderr.log`\n * in `runBackground.dest` (or `runMainBackground.dest`)\n */")
def runBackgroundLogToConsole: Boolean

If true, stdout and stderr of the process executed by runBackground or runMainBackground is sent to mill's stdout/stderr (which usually flow to the console).

If true, stdout and stderr of the process executed by runBackground or runMainBackground is sent to mill's stdout/stderr (which usually flow to the console).

If false, output will be directed to files stdout.log and stderr.log in runBackground.dest (or runMainBackground.dest)

Attributes

Source
RunModule.scala
def runBackgroundTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * All classfiles and resources including upstream modules and dependencies\n * necessary to run this module\'s code.\n */")
def runClasspath: Target[Seq[PathRef]]

All classfiles and resources including upstream modules and dependencies necessary to run this module's code.

All classfiles and resources including upstream modules and dependencies necessary to run this module's code.

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Runs this module\'s code in a subprocess and waits for it to finish\n */")
def runForkedTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Runs this module's code in a subprocess and waits for it to finish

Runs this module's code in a subprocess and waits for it to finish

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Runs this module\'s code in-process within an isolated classloader. This is\n * faster than `run`, but in exchange you have less isolation between runs\n * since the code can dirty the parent Mill process and potentially leave it\n * in a bad state.\n */")
def runLocal(args: Task[Args]): Command[Unit]

Runs this module's code in-process within an isolated classloader. This is faster than run, but in exchange you have less isolation between runs since the code can dirty the parent Mill process and potentially leave it in a bad state.

Runs this module's code in-process within an isolated classloader. This is faster than run, but in exchange you have less isolation between runs since the code can dirty the parent Mill process and potentially leave it in a bad state.

Attributes

Source
RunModule.scala
def runLocalTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Same as `run`, but lets you specify a main class to run\n */")
def runMain(mainClass: String, args: String*): Command[Unit]

Same as run, but lets you specify a main class to run

Same as run, but lets you specify a main class to run

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Same as `runBackground`, but lets you specify a main class to run\n */")
def runMainBackground(mainClass: String, args: String*): Command[Unit]

Same as runBackground, but lets you specify a main class to run

Same as runBackground, but lets you specify a main class to run

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Same as `runLocal`, but lets you specify a main class to run\n */")
def runMainLocal(mainClass: String, args: String*): Command[Unit]

Same as runLocal, but lets you specify a main class to run

Same as runLocal, but lets you specify a main class to run

Attributes

Source
RunModule.scala
@Scaladoc(value = "/**\n * Control whether `run*`-targets should use an args file to pass command line args, if possible.\n */")
def runUseArgsFile: Target[Boolean]

Control whether run*-targets should use an args file to pass command line args, if possible.

Control whether run*-targets should use an args file to pass command line args, if possible.

Attributes

Source
RunModule.scala
def runner: Task[Runner]

Attributes

Source
RunModule.scala

Inherited methods

def moduleCtx: Ctx

Attributes

Inherited from:
BaseClass
Source
Module.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
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
def zincWorker: ModuleRef[ZincWorkerModule]

Attributes

Inherited from:
WithZincWorker
Source
WithZincWorker.scala

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Source
Module.scala
Generated with