kotlinx-schema-ksp-gradle-plugin/kotlinx.schema.ksp.gradle.plugin/KotlinxSchemaExtension

KotlinxSchemaExtension

abstract class KotlinxSchemaExtension @Inject constructor(source)

Extension for configuring the Kotlinx Schema Gradle plugin.

Example usage:

kotlinxSchema {
    enabled.set(true)
    rootPackage.set("com.example.models")
    withSchemaObject.set(true)
}

Constructors

KotlinxSchemaExtension

@Inject

constructor()

Properties

enabled

abstract val enabled: Property<Boolean>

Whether schema generation is enabled. Default: true

exclude

abstract val exclude: Property<String>

Comma- or semicolon-separated glob patterns of fully qualified names to exclude from schema generation. Applies to both classes and functions. Exclusions are applied after include; a symbol matching any exclude pattern is always skipped.

include

abstract val include: Property<String>

Comma- or semicolon-separated glob patterns of fully qualified names to include in schema generation. Applies to both classes and functions. If not set, all symbols within rootPackage are included.

rootPackage

abstract val rootPackage: Property<String>

Optional root package to limit processing to. If set, only classes in this package (or its subpackages) will be processed by KSP. If not set, all packages are processed.

visibility

abstract val visibility: Property<String>

Configures the visibility of schema extension functions/properties generated by the Kotlinx Schema Gradle plugin. This property determines the modifier (e.g., "public", "internal") applied to the generated schema-related APIs.

withSchemaObject

abstract val withSchemaObject: Property<Boolean>

Whether to generate the jsonSchema JsonObject property in addition to jsonSchemaString. When enabled, both extension properties are generated: