t

mill.scalalib

JavaModule

trait JavaModule extends Module with TaskModule

Core configuration required to compile a single Scala compilation target

Self Type
JavaModule
Linear Supertypes
TaskModule, define.Module, Cacher, AnyRef, Any
Known Subclasses
CrossModuleBase, CrossSbtModule, Tests, CrossScalaModule, Tests, Tests, MavenModule, Tests, MavenTests, PublishModule, SbtModule, Tests, ScalaModule, Tests, TestModule, ScalafmtModule, ScalafmtModule
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaModule
  2. TaskModule
  3. Module
  4. Cacher
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Tests extends Module with TestModule

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def allSourceFiles: Target[Seq[eval.PathRef]]

    All individual source files fed into the compiler

  5. def allSources: Target[Seq[eval.PathRef]]

    The folders containing all source files fed into the compiler

  6. def artifactId: T[String]
  7. def artifactName: T[String]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def assembly: Target[eval.PathRef]

    An executable uber-jar/assembly containing all the resources and compiled classfiles from this module and all it's upstream modules and dependencies

  10. def assemblyRules: Seq[Rule]
  11. def cachedTarget[T](t: ⇒ T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. def compile: T[CompilationResult]

    Compiles the current module to generate compiled classfiles/bytecode

  14. def compileClasspath: Target[util.Loose.Agg[eval.PathRef]]

    All classfiles and resources from upstream modules and dependencies necessary to compile this module

  15. def compileIvyDeps: Target[util.Loose.Agg[Dep]]

    Same as ivyDeps, but only present at compile time.

    Same as ivyDeps, but only present at compile time. Useful for e.g. macro-related dependencies like scala-reflect that doesn't need to be present at runtime

  16. def defaultCommandName(): String
    Definition Classes
    JavaModule → TaskModule
  17. def docJar: Target[eval.PathRef]

    The documentation jar, containing all the Javadoc/Scaladoc HTML files, for publishing to Maven Central

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalMainClass: T[String]
  21. def finalMainClassOpt: T[Either[String, String]]
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def forkArgs: Target[Seq[String]]

    Any command-line parameters you want to pass to the forked JVM under run, test or repl

  24. def forkEnv: Target[Map[String, String]]

    Any environment variables you want to pass to the forked JVM under run, test or repl

  25. def forkWorkingDir: Target[Path]
  26. def generatedSources: Target[Seq[eval.PathRef]]

    Folders containing source files that are generated rather than hand-written; these files can be generated in this target itself, or can refer to files generated from other targets

  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def intellijModulePath: Path
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def ivyDeps: Target[util.Loose.Agg[Dep]]

    Any ivy dependencies you want to add to this Module, in the format ivy"org::name:version" for Scala dependencies or ivy"org:name:version" for Java dependencies

  32. def ivyDepsTree(inverse: Boolean = false): Command[Unit]
  33. def jar: Target[eval.PathRef]

    A jar containing only this module's resources and compiled classfiles, without those from upstream modules and dependencies

  34. def javacOptions: Target[Seq[String]]

    Options to pass to the java compiler

  35. def launcher: Target[eval.PathRef]

    Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process.

    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

  36. def localClasspath: Target[Seq[eval.PathRef]]

    The output classfiles/resources from this module, excluding upstream modules and third-party dependencies

  37. def mainClass: T[Option[String]]

    Allows you to specify an explicit main class to use for the run command.

    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

  38. def mapDependencies: Task[(Dependency) ⇒ Dependency]
  39. implicit def millModuleBasePath: BasePath
    Definition Classes
    Module
  40. lazy val millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  41. implicit def millModuleExternal: External
    Definition Classes
    Module
  42. implicit def millModuleSegments: Segments
    Definition Classes
    Module
  43. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  44. def millOuterCtx: Ctx
    Definition Classes
    Module
  45. def millSourcePath: Path
    Definition Classes
    Module
  46. def moduleDeps: Seq[JavaModule]

    The direct dependencies of this module

  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. def platformSuffix: Target[String]

    What platform suffix to use for publishing, e.g.

    What platform suffix to use for publishing, e.g. _sjs for Scala.js projects

  51. def prependShellScript: T[String]

    What shell script to use to launch the executable generated by assembly.

    What shell script to use to launch the executable generated by assembly. Defaults to a generic "universal" launcher that should work for Windows, OS-X and Linux

  52. def recursiveModuleDeps: Seq[JavaModule]

    The direct and indirect dependencies of this module

  53. def repositories: Seq[Repository]
  54. def resolveCoursierDependency: Task[(Dep) ⇒ Dependency]
  55. def resolveDeps(deps: Task[util.Loose.Agg[Dep]], sources: Boolean = false): Task[Agg[eval.PathRef]]
  56. def resolvePublishDependency: Task[(Dep) ⇒ Dependency]
  57. def resources: Sources

    The folders where the resource files for this module live

  58. def run(args: String*): Command[Unit]

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

  59. def runBackground(args: String*): Command[Unit]

    Runs this module's code in a background process, until it dies or runBackground is used again.

    Runs this module's code in a background process, until it dies or runBackground is used again. This lets you continue using Mill while the process is running in the background: editing files, compiling, and only re-starting the background process when you're ready.

    You can also use -w foo.runBackground to make Mill watch for changes and automatically recompile your code & restart the background process when ready. This is useful when working on long-running server processes that would otherwise run forever

  60. def runClasspath: Target[Seq[eval.PathRef]]

    All classfiles and resources from upstream modules and dependencies necessary to run this module's code after compilation

  61. def runIvyDeps: Target[util.Loose.Agg[Dep]]

    Same as ivyDeps, but only present at runtime.

    Same as ivyDeps, but only present at runtime. Useful for e.g. selecting different versions of a dependency to use at runtime after your code has already been compiled

  62. def runLocal(args: String*): Command[Unit]

    Runs this module's code in-process within an isolated classloader.

    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.

  63. def runMain(mainClass: String, args: String*): Command[Unit]

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

  64. def runMainBackground(mainClass: String, args: String*): Command[Unit]

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

  65. def runMainLocal(mainClass: String, args: String*): Command[Unit]

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

  66. def skipIdea: Boolean

    Skip Idea project file generation.

  67. def sourceJar: Target[eval.PathRef]

    The source jar, containing only source code for publishing to Maven Central

  68. def sources: Sources

    The folders where the source files for this module live

  69. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  70. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  71. def transitiveIvyDeps: T[util.Loose.Agg[Dep]]

    The transitive ivy dependencies of this module and all it's upstream modules

  72. def transitiveLocalClasspath: T[util.Loose.Agg[eval.PathRef]]

    The transitive version of localClasspath

  73. def transitiveModuleDeps: Seq[JavaModule]

    Like recursiveModuleDeps but also include the module itself

  74. def unmanagedClasspath: Target[util.Loose.Agg[eval.PathRef]]

    Additional jars, classfiles or resources to add to the classpath directly from disk rather than being downloaded from Maven Central or other package repositories

  75. def upstreamAssembly: Target[eval.PathRef]

    Build the assembly for upstream dependencies separate from the current classpath

    Build the assembly for upstream dependencies separate from the current classpath

    This should allow much faster assembly creation in the common case where upstream dependencies do not change

  76. def upstreamAssemblyClasspath: Target[util.Loose.Agg[eval.PathRef]]

    All upstream classfiles and resources necessary to build and executable assembly, but without this module's contribution

  77. def upstreamCompileOutput: Target[Seq[CompilationResult]]

    The upstream compilation output of all this module's upstream modules

  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  81. def zincWorker: ZincWorkerModule
  82. object millInternal extends Internal
    Definition Classes
    Module
    Annotations
    @Scaladoc()

Inherited from TaskModule

Inherited from define.Module

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped