kconfig-core/club.skidware.kconfig.annotation

Package-level declarations

Types

annotation class Comment(val lines: String, val placement: CommentPlacement = CommentPlacement.ABOVE)

Marks a configuration field with a descriptive comment that will be written into the YAML output.

Determines the position of a Comment relative to its associated configuration field in the serialized YAML output.

annotation class Env(val variable: String)

Binds a configuration field to an environment variable, allowing its value to be overridden at runtime without modifying the YAML file.

Defines how a Secret-annotated field value is masked when displayed in logs or debug output.

annotation class MigrateFrom(val oldKeys: String)

Specifies one or more legacy YAML keys that should be migrated to the annotated field when loading a configuration file.

annotation class Pattern(val regex: String, val description: String = "")

Validates that a string configuration field matches the given regular expression.

annotation class Range(val min: Double, val max: Double)

Constrains a numeric configuration field to an inclusive range between min and max.

annotation class Secret(val mask: MaskStrategy = MaskStrategy.FULL, val visibleChars: Int = 4)

Marks a configuration field as sensitive, ensuring its value is masked in logs, debug output, and serialized representations.

annotation class Transient

Excludes a configuration field from serialization and deserialization.