Generated with

Mill/mill/mill.javalib/mill.javalib.palantirformat/PalantirFormatBaseModule

PalantirFormatBaseModule

mill.javalib.palantirformat.PalantirFormatBaseModule

trait PalantirFormatBaseModule extends CoursierModule

Attributes

Source: PalantirFormatBaseModule.scala
Graph
Supertypes: trait CoursierModule

trait Module

trait Wrapper

class BaseClass

trait Cacher

trait Cacher

class Object

trait Matchable

class Any
Show all
Known subtypes: trait PalantirFormatModule

object PalantirFormatModule

Members list

Type members

Inherited classlikes

@Scaladoc(value = "/**\n * Miscellaneous machinery around traversing & querying the build hierarchy,\n * that should not be needed by normal users of Mill\n */")

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Attributes

Inherited from:: Module
Source: Module.scala
Supertypes: class Internal

class Object

trait Matchable

class Any

Value members

Concrete methods

@Scaladoc(value = "/**\n * Classpath for running Palantir Java Format.\n */")

Classpath for running Palantir Java Format.

Attributes

Source: PalantirFormatBaseModule.scala

@Scaladoc(value = "/**\n * JVM arguments for running Palantir Java Format. Defaults to values prescribed in\n * \"[[https://github.com/palantir/palantir-java-format/issues/548 Broken on Java 16]]\".\n */")

JVM arguments for running Palantir Java Format. Defaults to values prescribed in "Broken on Java 16".

Attributes

Source: PalantirFormatBaseModule.scala

@Scaladoc(value = "/**\n * Path to options file for Palantir Java Format CLI. Defaults to `millSourcePath` `/` `palantirformat.options`.\n */")

Path to options file for Palantir Java Format CLI. Defaults to millSourcePath / palantirformat.options.

Attributes

Source: PalantirFormatBaseModule.scala

@Scaladoc(value = "/**\n * Palantir Java Format version. Defaults to the version used when Mill was built.\n */")

Palantir Java Format version. Defaults to the version used when Mill was built.

Attributes

Source: PalantirFormatBaseModule.scala

Inherited methods

@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 */")

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
Source: CoursierModule.scala

@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 */")

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
Source: CoursierModule.scala

Attributes

Inherited from:: CoursierModule
Source: CoursierModule.scala

@Scaladoc(value = "/**\n * Mill internal repositories to be used during dependency resolution\n *\n * These are not meant to be modified by Mill users, unless you really know what you\'re\n * doing.\n */")

Mill internal repositories to be used during dependency resolution

These are not meant to be modified by Mill users, unless you really know what you're doing.

Attributes

Inherited from:: CoursierModule
Source: CoursierModule.scala

@Scaladoc(value = "/**\n * Map dependencies before resolving them.\n * Override this to customize the set of dependencies.\n */")

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

Attributes

Inherited from:: CoursierModule
Source: CoursierModule.scala

Attributes

Inherited from:: BaseClass
Source: Module.scala

Attributes

Inherited from:: Module
Source: Module.scala

Attributes

Inherited from:: Module
Source: Module.scala

Attributes

Inherited from:: Module
Source: Module.scala

@Scaladoc(value = "/**\n * The repositories used to resolved dependencies with [[resolveDeps()]].\n */")

The repositories used to resolved dependencies with resolveDeps.

Attributes

Inherited from:: CoursierModule
Source: CoursierModule.scala

@Scaladoc(value = "/**\n * Customize the coursier resolution process.\n * This is rarely needed to changed, as the default try to provide a\n * highly reproducible resolution process. But sometime, you need\n * more control, e.g. you want to add some OS or JDK specific resolution properties\n * which are sometimes used by Maven and therefore found in dependency artifact metadata.\n * For example, the JavaFX artifacts are known to use OS specific properties.\n * To fix resolution for JavaFX, you could override this task like the following:\n * {{{\n * override def resolutionCustomizer = Task.Anon {\n * Some( (r: coursier.core.Resolution) =>\n * r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))\n * )\n * }\n * }}}\n * @return\n */")

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

Inherited from:: CoursierModule
Source: CoursierModule.scala

@Scaladoc(value = "/**\n * Resolution parameters, allowing to customize resolution internals\n *\n * This rarely needs to be changed. This allows to disable the new way coursier handles\n * BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:\n * {{{\n * def resolutionParams = super.resolutionParams()\n * .withEnableDependencyOverrides(Some(false))\n * }}}\n *\n * Note that versions forced with `Dep#forceVersion()` take over forced versions manually\n * set in `resolutionParams`. The former should be favored to force versions in dependency\n * resolution.\n *\n * The Scala version set via `ScalaModule#scalaVersion` also takes over any Scala version\n * provided via `ResolutionParams#scalaVersionOpt`.\n *\n * The default configuration set in `ResolutionParams#defaultConfiguration` is ignored when\n * Mill fetches dependencies to be passed to the compiler (equivalent to Maven \"compile scope\").\n * In that case, it forces the default configuration to be \"compile\". On the other hand, when\n * fetching dependencies for runtime (equivalent to Maven \"runtime scope\"), the value in\n * `ResolutionParams#defaultConfiguration` is used.\n */")

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

Inherited from:: CoursierModule
Source: CoursierModule.scala

@Scaladoc(value = "/**\n * Task that resolves the given dependencies using the repositories defined with [[repositoriesTask]].\n *\n * @param deps The dependencies to resolve.\n * @param sources If `true`, resolve source dependencies instead of binary dependencies (JARs).\n * @param artifactTypes If non-empty, pull the passed artifact types rather than the default ones from coursier\n * @return The [[PathRef]]s to the resolved files.\n */")

Task that resolves the given dependencies using the repositories defined with repositoriesTask.

Value parameters

artifactTypes: If non-empty, pull the passed artifact types rather than the default ones from coursier
deps: The dependencies to resolve.
sources: If true, resolve source dependencies instead of binary dependencies (JARs).

Attributes

Returns: The PathRefs to the resolved files.
Inherited from:: CoursierModule
Source: CoursierModule.scala

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.
Definition Classes: Module -> Any
Inherited from:: Module
Source: Module.scala

Implicits

Inherited implicits

Attributes

Inherited from:: Module
Source: Module.scala

In this article

Generated with