PlanCheck

izumi.distage.framework.PlanCheck$
object PlanCheck

API for performing compile-time and runtime checks of correctness for distage applications.

The easiest way to add compile-time safety to your application is to add an object inheriting PlanCheck.Main in test scope of the same module where you define your Role Launcher

Attributes

See also:
Example:
 import izumi.distage.framework.PlanCheck
 import com.example.myapp.MainLauncher
 object WiringCheck extends PlanCheck.Main(MainLauncher)

This object will emit compile-time errors for any issues or omissions in your ModuleDefs

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

open class Main[AppMain <: CheckableApp, Cfg <: Any](app: AppMain, cfg: Cfg)(implicit val planCheck: PlanCheckMaterializer[AppMain, Cfg])

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PlanCheck[Cfg]
object runtime

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
runtime.type

Value members

Concrete methods

def assertAppCompileTime[AppMain <: CheckableApp, Cfg <: Any](app: AppMain, cfg: Cfg)(implicit planCheckResult: PlanCheckMaterializer[AppMain, Cfg]): PlanCheckMaterializer[AppMain, Cfg]

Concrete fields

final val defaultCheckConfig: Boolean
final val defaultOnlyWarn: Boolean
final val defaultPrintBindings: Boolean