mill-libs-androidlib
API
Generated with
mill-libs-androidlib/mill.androidlib/AndroidAppModule/AndroidAppTests

AndroidAppTests

mill.androidlib.AndroidAppModule.AndroidAppTests
trait AndroidAppTests extends AndroidAppModule, JavaTests

Attributes

Graph
Supertypes
trait JavaTests
trait TestModule
trait TestModuleApi
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited classlikes

trait AndroidAppInstrumentedTests extends AndroidAppModule, AndroidTestModule

Attributes

Inherited from:
AndroidAppModule
Supertypes
trait TestModule
trait TestModuleApi
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
trait AndroidAppTests extends AndroidAppModule, JavaTests

Attributes

Inherited from:
AndroidAppModule
Supertypes
trait JavaTests
trait TestModule
trait TestModuleApi
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
trait JavaTests extends JavaModule, TestModule

Attributes

Inherited from:
JavaModule
Supertypes
trait TestModule
trait TestModuleApi
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
trait KotlinTests
trait KspTests
Show all
@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
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

override def androidApplicationId: String

Android Application Id which is typically package.main . Can be used for build variants.

Android Application Id which is typically package.main . Can be used for build variants.

Build variant feature is not yet implemented!

Attributes

Definition Classes
override def androidApplicationNamespace: String

The namespace of the android application which is used to specify the fully qualified classpath of the activity.

The namespace of the android application which is used to specify the fully qualified classpath of the activity.

For instance, it is used as the package name in Android Manifest

Attributes

Definition Classes
override def androidCompileSdk: Target[Int]

This setting defines which Android API level your project compiles against. This is a required property for Android builds.

This setting defines which Android API level your project compiles against. This is a required property for Android builds.

It determines what Android APIs are available during compilation - your code can only use APIs from this level or lower.

See https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels for more details.

Attributes

Definition Classes
override def androidManifest: Target[PathRef]

Provides os.Path to an XML file containing configuration and metadata about your android application. TODO dynamically add android:debuggable

Provides os.Path to an XML file containing configuration and metadata about your android application. TODO dynamically add android:debuggable

Attributes

Definition Classes
override def androidMinSdk: Target[Int]

The minimum SDK version to use. Default is 1.

The minimum SDK version to use. Default is 1.

See https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#min for more details.

Attributes

Definition Classes
override def androidSdkModule: ModuleRef[AndroidSdkModule]

Provides access to the Android SDK configuration.

Provides access to the Android SDK configuration.

Attributes

Definition Classes
override def androidTargetSdk: Target[Int]

The target SDK version to use. Default is equal to the androidCompileSdk value.

The target SDK version to use. Default is equal to the androidCompileSdk value.

See https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#target for more details.

Attributes

Definition Classes
override def bspBuildTarget: BspBuildTarget

Use to fill most fields of BuildTarget.

Use to fill most fields of BuildTarget.

Attributes

Definition Classes
TestModule -> AndroidAppModule -> JavaModule -> SemanticDbJavaModule -> BspModule -> BspModuleApi
override def moduleDir: Path

Attributes

Definition Classes
Module
override def resources: Target[Seq[PathRef]]

The folders where the resource files for this module live. If you need resources to be seen by the compiler, use compileResources.

The folders where the resource files for this module live. If you need resources to be seen by the compiler, use compileResources.

Attributes

Definition Classes
JavaTests -> AndroidAppModule -> JavaModule -> JavaModuleBase
override def sources: Target[Seq[PathRef]]

The folders where the source files for this module live

The folders where the source files for this module live

Attributes

Definition Classes
AndroidModule -> JavaModule

Inherited methods

def adbDevices: Target[String]

Attributes

Inherited from:
AndroidAppModule
def allBomDeps: Task[Seq[BomDependency]]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All main classes detected in this module that can serve as program entry-points.\n */")
def allLocalMainClasses: Target[Seq[String]]

All main classes detected in this module that can serve as program entry-points.

All main classes detected in this module that can serve as program entry-points.

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Aggregation of mandatoryMvnDeps and mvnDeps.\n * In most cases, instead of overriding this Target you want to override `mvnDeps` instead.\n */")
def allMvnDeps: Target[Seq[Dep]]

Aggregation of mandatoryMvnDeps and mvnDeps. In most cases, instead of overriding this Target you want to override mvnDeps instead.

Aggregation of mandatoryMvnDeps and mvnDeps. In most cases, instead of overriding this Target you want to override mvnDeps instead.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The repositories used to resolve dependencies\n *\n * Unlike [[repositoriesTask]], this includes the Mill internal repositories,\n * which allow to resolve Mill internal modules (usually brought in via\n * `JavaModule#coursierDependency`).\n *\n * Beware that this needs to evaluate `JavaModule#coursierProject` of all\n * module dependencies of the current module, which itself evaluates `JavaModule#mvnDeps`\n * and related tasks. You shouldn\'t depend on this task from implementations of `mvnDeps`,\n * which would introduce cycles between Mill tasks.\n */")
def allRepositories: Task[Seq[Repository]]

The repositories used to resolve dependencies

The repositories used to resolve dependencies

Unlike repositoriesTask, this includes the Mill internal repositories, which allow to resolve Mill internal modules (usually brought in via JavaModule#coursierDependency).

Beware that this needs to evaluate JavaModule#coursierProject of all module dependencies of the current module, which itself evaluates JavaModule#mvnDeps and related tasks. You shouldn't depend on this task from implementations of mvnDeps, which would introduce cycles between Mill tasks.

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * All individual source files fed into the Java compiler\n */")
def allSourceFiles: Target[Seq[PathRef]]

All individual source files fed into the Java compiler

All individual source files fed into the Java compiler

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders containing all source files fed into the compiler\n */")
def allSources: Target[Seq[PathRef]]

The folders containing all source files fed into the compiler

The folders containing all source files fed into the compiler

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Specifies AAPT options for Android resource compilation.\n */")
def androidAaptOptions: Target[Seq[String]]

Specifies AAPT options for Android resource compilation.

Specifies AAPT options for Android resource compilation.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Optimizes the APK using the `zipalign` tool for better performance.\n *\n * For more details on the zipalign tool, refer to:\n * [[https://developer.android.com/tools/zipalign zipalign Documentation]]\n */")
def androidAlignedUnsignedApk: Target[PathRef]

Optimizes the APK using the zipalign tool for better performance.

Optimizes the APK using the zipalign tool for better performance.

For more details on the zipalign tool, refer to: zipalign Documentation

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Signs the APK using a keystore to generate a final, distributable APK.\n *\n * The signing step is mandatory to distribute Android applications. It adds a cryptographic\n * signature to the APK, verifying its authenticity. This method uses the `apksigner` tool\n * along with a keystore file to sign the APK.\n *\n * If no keystore is available, a new one is generated using the `keytool` utility.\n *\n * For more details on the apksigner tool, refer to:\n * [[https://developer.android.com/tools/apksigner apksigner Documentation]]\n */")
def androidApk: Target[PathRef]

Signs the APK using a keystore to generate a final, distributable APK.

Signs the APK using a keystore to generate a final, distributable APK.

The signing step is mandatory to distribute Android applications. It adds a cryptographic signature to the APK, verifying its authenticity. This method uses the apksigner tool along with a keystore file to sign the APK.

If no keystore is available, a new one is generated using the keytool utility.

For more details on the apksigner tool, refer to: apksigner Documentation

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Gives the android build type settings for debug or release.\n * Controlled by [[androidIsDebug]] flag!\n * @return\n */")
def androidBuildSettings: Target[AndroidBuildTypeSettings]

Gives the android build type settings for debug or release. Controlled by androidIsDebug flag!

Gives the android build type settings for debug or release. Controlled by androidIsDebug flag!

Attributes

Inherited from:
AndroidAppModule
def androidDebugSettings: Target[AndroidBuildTypeSettings]

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/** The device id as listed from avdmanager list device. Default is medium_phone */")
def androidDeviceId: String

The device id as listed from avdmanager list device. Default is medium_phone

The device id as listed from avdmanager list device. Default is medium_phone

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Converts the generated JAR file into a DEX file using the `d8` or the r8 tool if minification is enabled\n * through the [[androidBuildSettings]].\n *\n * @return os.Path to the Generated DEX File Directory\n */")
def androidDex: Target[PathRef]

Converts the generated JAR file into a DEX file using the d8 or the r8 tool if minification is enabled through the androidBuildSettings.

Converts the generated JAR file into a DEX file using the d8 or the r8 tool if minification is enabled through the androidBuildSettings.

Attributes

Returns

os.Path to the Generated DEX File Directory

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * The target architecture of the virtual device to be created by [[createAndroidVirtualDevice]]\n * For example, \"x86_64\" (default). For a list of system images and their architectures,\n * see the Android SDK Manager `sdkmanager --list`.\n */")
def androidEmulatorArchitecture: String

The target architecture of the virtual device to be created by createAndroidVirtualDevice For example, "x86_64" (default). For a list of system images and their architectures, see the Android SDK Manager sdkmanager --list.

The target architecture of the virtual device to be created by createAndroidVirtualDevice For example, "x86_64" (default). For a list of system images and their architectures, see the Android SDK Manager sdkmanager --list.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/** The emulator port where adb connects to. Defaults to 5554 */")
def androidEmulatorPort: String

The emulator port where adb connects to. Defaults to 5554

The emulator port where adb connects to. Defaults to 5554

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * In the case of android apps this the [[androidApplicationNamespace]].\n * @return\n */")
override protected def androidGeneratedResourcesPackage: String

In the case of android apps this the androidApplicationNamespace.

In the case of android apps this the androidApplicationNamespace.

Attributes

Definition Classes
Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Installs the app to the android device identified by this configuration in [[androidVirtualDeviceIdentifier]].\n *\n * @return The name of the device the app was installed to\n */")
def androidInstall(): Command[String]

Installs the app to the android device identified by this configuration in androidVirtualDeviceIdentifier.

Installs the app to the android device identified by this configuration in androidVirtualDeviceIdentifier.

Attributes

Returns

The name of the device the app was installed to

Inherited from:
AndroidAppModule
def androidInstallTask: Task[String]

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Controls debug vs release build type. Default is `true`, meaning debug build will be generated.\n *\n * This option will probably go away in the future once build variants are supported.\n */")
def androidIsDebug: Target[Boolean]

Controls debug vs release build type. Default is true, meaning debug build will be generated.

Controls debug vs release build type. Default is true, meaning debug build will be generated.

This option will probably go away in the future once build variants are supported.

Attributes

Inherited from:
AndroidModule
protected def androidKeystore: Target[PathRef]

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Collect files from META-INF folder of classes.jar (not META-INF of aar in case of Android library).\n */")
def androidLibsClassesJarMetaInf: Target[Seq[PathRef]]

Collect files from META-INF folder of classes.jar (not META-INF of aar in case of Android library).

Collect files from META-INF folder of classes.jar (not META-INF of aar in case of Android library).

Attributes

Inherited from:
AndroidAppModule
def androidLibsRClasses: Target[Seq[PathRef]]

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Determines whether the build should fail if Android Lint detects any issues.\n */")
def androidLintAbortOnError: Boolean

Determines whether the build should fail if Android Lint detects any issues.

Determines whether the build should fail if Android Lint detects any issues.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Specifies additional arguments for the Android Lint tool.\n * Allows for complete customization of the lint command.\n */")
def androidLintArgs: Target[Seq[String]]

Specifies additional arguments for the Android Lint tool. Allows for complete customization of the lint command.

Specifies additional arguments for the Android Lint tool. Allows for complete customization of the lint command.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Specifies the lint baseline XML file path. This allows using a baseline to suppress known lint warnings.\n */")
def androidLintBaselinePath: Target[Option[PathRef]]

Specifies the lint baseline XML file path. This allows using a baseline to suppress known lint warnings.

Specifies the lint baseline XML file path. This allows using a baseline to suppress known lint warnings.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Specifies the lint configuration XML file path. This allows setting custom lint rules or modifying existing ones.\n */")
def androidLintConfigPath: Target[Option[PathRef]]

Specifies the lint configuration XML file path. This allows setting custom lint rules or modifying existing ones.

Specifies the lint configuration XML file path. This allows setting custom lint rules or modifying existing ones.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Specifies the file format(s) of the lint report. Available file formats are defined in AndroidLintReportFormat,\n * such as [[AndroidLintReportFormat.Html]], [[AndroidLintReportFormat.Xml]], [[AndroidLintReportFormat.Txt]],\n * and [[AndroidLintReportFormat.Sarif]].\n */")
def androidLintReportFormat: Target[Seq[Value]]

Specifies the file format(s) of the lint report. Available file formats are defined in AndroidLintReportFormat, such as AndroidLintReportFormat.Html, AndroidLintReportFormat.Xml, AndroidLintReportFormat.Txt, and AndroidLintReportFormat.Sarif.

Specifies the file format(s) of the lint report. Available file formats are defined in AndroidLintReportFormat, such as AndroidLintReportFormat.Html, AndroidLintReportFormat.Xml, AndroidLintReportFormat.Txt, and AndroidLintReportFormat.Sarif.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Runs the Android Lint tool to generate a report on code quality issues.\n *\n * This method utilizes Android Lint, a tool provided by the Android SDK,\n * to analyze the source code for potential bugs, performance issues, and\n * best practices compliance. It generates a report in the specified format.\n *\n * The report is saved in the task\'s destination directory as \"report.html\" by\n * default. It can be changed to other file format such as xml, txt and sarif.\n *\n * For more details on the Android Lint tool, refer to:\n * [[https://developer.android.com/studio/write/lint]]\n */")
def androidLintRun(): Command[PathRef]

Runs the Android Lint tool to generate a report on code quality issues.

Runs the Android Lint tool to generate a report on code quality issues.

This method utilizes Android Lint, a tool provided by the Android SDK, to analyze the source code for potential bugs, performance issues, and best practices compliance. It generates a report in the specified format.

The report is saved in the task's destination directory as "report.html" by default. It can be changed to other file format such as xml, txt and sarif.

For more details on the Android Lint tool, refer to: https://developer.android.com/studio/write/lint

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Creates a merged manifest from application and dependencies manifests.\n *\n * See [[https://developer.android.com/build/manage-manifests]] for more details.\n */")
def androidMergedManifest: Target[PathRef]

Creates a merged manifest from application and dependencies manifests.

Creates a merged manifest from application and dependencies manifests.

See https://developer.android.com/build/manage-manifests for more details.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Provides additional files to be included in the APK package.\n * This can be used to add custom files or resources that are not\n * automatically included in the build process like native libraries .so files.\n */")
def androidPackageableExtraFiles: Target[Seq[AndroidPackageableExtraFile]]

Provides additional files to be included in the APK package. This can be used to add custom files or resources that are not automatically included in the build process like native libraries .so files.

Provides additional files to be included in the APK package. This can be used to add custom files or resources that are not automatically included in the build process like native libraries .so files.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/** All individual classfiles inherited from the classpath that will be included into the dex */")
def androidPackagedClassfiles: Target[Seq[PathRef]]

All individual classfiles inherited from the classpath that will be included into the dex

All individual classfiles inherited from the classpath that will be included into the dex

Attributes

Inherited from:
AndroidModule
def androidPackagedCompiledClasses: Target[Seq[PathRef]]

Attributes

Inherited from:
AndroidModule
def androidPackagedDeps: Target[Seq[PathRef]]

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Creates an intermediate R.jar that includes all the resources from the application and its dependencies.\n */")
def androidProcessResources: Target[PathRef]

Creates an intermediate R.jar that includes all the resources from the application and its dependencies.

Creates an intermediate R.jar that includes all the resources from the application and its dependencies.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/** ProGuard/R8 rules configuration files for release target (user-provided and generated) */")
def androidProguardReleaseConfigs: Target[Seq[PathRef]]

ProGuard/R8 rules configuration files for release target (user-provided and generated)

ProGuard/R8 rules configuration files for release target (user-provided and generated)

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Name of the key alias in the release keystore. Default is not set.\n */")
def androidReleaseKeyAlias: Target[Option[String]]

Name of the key alias in the release keystore. Default is not set.

Name of the key alias in the release keystore. Default is not set.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Name of the release keystore file. Default is not set.\n */")
def androidReleaseKeyName: Option[String]

Name of the release keystore file. Default is not set.

Name of the release keystore file. Default is not set.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Password for the release key. Default is not set.\n */")
def androidReleaseKeyPass: Target[Option[String]]

Password for the release key. Default is not set.

Password for the release key. Default is not set.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Default os.Path to the keystore file, derived from `androidReleaseKeyName()`.\n * Users can customize the keystore file name to change this path.\n */")
def androidReleaseKeyPath: Target[Seq[PathRef]]

Default os.Path to the keystore file, derived from androidReleaseKeyName(). Users can customize the keystore file name to change this path.

Default os.Path to the keystore file, derived from androidReleaseKeyName(). Users can customize the keystore file name to change this path.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Password for the release keystore. Default is not set.\n */")
def androidReleaseKeyStorePass: Target[Option[String]]

Password for the release keystore. Default is not set.

Password for the release keystore. Default is not set.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * The default release settings with the following settings:\n * - minifyEnabled=true\n * - shrinkEnabled=true\n * - proguardFiles=proguard-android-optimize.txt\n * @return\n */")
def androidReleaseSettings: Target[AndroidBuildTypeSettings]

The default release settings with the following settings:

The default release settings with the following settings:

  • minifyEnabled=true
  • shrinkEnabled=true
  • proguardFiles=proguard-android-optimize.txt

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Compiles Android resources and generates `R.java` and `res.apk`.\n *\n * @return [[(PathRef, Seq[PathRef]]] to the directory with application\'s `R.java` and `res.apk` and a list\n * of the zip files containing the resource compiled files\n *\n * For more details on the aapt2 tool, refer to:\n * [[https://developer.android.com/tools/aapt2 aapt Documentation]]\n */")
def androidResources: Target[(PathRef, Seq[PathRef])]

Compiles Android resources and generates R.java and res.apk.

Compiles Android resources and generates R.java and res.apk.

Attributes

Returns

Seq[PathRef] to the directory with application's R.java and res.apk and a list of the zip files containing the resource compiled files For more details on the aapt2 tool, refer to: aapt Documentation

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Run your application by providing the activity.\n *\n * E.g. `com.package.name.ActivityName`\n *\n * See also [[https://developer.android.com/tools/adb#am]] and [[https://developer.android.com/tools/adb#IntentSpec]]\n * @param activity\n * @return\n */")
def androidRun(activity: String): Command[Vector[String]]

Run your application by providing the activity.

Run your application by providing the activity.

E.g. com.package.name.ActivityName

See also https://developer.android.com/tools/adb#am and https://developer.android.com/tools/adb#IntentSpec

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Generates the command-line arguments required for Android app signing.\n *\n * Uses the release keystore if release build type is set; otherwise, defaults to a generated debug keystore.\n */")
def androidSignKeyDetails: Target[Seq[String]]

Generates the command-line arguments required for Android app signing.

Generates the command-line arguments required for Android app signing.

Uses the release keystore if release build type is set; otherwise, defaults to a generated debug keystore.

Attributes

Inherited from:
AndroidAppModule
def androidTransformAarFiles: Target[Seq[UnpackedDep]]

Attributes

Inherited from:
AndroidAppModule
def androidTransitiveResources: Target[Seq[PathRef]]

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Extracts JAR files and resources from AAR dependencies.\n */")
def androidUnpackArchives: Target[Seq[UnpackedDep]]

Extracts JAR files and resources from AAR dependencies.

Extracts JAR files and resources from AAR dependencies.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Packages DEX files and Android resources into an unsigned APK.\n *\n * @return A `PathRef` to the generated unsigned APK file (`app.unsigned.apk`).\n */")
def androidUnsignedApk: Target[PathRef]

Packages DEX files and Android resources into an unsigned APK.

Packages DEX files and Android resources into an unsigned APK.

Attributes

Returns

A PathRef to the generated unsigned APK file (app.unsigned.apk).

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Version code of the application. Default is 1.\n *\n * See [[https://developer.android.com/studio/publish/versioning]] for more details.\n */")
def androidVersionCode: Target[Int]

Version code of the application. Default is 1.

Version code of the application. Default is 1.

See https://developer.android.com/studio/publish/versioning for more details.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * The version name of the application. Default is \"1.0\".\n *\n * See [[https://developer.android.com/studio/publish/versioning]] for more details.\n */")
def androidVersionName: Target[String]

The version name of the application. Default is "1.0".

The version name of the application. Default is "1.0".

See https://developer.android.com/studio/publish/versioning for more details.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/** The name of the virtual device to be created by [[createAndroidVirtualDevice]] */")
def androidVirtualDeviceIdentifier: String

The name of the virtual device to be created by createAndroidVirtualDevice

The name of the virtual device to be created by createAndroidVirtualDevice

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * The exact id of the artifact to be published. You probably don\'t want to override this.\n * If you want to customize the name of the artifact, override artifactName instead.\n * If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion\n */")
def artifactId: Target[String]

The exact id of the artifact to be published. You probably don't want to override this. If you want to customize the name of the artifact, override artifactName instead. If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion

The exact id of the artifact to be published. You probably don't want to override this. If you want to customize the name of the artifact, override artifactName instead. If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Override this to change the published artifact id.\n * For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz.\n * Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.\n */")
def artifactName: Target[String]

Override this to change the published artifact id. For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz. Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.

Override this to change the published artifact id. For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz. Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.

Attributes

Inherited from:
JavaModule
def artifactNameParts: Target[Seq[String]]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The suffix appended to the artifact IDs during publishing\n */")
def artifactSuffix: Target[String]

The suffix appended to the artifact IDs during publishing

The suffix appended to the artifact IDs during publishing

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Adds \"aar\" to the handled artifact types.\n */")
override def artifactTypes: Target[Set[Type]]

Adds "aar" to the handled artifact types.

Adds "aar" to the handled artifact types.

Attributes

Definition Classes
AndroidModule -> JavaModule
Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * An executable uber-jar/assembly containing all the resources and compiled\n * classfiles from this module and all it\'s upstream modules and dependencies\n */")
def assembly: Target[PathRef]

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

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

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Configuration for the [[assembly]] task: how files and file-conflicts are\n * managed when combining multiple jar files into one big assembly jar.\n */")
def assemblyRules: Seq[Rule]

Configuration for the assembly task: how files and file-conflicts are managed when combining multiple jar files into one big assembly jar.

Configuration for the assembly task: how files and file-conflicts are managed when combining multiple jar files into one big assembly jar.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/** Optional baseline profile for ART rewriting */")
def baselineProfile: Target[Option[PathRef]]

Optional baseline profile for ART rewriting

Optional baseline profile for ART rewriting

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Bind a dependency ([[Dep]]) to the actual module context (e.g. the scala version and the platform suffix)\n * @return The [[BoundDep]]\n */")
def bindDependency: Task[Dep => BoundDep]

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Attributes

Returns

The BoundDep

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * Bill of Material (BOM) dependencies of this module.\n * This is meant to be overridden to add BOM dependencies.\n * To read the value, you should use [[bomModuleDepsChecked]] instead,\n * which uses a cached result which is also checked to be free of cycles.\n * @see [[bomModuleDepsChecked]]\n */")
def bomModuleDeps: Seq[BomModule]

Bill of Material (BOM) dependencies of this module. This is meant to be overridden to add BOM dependencies. To read the value, you should use bomModuleDepsChecked instead, which uses a cached result which is also checked to be free of cycles.

Bill of Material (BOM) dependencies of this module. This is meant to be overridden to add BOM dependencies. To read the value, you should use bomModuleDepsChecked instead, which uses a cached result which is also checked to be free of cycles.

Attributes

See also

bomModuleDepsChecked

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Same as [[bomModuleDeps]] but checked to not contain cycles.\n * Prefer this over using [[bomModuleDeps]] directly.\n */")
final def bomModuleDepsChecked: Seq[BomModule]

Same as bomModuleDeps but checked to not contain cycles. Prefer this over using bomModuleDeps directly.

Same as bomModuleDeps but checked to not contain cycles. Prefer this over using bomModuleDeps directly.

Attributes

Inherited from:
JavaModule
override def bomMvnDeps: Target[Seq[Dep]]

Any Bill of Material (BOM) dependencies you want to add to this Module, in the format mvn"org:name:version"

Any Bill of Material (BOM) dependencies you want to add to this Module, in the format mvn"org:name:version"

Attributes

Definition Classes
JavaTests -> JavaModule
Inherited from:
JavaTests
override def bspBuildTargetData: Task[Option[(String, AnyRef)]]

Use to populate the BuildTarget.{dataKind,data} fields.

Use to populate the BuildTarget.{dataKind,data} fields.

Mill specific implementations:

  • JvmBuildTarget
  • ScalaBuildTarget

Attributes

Definition Classes
JavaModule -> BspModule -> BspModuleApi
Inherited from:
JavaModule
override def bspCompileClasspath: Task[EvaluatorApi => Seq[String]]

Same as compileClasspath, but does not trigger compilation targets, if possible.

Same as compileClasspath, but does not trigger compilation targets, if possible.

Keep in sync with compileClasspath

Attributes

Definition Classes
AndroidAppModule -> JavaModule -> JavaModuleApi
Inherited from:
AndroidAppModule
override def checkGradleModules: Target[Boolean]

Whether to enable Gradle Module support when fetching dependencies

Whether to enable Gradle Module support when fetching dependencies

Attributes

Definition Classes
AndroidModule -> CoursierModule
Inherited from:
AndroidModule
def classgraphWorkerModule: ModuleRef[ClassgraphWorkerModule]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Compiles the current module to generate compiled classfiles/bytecode.\n *\n * When you override this, you probably also want/need to override [[bspCompileClassesPath]],\n * as that needs to point to the same compilation output path.\n *\n * Keep in sync with [[bspCompileClassesPath]]\n */")
def compile: Target[CompilationResult]

Compiles the current module to generate compiled classfiles/bytecode.

Compiles the current module to generate compiled classfiles/bytecode.

When you override this, you probably also want/need to override bspCompileClassesPath, as that needs to point to the same compilation output path.

Keep in sync with bspCompileClassesPath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Replaces AAR files in classpath with their extracted JARs.\n */")
override def compileClasspath: Target[Seq[PathRef]]

Replaces AAR files in classpath with their extracted JARs.

Replaces AAR files in classpath with their extracted JARs.

Attributes

Definition Classes
AndroidAppModule -> JavaModule -> SemanticDbJavaModule
Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * The compile-only direct dependencies of this module. These are *not*\n * transitive, and only take effect in the module that they are declared in.\n */")
def compileModuleDeps: Seq[JavaModule]

The compile-only direct dependencies of this module. These are not transitive, and only take effect in the module that they are declared in.

The compile-only direct dependencies of this module. These are not transitive, and only take effect in the module that they are declared in.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/** Same as [[compileModuleDeps]] but checked to not contain cycles. */")
final def compileModuleDepsChecked: Seq[JavaModule]

Same as compileModuleDeps but checked to not contain cycles.

Same as compileModuleDeps but checked to not contain cycles.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Same as `mvnDeps`, but only present at compile time. Useful for e.g.\n * macro-related dependencies like `scala-reflect` that doesn\'t need to be\n * present at runtime\n */")
def compileMvnDeps: Target[Seq[Dep]]

Same as mvnDeps, 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

Same as mvnDeps, 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

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders where the compile time resource files for this module live.\n * If your resources files do not necessarily need to be seen by the compiler,\n * you should use [[resources]] instead.\n */")
def compileResources: Target[Seq[PathRef]]

The folders where the compile time resource files for this module live. If your resources files do not necessarily need to be seen by the compiler, you should use resources instead.

The folders where the compile time resource files for this module live. If your resources files do not necessarily need to be seen by the compiler, you should use resources instead.

Attributes

Inherited from:
JavaModule
def compiledClassesAndSemanticDbFiles: Target[PathRef]

Attributes

Inherited from:
SemanticDbJavaModule
@Scaladoc(value = "/**\n * Customize the coursier file cache.\n *\n * This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin.\n * Doing so requires adding to coursier\'s classpath. To do this you could use the following:\n * {{{\n * override def coursierCacheCustomizer = Task.Anon {\n * Some( (fc: coursier.cache.FileCache[Task]) =>\n * fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))\n * )\n * }\n * }}}\n * @return\n */")
def coursierCacheCustomizer: Task[Option[FileCache[Task] => FileCache[Task]]]

Customize the coursier file cache.

Customize the coursier file cache.

This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin. Doing so requires adding to coursier's classpath. To do this you could use the following:

 override def coursierCacheCustomizer = Task.Anon {
    Some( (fc: coursier.cache.FileCache[Task]) =>
      fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))
    )
 }

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * The `coursier.Dependency` to use to refer to this module\n */")
def coursierDependency: Dependency

The coursier.Dependency to use to refer to this module

The coursier.Dependency to use to refer to this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The `coursier.Project` corresponding to this `JavaModule`.\n *\n * This provides details about this module to the coursier resolver (details such as\n * dependencies, BOM dependencies, dependency management, etc.). Beyond more general\n * resolution parameters (such as artifact types, etc.), this should be the only way\n * we provide details about this module to coursier.\n */")
def coursierProject: Task[Project]

The coursier.Project corresponding to this JavaModule.

The coursier.Project corresponding to this JavaModule.

This provides details about this module to the coursier resolver (details such as dependencies, BOM dependencies, dependency management, etc.). Beyond more general resolution parameters (such as artifact types, etc.), this should be the only way we provide details about this module to coursier.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Creates the android virtual device identified in virtualDeviceIdentifier\n */")
def createAndroidVirtualDevice(): Command[String]

Creates the android virtual device identified in virtualDeviceIdentifier

Creates the android virtual device identified in virtualDeviceIdentifier

Attributes

Inherited from:
AndroidAppModule
override def defaultCommandName(): String

The name of the default command, which will be automatically executed if the module name is provided at the Mill command line.

The name of the default command, which will be automatically executed if the module name is provided at the Mill command line.

Attributes

Definition Classes
TestModule -> TaskModule
Inherited from:
TestModule
@Scaladoc(value = "/**\n * A `CoursierModule.Resolver` to resolve dependencies.\n *\n * Can be used to resolve external dependencies, if you need to download an external\n * tool from Maven or Ivy repositories, by calling `CoursierModule.Resolver#classpath`.\n *\n * @return `CoursierModule.Resolver` instance\n */")
def defaultResolver: Task[Resolver]

A CoursierModule.Resolver to resolve dependencies.

A CoursierModule.Resolver to resolve dependencies.

Can be used to resolve external dependencies, if you need to download an external tool from Maven or Ivy repositories, by calling CoursierModule.Resolver#classpath.

Attributes

Returns

CoursierModule.Resolver instance

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * Deletes the android device\n */")
def deleteAndroidVirtualDevice: Target[CommandResult]

Deletes the android device

Deletes the android device

Attributes

Inherited from:
AndroidAppModule
override def depManagement: Target[Seq[Dep]]

Dependency management data

Dependency management data

Versions and exclusions in dependency management override those of transitive dependencies, while they have no effect if the corresponding dependency isn't pulled during dependency resolution.

For example, the following forces com.lihaoyi::os-lib to version 0.11.3, and excludes org.slf4j:slf4j-api from com.lihaoyi::cask that it forces to version 0.9.4

 def depManagement = super.depManagement() ++ Seq(
   mvn"com.lihaoyi::os-lib:0.11.3",
   mvn"com.lihaoyi::cask:0.9.5".exclude("org.slf4j", "slf4j-api")
 )

Attributes

Definition Classes
JavaTests -> JavaModule
Inherited from:
JavaTests
@Scaladoc(value = "/**\n * Test classes (often called test suites) discovered by the configured [[testFramework]].\n */")
def discoveredTestClasses: Target[Seq[String]]

Test classes (often called test suites) discovered by the configured testFramework.

Test classes (often called test suites) discovered by the configured testFramework.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * The documentation jar, containing all the Javadoc/Scaladoc HTML files, for\n * publishing to Maven Central\n */")
def docJar: Target[PathRef]

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

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

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Control whether `docJar`-target should use a file to pass command line arguments to the javadoc tool.\n * Defaults to `true` on Windows.\n * Beware: Using an args-file is probably not supported for very old javadoc versions.\n */")
def docJarUseArgsFile: Target[Boolean]

Control whether docJar-target should use a file to pass command line arguments to the javadoc tool. Defaults to true on Windows. Beware: Using an args-file is probably not supported for very old javadoc versions.

Control whether docJar-target should use a file to pass command line arguments to the javadoc tool. Defaults to true on Windows. Beware: Using an args-file is probably not supported for very old javadoc versions.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Extra directories to be copied into the documentation.\n *\n * Typically, includes static files such as html and markdown, but depends\n * on the doc tool that is actually used.\n * @see [[docSources]]\n */")
def docResources: Target[Seq[PathRef]]

Extra directories to be copied into the documentation.

Extra directories to be copied into the documentation.

Typically, includes static files such as html and markdown, but depends on the doc tool that is actually used.

Attributes

See also

docSources

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Directories to be processed by the API documentation tool.\n *\n * Typically, includes the source files to generate documentation from.\n * @see [[docResources]]\n */")
def docSources: Target[Seq[PathRef]]

Directories to be processed by the API documentation tool.

Directories to be processed by the API documentation tool.

Typically, includes the source files to generate documentation from.

Attributes

See also

docResources

Inherited from:
JavaModule
final def extractAarFiles(aarFiles: Seq[Path], taskDest: Path): Seq[UnpackedDep]

Attributes

Inherited from:
AndroidModule
def finalMainClass: Target[String]

Attributes

Inherited from:
RunModule
def finalMainClassOpt: Target[Either[String, String]]

Attributes

Inherited from:
RunModule
@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

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Similar to `forkArgs` but only applies to the `bat` launcher script\n */")
def forkCmdArgs: Target[Seq[String]]

Similar to forkArgs but only applies to the bat launcher script

Similar to forkArgs but only applies to the bat launcher script

Attributes

Inherited from:
AssemblyModule
@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

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Similar to `forkArgs` but only applies to the `sh` launcher script\n */")
def forkShellArgs: Target[Seq[String]]

Similar to forkArgs but only applies to the sh launcher script

Similar to forkArgs but only applies to the sh launcher script

Attributes

Inherited from:
AssemblyModule
def forkWorkingDir: Target[Path]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Combines standard Java source directories with additional sources generated by\n * the Android resource generation step.\n */")
override def generatedSources: Target[Seq[PathRef]]

Combines standard Java source directories with additional sources generated by the Android resource generation step.

Combines standard Java source directories with additional sources generated by the Android resource generation step.

Attributes

Definition Classes
AndroidAppModule -> JavaModule
Inherited from:
AndroidAppModule
def getTestEnvironmentVars(args: String*): Command[(String, String, String, Seq[String])]

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * JavaModule and its derivatives define inner test modules.\n * To avoid unexpected misbehavior due to the use of the wrong inner test trait\n * we apply some hierarchy consistency checks.\n * If, for some reason, those are too restrictive to you, you can override this method.\n * @throws MillException\n */")
protected def hierarchyChecks(): Unit

JavaModule and its derivatives define inner test modules. To avoid unexpected misbehavior due to the use of the wrong inner test trait we apply some hierarchy consistency checks. If, for some reason, those are too restrictive to you, you can override this method.

JavaModule and its derivatives define inner test modules. To avoid unexpected misbehavior due to the use of the wrong inner test trait we apply some hierarchy consistency checks. If, for some reason, those are too restrictive to you, you can override this method.

Attributes

Inherited from:
JavaTests
def ideaCompileOutput: Target[PathRef]

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * Contribute components to idea config files.\n */")
def ideaConfigFiles(ideaConfigVersion: Int): Task[Seq[IdeaConfigFile]]

Contribute components to idea config files.

Contribute components to idea config files.

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * Contribute facets to the Java module configuration.\n * @param ideaConfigVersion The IDEA configuration version in use. Probably `4`.\n * @return\n */")
def ideaJavaModuleFacets(ideaConfigVersion: Int): Task[Seq[JavaFacet]]

Contribute facets to the Java module configuration.

Contribute facets to the Java module configuration.

Value parameters

ideaConfigVersion

The IDEA configuration version in use. Probably 4.

Attributes

Inherited from:
GenIdeaModule
def intellijModulePath: Path

Attributes

Inherited from:
GenIdeaModule
def intellijModulePathJava: Path

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * The repository that knows about this project itself and its module dependencies\n */")
def internalDependenciesRepository: Task[Repository]

The repository that knows about this project itself and its module dependencies

The repository that knows about this project itself and its module dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * A jar containing only this module\'s resources and compiled classfiles,\n * without those from upstream modules and dependencies\n */")
def jar: Target[PathRef]

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

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

Attributes

Inherited from:
JavaModule
override def javacOptions: Target[Seq[String]]

Options to pass to the java compiler

Options to pass to the java compiler

Attributes

Definition Classes
JavaTests -> JavaModule -> SemanticDbJavaModule
Inherited from:
JavaTests
@Scaladoc(value = "/**\n * Additional options to be used by the javadoc tool.\n * You should not set the `-d` setting for specifying the target directory,\n * as that is done in the [[docJar]] target.\n */")
def javadocOptions: Target[Seq[String]]

Additional options to be used by the javadoc tool. You should not set the -d setting for specifying the target directory, as that is done in the docJar target.

Additional options to be used by the javadoc tool. You should not set the -d setting for specifying the target directory, as that is done in the docJar target.

Attributes

Inherited from:
JavaModule
override def jvmWorker: ModuleRef[JvmWorkerModule]

Attributes

Definition Classes
JavaTests -> JavaModule -> SemanticDbJavaModule -> WithJvmWorker
Inherited from:
JavaTests
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

Inherited from:
JavaModule
@Scaladoc(value = "/** Additional library classes provided */")
def libraryClassesPaths: Target[Seq[PathRef]]

Additional library classes provided

Additional library classes provided

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * The *output* classfiles/resources from this module, used for execution,\n * excluding upstream modules and third-party dependencies, but including unmanaged dependencies.\n *\n * This is build from [[localCompileClasspath]] and [[localRunClasspath]]\n * as the parts available \"before compilation\" and \"after compilation\".\n *\n * Keep in sync with [[bspLocalClasspath]]\n */")
def localClasspath: Target[Seq[PathRef]]

The output classfiles/resources from this module, used for execution, excluding upstream modules and third-party dependencies, but including unmanaged dependencies.

The output classfiles/resources from this module, used for execution, excluding upstream modules and third-party dependencies, but including unmanaged dependencies.

This is build from localCompileClasspath and localRunClasspath as the parts available "before compilation" and "after compilation".

Keep in sync with bspLocalClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The *input* classfiles/resources from this module, used during compilation,\n * excluding upstream modules and third-party dependencies\n */")
def localCompileClasspath: Target[Seq[PathRef]]

The input classfiles/resources from this module, used during compilation, excluding upstream modules and third-party dependencies

The input classfiles/resources from this module, used during compilation, excluding upstream modules and third-party dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The part of the [[localClasspath]] which is available \"after compilation\".\n *\n * Keep in sync with [[bspLocalRunClasspath]]\n */")
override def localRunClasspath: Target[Seq[PathRef]]

The part of the localClasspath which is available "after compilation".

The part of the localClasspath which is available "after compilation".

Keep in sync with bspLocalRunClasspath

Attributes

Definition Classes
JavaModule -> RunModule
Inherited from:
JavaModule
@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

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Returns the path to the main-dex list file, which explicitly lists the classes\n * to be included in the primary DEX file. Currently, this is not defined.\n */")
def mainDexList: Target[Option[PathRef]]

Returns the path to the main-dex list file, which explicitly lists the classes to be included in the primary DEX file. Currently, this is not defined.

Returns the path to the main-dex list file, which explicitly lists the classes to be included in the primary DEX file. Currently, this is not defined.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Provides the output path for the generated main-dex list file, which is used\n * during the DEX generation process.\n */")
def mainDexListOutput: Target[Option[PathRef]]

Provides the output path for the generated main-dex list file, which is used during the DEX generation process.

Provides the output path for the generated main-dex list file, which is used during the DEX generation process.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Specifies the path to the main-dex rules file, which contains ProGuard rules\n * for determining which classes should be included in the primary DEX file.\n */")
def mainDexRules: Target[Option[PathRef]]

Specifies the path to the main-dex rules file, which contains ProGuard rules for determining which classes should be included in the primary DEX file.

Specifies the path to the main-dex rules file, which contains ProGuard rules for determining which classes should be included in the primary DEX file.

Attributes

Inherited from:
AndroidModule
@Scaladoc(value = "/**\n * Additional options for the java compiler derived from other module settings.\n */")
def mandatoryJavacOptions: Target[Seq[String]]

Additional options for the java compiler derived from other module settings.

Additional options for the java compiler derived from other module settings.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Mandatory ivy dependencies that are typically always required and shouldn\'t be removed by\n * overriding [[mvnDeps]], e.g. the scala-library in the [[ScalaModule]].\n */")
def mandatoryMvnDeps: Target[Seq[Dep]]

Mandatory ivy dependencies that are typically always required and shouldn't be removed by overriding mvnDeps, e.g. the scala-library in the ScalaModule.

Mandatory ivy dependencies that are typically always required and shouldn't be removed by overriding mvnDeps, e.g. the scala-library in the ScalaModule.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Creates a manifest representation which can be modified or replaced\n * The default implementation just adds the `Manifest-Version`, `Main-Class` and `Created-By` attributes\n */")
def manifest: Target[JarManifest]

Creates a manifest representation which can be modified or replaced The default implementation just adds the Manifest-Version, Main-Class and Created-By attributes

Creates a manifest representation which can be modified or replaced The default implementation just adds the Manifest-Version, Main-Class and Created-By attributes

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Classpath for the manifest merger run.\n */")
def manifestMergerClasspath: Target[Seq[PathRef]]

Classpath for the manifest merger run.

Classpath for the manifest merger run.

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Map dependencies before resolving them.\n * Override this to customize the set of dependencies.\n */")
def mapDependencies: Task[Dependency => Dependency]

Map dependencies before resolving them. Override this to customize the set of dependencies.

Map dependencies before resolving them. Override this to customize the set of dependencies.

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * A [[CoursierModule.Resolver]] to resolve dependencies.\n *\n * Unlike [[defaultResolver]], this resolver can resolve Mill modules too\n * (obtained via [[JavaModule.coursierDependency]]).\n *\n * @return `CoursierModule.Resolver` instance\n */")
def millResolver: Task[Resolver]

A CoursierModule.Resolver to resolve dependencies.

A CoursierModule.Resolver to resolve dependencies.

Unlike defaultResolver, this resolver can resolve Mill modules too (obtained via JavaModule.coursierDependency).

Attributes

Returns

CoursierModule.Resolver instance

Inherited from:
CoursierModule
def moduleCtx: ModuleCtx

Attributes

Inherited from:
BaseClass
override def moduleDeps: Seq[JavaModule]

The direct dependencies of this module. This is meant to be overridden to add dependencies. To read the value, you should use moduleDepsChecked instead, which uses a cached result which is also checked to be free of cycle.

The direct dependencies of this module. This is meant to be overridden to add dependencies. To read the value, you should use moduleDepsChecked instead, which uses a cached result which is also checked to be free of cycle.

Attributes

See also

moduleDepschecked

Definition Classes
JavaTests -> JavaModule
Inherited from:
JavaTests
@Scaladoc(value = "/**\n * Same as [[moduleDeps]] but checked to not contain cycles.\n * Prefer this over using [[moduleDeps]] directly.\n */")
final def moduleDepsChecked: Seq[JavaModule]

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Attributes

Inherited from:
JavaModule
def moduleDirJava: Path

Attributes

Inherited from:
Module
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
def moduleSegments: Segments

Attributes

Inherited from:
Module
@Scaladoc(value = "/**\n * Any ivy dependencies you want to add to this Module, in the format\n * mvn\"org::name:version\" for Scala dependencies or mvn\"org:name:version\"\n * for Java dependencies\n */")
def mvnDeps: Target[Seq[Dep]]

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

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

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Command to print the transitive dependency tree to STDOUT.\n */")
def mvnDepsTree(args: MvnDepsTreeArgs): Command[Unit]

Command to print the transitive dependency tree to STDOUT.

Command to print the transitive dependency tree to STDOUT.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * What platform suffix to use for publishing, e.g. `_sjs` for Scala.js\n * projects\n */")
def platformSuffix: Target[String]

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

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

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * @param all If `true` fetches also source dependencies\n */")
override def prepareOffline(all: Flag): Command[Seq[PathRef]]

Value parameters

all

If true fetches also source dependencies

Attributes

Definition Classes
JavaModule -> OfflineSupportModule
Inherited from:
JavaModule
@Scaladoc(value = "/**\n * What shell script to use to launch the executable generated by `assembly`.\n * Defaults to a generic \"universal\" launcher that should work for Windows,\n * OS-X and Linux\n */")
def prependShellScript: Target[String]

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

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

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/** The direct and indirect dependencies of this module */")
def recursiveModuleDeps: Seq[JavaModule]

The direct and indirect dependencies of this module

The direct and indirect dependencies of this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/** The direct and indirect runtime module dependencies of this module */")
def recursiveRunModuleDeps: Seq[JavaModule]

The direct and indirect runtime module dependencies of this module

The direct and indirect runtime module dependencies of this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The repositories used to resolve dependencies with [[classpath()]].\n *\n * See [[allRepositories]] if you need to resolve Mill internal modules.\n */")
def repositories: Target[Seq[String]]

The repositories used to resolve dependencies with classpath().

The repositories used to resolve dependencies with classpath().

See allRepositories if you need to resolve Mill internal modules.

Attributes

Inherited from:
CoursierModule
override def repositoriesTask: Task[Seq[Repository]]

The repositories used to resolve dependencies with classpath().

The repositories used to resolve dependencies with classpath().

See allRepositories if you need to resolve Mill internal modules.

Attributes

Definition Classes
JavaTests -> CoursierModule
Inherited from:
JavaTests
def resFolder: Target[PathRef]

Attributes

Inherited from:
AndroidAppModule
override def resolutionCustomizer: Task[Option[Resolution => Resolution]]

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

   override def resolutionCustomizer = Task.Anon {
     Some( (r: coursier.core.Resolution) =>
       r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))
     )
   }

Attributes

Definition Classes
JavaTests -> CoursierModule
Inherited from:
JavaTests
override def resolutionParams: Task[ResolutionParams]

Resolution parameters, allowing to customize resolution internals

Resolution parameters, allowing to customize resolution internals

This rarely needs to be changed. This allows to disable the new way coursier handles BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:

 def resolutionParams = super.resolutionParams()
   .withEnableDependencyOverrides(Some(false))

Note that versions forced with Dep#forceVersion() take over forced versions manually set in resolutionParams. The former should be favored to force versions in dependency resolution.

The Scala version set via ScalaModule#scalaVersion also takes over any Scala version provided via ResolutionParams#scalaVersionOpt.

The default configuration set in ResolutionParams#defaultConfiguration is ignored when Mill fetches dependencies to be passed to the compiler (equivalent to Maven "compile scope"). In that case, it forces the default configuration to be "compile". On the other hand, when fetching dependencies for runtime (equivalent to Maven "runtime scope"), the value in ResolutionParams#defaultConfiguration is used.

Attributes

Definition Classes
AndroidModule -> CoursierModule
Inherited from:
AndroidModule
def resolvePublishDependency: Task[Dep => Dependency]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Build the assembly for third-party dependencies separate from the current\n * classpath\n *\n * This should allow much faster assembly creation in the common case where\n * third-party dependencies do not change\n */")
def resolvedIvyAssembly: Target[Assembly]

Build the assembly for third-party dependencies separate from the current classpath

Build the assembly for third-party dependencies separate from the current classpath

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

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Resolved dependencies\n */")
def resolvedMvnDeps: Target[Seq[PathRef]]

Resolved dependencies

Resolved dependencies

Attributes

Inherited from:
JavaModule
override def resolvedRunMvnDeps: Target[Seq[PathRef]]

Attributes

Definition Classes
AndroidAppModule -> JavaModule
Inherited from:
AndroidAppModule
@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

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Runs this module\'s code in a background process, until it dies or\n * `runBackground` is used again. This lets you continue using Mill while\n * the process is running in the background: editing files, compiling, and\n * only re-starting the background process when you\'re ready.\n *\n * You can also use `-w foo.runBackground` to make Mill watch for changes\n * and automatically recompile your code & restart the background process\n * when ready. This is useful when working on long-running server processes\n * that would otherwise run forever\n */")
def runBackground(args: String*): Command[Unit]

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.

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

Attributes

Inherited from:
RunModule
@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

Inherited from:
RunModule
def runBackgroundRestartDelayMillis: Target[Int]

Attributes

Inherited from:
RunModule
def runBackgroundTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * All classfiles and resources from upstream modules and dependencies\n * necessary to run this module\'s code after compilation\n */")
override def runClasspath: Target[Seq[PathRef]]

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

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

Attributes

Definition Classes
JavaModule -> RunModule
Inherited from:
JavaModule
@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

Inherited from:
RunModule
@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

Inherited from:
RunModule
def runLocalTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Inherited from:
RunModule
@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

Inherited from:
RunModule
@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

Inherited from:
RunModule
@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

Inherited from:
RunModule
@Scaladoc(value = "/**\n * The runtime-only direct dependencies of this module. These *are* transitive,\n * and so get propagated to downstream modules automatically\n */")
def runModuleDeps: Seq[JavaModule]

The runtime-only direct dependencies of this module. These are transitive, and so get propagated to downstream modules automatically

The runtime-only direct dependencies of this module. These are transitive, and so get propagated to downstream modules automatically

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Same as [[moduleDeps]] but checked to not contain cycles.\n * Prefer this over using [[moduleDeps]] directly.\n */")
final def runModuleDepsChecked: Seq[JavaModule]

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Additional dependencies, only present at runtime. Useful for e.g.\n * selecting different versions of a dependency to use at runtime after your\n * code has already been compiled.\n */")
def runMvnDeps: Target[Seq[Dep]]

Additional dependencies, 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.

Additional dependencies, 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.

Attributes

Inherited from:
JavaModule
override 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

Definition Classes
JavaTests -> RunModule
Inherited from:
JavaTests
def runner: Task[Runner]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Returns the emulator identifier for created from startAndroidEmulator\n * by iterating the adb device list\n */")
def runningEmulator: Target[String]

Returns the emulator identifier for created from startAndroidEmulator by iterating the adb device list

Returns the emulator identifier for created from startAndroidEmulator by iterating the adb device list

Attributes

Inherited from:
AndroidAppModule
def sanitizeUri(uri: PathRef): String

Attributes

Inherited from:
JavaModule
def sanitizeUri(uri: Path): String

Attributes

Inherited from:
JavaModule
def sanitizeUri(uri: String): String

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Installs the user specified system image for the emulator\n * using sdkmanager . E.g. \"system-images;android-35;google_apis_playstore;x86_64\"\n */")
def sdkInstallSystemImage(): Command[String]

Installs the user specified system image for the emulator using sdkmanager . E.g. "system-images;android-35;google_apis_playstore;x86_64"

Installs the user specified system image for the emulator using sdkmanager . E.g. "system-images;android-35;google_apis_playstore;x86_64"

Attributes

Inherited from:
AndroidAppModule
def semanticDbData: Target[PathRef]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbJavaVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbScalaVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
@Scaladoc(value = "/**\n * Show the module dependencies.\n * @param recursive If `true` include all recursive module dependencies, else only show direct dependencies.\n */")
def showModuleDeps(recursive: Boolean): Command[Unit]

Show the module dependencies.

Show the module dependencies.

Value parameters

recursive

If true include all recursive module dependencies, else only show direct dependencies.

Attributes

Inherited from:
JavaModule
override def skipIdea: Boolean

Skip Idea project file generation.

Skip Idea project file generation.

Attributes

Definition Classes
JavaTests -> JavaModuleApi -> GenIdeaModule
Inherited from:
JavaTests
@Scaladoc(value = "/**\n * The source jar, containing only source code for publishing to Maven Central\n */")
def sourceJar: Target[PathRef]

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

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

Attributes

Inherited from:
JavaModule
override def sourcesFolders: Seq[SubPath]

Attributes

Definition Classes
JavaTests -> JavaModule
Inherited from:
JavaTests
@Scaladoc(value = "/**\n * Starts the android emulator and waits until it is booted\n *\n * @return The log line that indicates the emulator is ready\n */")
def startAndroidEmulator(): Command[String]

Starts the android emulator and waits until it is booted

Starts the android emulator and waits until it is booted

Attributes

Returns

The log line that indicates the emulator is ready

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Stops the android emulator\n */")
def stopAndroidEmulator: Target[String]

Stops the android emulator

Stops the android emulator

Attributes

Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Discovers and runs the module\'s tests in a subprocess, reporting the\n * results to the console.\n * If no input has changed since the last run, no test were executed.\n *\n * @see [[testForked()]]\n */")
def testCached: Target[(String, Seq[TestResult])]

Discovers and runs the module's tests in a subprocess, reporting the results to the console. If no input has changed since the last run, no test were executed.

Discovers and runs the module's tests in a subprocess, reporting the results to the console. If no input has changed since the last run, no test were executed.

Attributes

See also

testForked

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Args to be used by [[testCached]].\n */")
def testCachedArgs: Target[Seq[String]]

Args to be used by testCached.

Args to be used by testCached.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * The classpath containing the tests. This is most likely the output of the compilation target.\n * By default, this uses the result of [[localRunClasspath]], which is most likely the result of a local compilation.\n */")
def testClasspath: Target[Seq[PathRef]]

The classpath containing the tests. This is most likely the output of the compilation target. By default, this uses the result of localRunClasspath, which is most likely the result of a local compilation.

The classpath containing the tests. This is most likely the output of the compilation target. By default, this uses the result of localRunClasspath, which is most likely the result of a local compilation.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * How the test classes in this module will be split.\n * Test classes from different groups are ensured to never\n * run on the same JVM process, and therefore can be run in parallel.\n * When used in combination with [[testParallelism]],\n * every JVM test running process will guarantee to never claim tests\n * from different test groups.\n */")
def testForkGrouping: Target[Seq[Seq[String]]]

How the test classes in this module will be split. Test classes from different groups are ensured to never run on the same JVM process, and therefore can be run in parallel. When used in combination with testParallelism, every JVM test running process will guarantee to never claim tests from different test groups.

How the test classes in this module will be split. Test classes from different groups are ensured to never run on the same JVM process, and therefore can be run in parallel. When used in combination with testParallelism, every JVM test running process will guarantee to never claim tests from different test groups.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Discovers and runs the module\'s tests in a subprocess, reporting the\n * results to the console.\n * @see [[testCached]]\n */")
def testForked(args: String*): Command[(String, Seq[TestResult])]

Discovers and runs the module's tests in a subprocess, reporting the results to the console.

Discovers and runs the module's tests in a subprocess, reporting the results to the console.

Attributes

See also

testCached

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Discovers and runs the module\'s tests in-process in an isolated classloader,\n * reporting the results to the console\n */")
def testLocal(args: String*): Command[(String, Seq[TestResult])]

Discovers and runs the module's tests in-process in an isolated classloader, reporting the results to the console

Discovers and runs the module's tests in-process in an isolated classloader, reporting the results to the console

Attributes

Inherited from:
TestModule
def testLogLevel: Target[LogLevel]

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Discovers and runs the module\'s tests in a subprocess, reporting the\n * results to the console.\n * Arguments before \"--\" will be used as wildcard selector to select\n * test classes, arguments after \"--\" will be passed as regular arguments.\n * `testOnly *foo foobar bar* -- arguments` will test only classes with name\n * (includes package name) 1. end with \"foo\", 2. exactly \"foobar\", 3. start\n * with \"bar\", with \"arguments\" as arguments passing to test framework.\n */")
def testOnly(args: String*): Command[(String, Seq[TestResult])]

Discovers and runs the module's tests in a subprocess, reporting the results to the console. Arguments before "--" will be used as wildcard selector to select test classes, arguments after "--" will be passed as regular arguments. testOnly *foo foobar bar* -- arguments will test only classes with name (includes package name) 1. end with "foo", 2. exactly "foobar", 3. start with "bar", with "arguments" as arguments passing to test framework.

Discovers and runs the module's tests in a subprocess, reporting the results to the console. Arguments before "--" will be used as wildcard selector to select test classes, arguments after "--" will be passed as regular arguments. testOnly *foo foobar bar* -- arguments will test only classes with name (includes package name) 1. end with "foo", 2. exactly "foobar", 3. start with "bar", with "arguments" as arguments passing to test framework.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Whether to use the test parallelism to run tests in multiple JVM processes.\n * When used in combination with [[testForkGrouping]], every JVM test running process\n * will guarantee to never claim tests from different test groups.\n */")
def testParallelism: Target[Boolean]

Whether to use the test parallelism to run tests in multiple JVM processes. When used in combination with testForkGrouping, every JVM test running process will guarantee to never claim tests from different test groups.

Whether to use the test parallelism to run tests in multiple JVM processes. When used in combination with testForkGrouping, every JVM test running process will guarantee to never claim tests from different test groups.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Sets the file name for the generated JUnit-compatible test report.\n * If None is set, no file will be generated.\n */")
def testReportXml: Target[Option[String]]

Sets the file name for the generated JUnit-compatible test report. If None is set, no file will be generated.

Sets the file name for the generated JUnit-compatible test report. If None is set, no file will be generated.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Whether to use the test task destination folder as the working directory\n * when running tests. `true` means test subprocess run in the `.dest/sandbox` folder of\n * the test task, providing better isolation and encouragement of best practices\n * (e.g. not reading/writing stuff randomly from the project source tree). `false`\n * means the test subprocess runs in the project root folder, providing weaker\n * isolation.\n */")
def testSandboxWorkingDir: Target[Boolean]

Whether to use the test task destination folder as the working directory when running tests. true means test subprocess run in the .dest/sandbox folder of the test task, providing better isolation and encouragement of best practices (e.g. not reading/writing stuff randomly from the project source tree). false means the test subprocess runs in the project root folder, providing weaker isolation.

Whether to use the test task destination folder as the working directory when running tests. true means test subprocess run in the .dest/sandbox folder of the test task, providing better isolation and encouragement of best practices (e.g. not reading/writing stuff randomly from the project source tree). false means the test subprocess runs in the project root folder, providing weaker isolation.

Attributes

Inherited from:
TestModule
@Scaladoc(value = "/**\n * Controls whether the TestRunner should receive its arguments via an args-file instead of a long parameter list.\n * Defaults to what `runUseArgsFile` return.\n */")
def testUseArgsFile: Target[Boolean]

Controls whether the TestRunner should receive its arguments via an args-file instead of a long parameter list. Defaults to what runUseArgsFile return.

Controls whether the TestRunner should receive its arguments via an args-file instead of a long parameter list. Defaults to what runUseArgsFile return.

Attributes

Inherited from:
TestModule
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
@Scaladoc(value = "/**\n * The transitive version of `compileClasspath`\n */")
def transitiveCompileClasspath: Target[Seq[PathRef]]

The transitive version of compileClasspath

The transitive version of compileClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Coursier project of this module and those of all its transitive module dependencies\n */")
def transitiveCoursierProjects: Task[Seq[Project]]

Coursier project of this module and those of all its transitive module dependencies

Coursier project of this module and those of all its transitive module dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Almost the same as [[transitiveLocalClasspath]], but using the [[jar]]s instead of [[localClasspath]].\n */")
def transitiveJars: Target[Seq[PathRef]]

Almost the same as transitiveLocalClasspath, but using the jars instead of localClasspath.

Almost the same as transitiveLocalClasspath, but using the jars instead of localClasspath.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The transitive version of `localClasspath`\n */")
def transitiveLocalClasspath: Target[Seq[PathRef]]

The transitive version of localClasspath

The transitive version of localClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All direct and indirect module dependencies of this module, including\n * compile-only dependencies: basically the modules whose classpath are needed\n * at compile-time.\n *\n * Note that `compileModuleDeps` are defined to be non-transitive, so we only\n * look at the direct `compileModuleDeps` when assembling this list\n */")
def transitiveModuleCompileModuleDeps: Seq[JavaModule]

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at compile-time.

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at compile-time.

Note that compileModuleDeps are defined to be non-transitive, so we only look at the direct compileModuleDeps when assembling this list

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Like `recursiveModuleDeps` but also include the module itself,\n * basically the modules whose classpath are needed at runtime\n */")
def transitiveModuleDeps: Seq[JavaModule]

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All direct and indirect module dependencies of this module, including\n * compile-only dependencies: basically the modules whose classpath are needed\n * at runtime.\n *\n * Note that `runModuleDeps` are defined to be transitive\n */")
def transitiveModuleRunModuleDeps: Seq[JavaModule]

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at runtime.

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at runtime.

Note that runModuleDeps are defined to be transitive

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Like `recursiveModuleDeps` but also include the module itself,\n * basically the modules whose classpath are needed at runtime\n */")
def transitiveRunModuleDeps: Seq[JavaModule]

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Adds the Android SDK JAR file to the classpath during the compilation process.\n */")
override def unmanagedClasspath: Target[Seq[PathRef]]

Adds the Android SDK JAR file to the classpath during the compilation process.

Adds the Android SDK JAR file to the classpath during the compilation process.

Attributes

Definition Classes
AndroidAppModule -> JavaModule
Inherited from:
AndroidAppModule
@Scaladoc(value = "/**\n * Build the assembly for upstream dependencies separate from the current\n * classpath\n *\n * This should allow much faster assembly creation in the common case where\n * upstream dependencies do not change\n */")
def upstreamAssembly: Target[Assembly]

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

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * All upstream classfiles and resources necessary to build and executable\n * assembly, but without this module\'s contribution\n */")
def upstreamAssemblyClasspath: Target[Seq[PathRef]]

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

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

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The upstream compilation output of all this module\'s upstream modules\n */")
def upstreamCompileOutput: Target[Seq[CompilationResult]]

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

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

Attributes

Inherited from:
JavaModule
def upstreamIvyAssemblyClasspath: Target[Seq[PathRef]]

Upstream classfiles and resources from third-party libraries necessary to build an executable assembly

Upstream classfiles and resources from third-party libraries necessary to build an executable assembly

Attributes

Inherited from:
JavaModule
def upstreamLocalAssemblyClasspath: Target[Seq[PathRef]]

Upstream classfiles and resources from locally-built modules necessary to build an executable assembly, but without this module's contribution

Upstream classfiles and resources from locally-built modules necessary to build an executable assembly, but without this module's contribution

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Files extensions that need to be managed by Zinc together with class files.\n * This means, if zinc needs to remove a class file, it will also remove files\n * which match the class file basename and a listed file extension.\n */")
def zincAuxiliaryClassFileExtensions: Target[Seq[String]]

Files extensions that need to be managed by Zinc together with class files. This means, if zinc needs to remove a class file, it will also remove files which match the class file basename and a listed file extension.

Files extensions that need to be managed by Zinc together with class files. This means, if zinc needs to remove a class file, it will also remove files which match the class file basename and a listed file extension.

Attributes

Inherited from:
JavaModule
def zincIncrementalCompilation: Target[Boolean]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * If `true`, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation.\n * When `false`, we report only problems for files which we re-compiled.\n */")
def zincReportCachedProblems: Target[Boolean]

If true, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation. When false, we report only problems for files which we re-compiled.

If true, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation. When false, we report only problems for files which we re-compiled.

Attributes

Inherited from:
JavaModule

Inherited and Abstract methods

@Scaladoc(value = "/**\n * The test framework to use to discover and run run tests.\n *\n * For convenience, you can also mix-in one of these predefined traits:\n * - [[TestModule.Junit4]]\n * - [[TestModule.Junit5]]\n * - [[TestModule.Munit]]\n * - [[TestModule.ScalaTest]]\n * - [[TestModule.Specs2]]\n * - [[TestModule.TestNg]]\n * - [[TestModule.Utest]]\n * - [[TestModule.Weaver]]\n * - [[TestModule.ZioTest]]\n *\n * Most of these provide additional `xxxVersion` tasks, to manage the test framework dependencies for you.\n */")
def testFramework: Target[String]

The test framework to use to discover and run run tests.

The test framework to use to discover and run run tests.

For convenience, you can also mix-in one of these predefined traits:

  • TestModule.Junit4
  • TestModule.Junit5
  • TestModule.Munit
  • TestModule.ScalaTest
  • TestModule.Specs2
  • TestModule.TestNg
  • TestModule.Utest
  • TestModule.Weaver
  • TestModule.ZioTest

Most of these provide additional xxxVersion tasks, to manage the test framework dependencies for you.

Attributes

Inherited from:
TestModule

Inherited fields

protected val debugKeyAlias: String

Attributes

Inherited from:
AndroidAppModule
protected val debugKeyPass: String

Attributes

Inherited from:
AndroidAppModule
protected val debugKeyStorePass: String

Attributes

Inherited from:
AndroidAppModule
val mainDexPlatformRules: Seq[String]

Attributes

Inherited from:
AndroidModule

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Generated with