PlanCheckConfig

izumi.distage.framework.PlanCheckConfig
See thePlanCheckConfig companion object
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)

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

Attributes

checkConfig

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

config

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

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.

onlyWarn

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

printBindings

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

roles

"" to check all roles, "role1 role2" to check specific roles, " -role1 -role2" to check all roles except specific roles.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product