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 inrepo:dummy
axis choice and inscene:managed
axis choice. "repo:dummy mode:test | scene:managed" to ignore missing implementations or other issues inrepo:dummy mode:test
activation and inscene:managed
activation. This will ignore parts of the graph accessible through these activations and larger activations that include them. That is, anything involvingscene:managed
or the combination of bothrepo:dummy mode:test
will not be checked. but activationsrepo:prod mode:test scene:provided
andrepo: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 haverepo:prod
components, but no counterpartrepo: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
- Alphabetic
- By Inheritance
- PlanCheckConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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 inrepo:dummy
axis choice and inscene:managed
axis choice. "repo:dummy mode:test | scene:managed" to ignore missing implementations or other issues inrepo:dummy mode:test
activation and inscene:managed
activation. This will ignore parts of the graph accessible through these activations and larger activations that include them. That is, anything involvingscene:managed
or the combination of bothrepo:dummy mode:test
will not be checked. but activationsrepo:prod mode:test scene:provided
andrepo: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 haverepo:prod
components, but no counterpartrepo: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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checkConfig: CheckConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val config: Config
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val excludeActivations: ExcludeActivations
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val onlyWarn: OnlyWarn
- val printBindings: PrintBindings
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val roles: Roles
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()