Packages

final case class PlanCheckConfig[Roles <: String, ExcludeActivations <: String, Config <: String, CheckConfig <: Boolean, PrintBindings <: Boolean, OnlyWarn <: Boolean](roles: Roles, excludeActivations: ExcludeActivations, config: Config, checkConfig: CheckConfig, printBindings: PrintBindings, onlyWarn: OnlyWarn) extends Product with Serializable

Options to alter the behavior of izumi.distage.framework.PlanCheck

roles

"*" to check all roles, "role1 role2" to check specific roles, "* -role1 -role2" to check all roles _except_ specific roles.

excludeActivations

"repo:dummy" to ignore missing implementations or other issues in repo:dummy axis choice. "repo:dummy | scene:managed" to ignore missing implementations or other issues in repo:dummy axis choice and in scene:managed axis choice. "repo:dummy mode:test | scene:managed" to ignore missing implementations or other issues in repo:dummy mode:test activation and in scene:managed activation. This will ignore parts of the graph accessible through these activations and larger activations that include them. That is, anything involving scene:managed or the combination of both repo:dummy mode:test will not be checked. but activations repo:prod mode:test scene:provided and repo:dummy mode:prod scene:provided are not excluded and will be checked. Allows the check to pass even if some axis choices or combinations of choices are (wilfully) left invalid, e.g. if you do have repo:prod components, but no counterpart repo:dummy components, and don't want to add them, then you may exclude "repo:dummy" from being checked.

config

Config resource file name, e.g. "application.conf" or "*" if using the same config settings as roleAppMain

checkConfig

Try to parse config file checking all the config bindings added using izumi.distage.config.ConfigModuleDef. Default: true

printBindings

Print all the bindings loaded from plugins when a problem is found during plan checking. Default: false

onlyWarn

Do not abort compilation when errors are found, just print a warning instead. Does not affect plan checks performed at runtime. Default: false

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlanCheckConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PlanCheckConfig(roles: Roles, excludeActivations: ExcludeActivations, config: Config, checkConfig: CheckConfig, printBindings: PrintBindings, onlyWarn: OnlyWarn)

    roles

    "*" to check all roles, "role1 role2" to check specific roles, "* -role1 -role2" to check all roles _except_ specific roles.

    excludeActivations

    "repo:dummy" to ignore missing implementations or other issues in repo:dummy axis choice. "repo:dummy | scene:managed" to ignore missing implementations or other issues in repo:dummy axis choice and in scene:managed axis choice. "repo:dummy mode:test | scene:managed" to ignore missing implementations or other issues in repo:dummy mode:test activation and in scene:managed activation. This will ignore parts of the graph accessible through these activations and larger activations that include them. That is, anything involving scene:managed or the combination of both repo:dummy mode:test will not be checked. but activations repo:prod mode:test scene:provided and repo:dummy mode:prod scene:provided are not excluded and will be checked. Allows the check to pass even if some axis choices or combinations of choices are (wilfully) left invalid, e.g. if you do have repo:prod components, but no counterpart repo:dummy components, and don't want to add them, then you may exclude "repo:dummy" from being checked.

    config

    Config resource file name, e.g. "application.conf" or "*" if using the same config settings as roleAppMain

    checkConfig

    Try to parse config file checking all the config bindings added using izumi.distage.config.ConfigModuleDef. Default: true

    printBindings

    Print all the bindings loaded from plugins when a problem is found during plan checking. Default: false

    onlyWarn

    Do not abort compilation when errors are found, just print a warning instead. Does not affect plan checks performed at runtime. Default: false

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val checkConfig: CheckConfig
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val config: Config
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val excludeActivations: ExcludeActivations
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val onlyWarn: OnlyWarn
  16. val printBindings: PrintBindings
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val roles: Roles
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped