Packages

object PalantirFormatModule extends ExternalModule with PalantirFormatBaseModule with TaskModule

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PalantirFormatModule
  2. TaskModule
  3. PalantirFormatBaseModule
  4. CoursierModule
  5. ExternalModule
  6. BaseModule
  7. BaseModule0
  8. Module
  9. BaseClass
  10. Cacher
  11. Cacher
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class Interp extends AnyRef
    Definition Classes
    BaseModule0

Value Members

  1. object millInternal 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

    Definition Classes
    Module
    Annotations
    @internal()
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def bindDependency: define.Task[(scalalib.Dep) => scalalib.BoundDep]

    Bind a dependency (Dep) to the actual module context (e.g.

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

    returns

    The BoundDep

    Definition Classes
    CoursierModule
  7. def cachedTarget[T](t: => T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher → Cacher
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def coursierCacheCustomizer: define.Task[Option[(FileCache[coursier.util.Task]) => FileCache[coursier.util.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))
       )
    }
    Definition Classes
    CoursierModule
  10. 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.

    Definition Classes
    PalantirFormatModuleTaskModule
  11. def defaultResolver: define.Task[Resolver]
    Definition Classes
    CoursierModule
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. val evalWatchedValues: Buffer[Watchable]
    Attributes
    protected[mill]
    Definition Classes
    BaseModule0
  15. def formatAll(check: Flag = mainargs.Flag(value = false), sources: Tasks[Seq[api.PathRef]] = Tasks.resolveMainDefault("__.sources")): Command[Unit]

    Formats Java source files.

    Formats Java source files.

    check

    if an exception should be raised when formatting errors are found

    • when set, files are not formatted
    sources

    list of JavaModule sources to process

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def mapDependencies: define.Task[(Dependency) => Dependency]

    Map dependencies before resolving them.

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

    Definition Classes
    CoursierModule
  20. lazy val millDiscover: Discover
    Definition Classes
    PalantirFormatModuleBaseModuleBaseModule0
  21. implicit def millDiscoverImplicit: Discover
    Definition Classes
    ExternalModule
  22. implicit def millImplicitBaseModule: Implicit
    Definition Classes
    BaseModule
  23. implicit def millModuleBasePath: BasePath
    Definition Classes
    BaseModuleModule
  24. def millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  25. implicit def millModuleExternal: External
    Definition Classes
    Module
  26. implicit def millModuleSegments: Segments
    Definition Classes
    ExternalModuleBaseModuleModule
  27. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  28. def millOuterCtx: Ctx
    Definition Classes
    BaseClass
  29. def millSourcePath: Path
    Definition Classes
    BaseModuleModule
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. def palantirformatClasspath: T[api.Loose.Agg[api.PathRef]]

    Classpath for running Palantir Java Format.

    Classpath for running Palantir Java Format.

    Definition Classes
    PalantirFormatBaseModule
  34. def palantirformatJvmArgs: T[Seq[String]]

    JVM arguments for running Palantir Java Format.

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

    Definition Classes
    PalantirFormatBaseModule
  35. def palantirformatOptions: T[api.PathRef]

    Path to options file for Palantir Java Format CLI at T.workspace / palantirformat.options.

    Path to options file for Palantir Java Format CLI at T.workspace / palantirformat.options.

    Definition Classes
    PalantirFormatModulePalantirFormatBaseModule
  36. def palantirformatVersion: T[String]

    Palantir Java Format version.

    Palantir Java Format version. Defaults to 2.50.0.

    Definition Classes
    PalantirFormatBaseModule
  37. def repositoriesTask: define.Task[Seq[Repository]]

    The repositories used to resolved dependencies with resolveDeps().

    The repositories used to resolved dependencies with resolveDeps().

    Definition Classes
    CoursierModule
  38. def resolutionCustomizer: define.Task[Option[(Resolution) => Resolution]]

    Customize the coursier resolution process.

    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))
      )
    }
    Definition Classes
    CoursierModule
  39. def resolutionParams: define.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.

    Definition Classes
    CoursierModule
  40. def resolveDeps(deps: define.Task[Agg[scalalib.BoundDep]], sources: Boolean = false, artifactTypes: Option[Set[Type]] = None): define.Task[Agg[api.PathRef]]

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

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

    deps

    The dependencies to resolve.

    sources

    If true, resolve source dependencies instead of binary dependencies (JARs).

    artifactTypes

    If non-empty, pull the passed artifact types rather than the default ones from coursier

    returns

    The PathRefs to the resolved files.

    Definition Classes
    CoursierModule
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. val watchedValues: Buffer[Watchable]
    Attributes
    protected[mill]
    Definition Classes
    BaseModule0

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def resolveCoursierDependency: define.Task[(scalalib.Dep) => Dependency]
    Definition Classes
    CoursierModule
    Annotations
    @deprecated
    Deprecated

    (Since version Mill after 0.11.0-M0) To be replaced by bindDependency

  3. def resolveDeps(deps: define.Task[Agg[scalalib.BoundDep]], sources: Boolean): define.Task[Agg[api.PathRef]]
    Definition Classes
    CoursierModule
    Annotations
    @deprecated
    Deprecated

    (Since version Mill after 0.12.0-RC3) Use the override accepting artifactTypes

Inherited from define.TaskModule

Inherited from ExternalModule

Inherited from BaseModule

Inherited from BaseModule0

Inherited from define.Module

Inherited from BaseClass

Inherited from Cacher

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped