common-plugin/dev.akif.tapik.plugin

Package-level declarations

Types

Inspects bytecode or reflective type information to extract Tapik HTTP endpoint signatures.

class GenerateTask(config: GenerateTaskConfiguration, log: (String, Throwable?) -> Unit, logDebug: (String, Throwable?) -> Unit, logWarn: (String, Throwable?) -> Unit)

A task that generates client code from tapik endpoint definitions.

GenerateTaskConfiguration

data class GenerateTaskConfiguration(val outputDirectory: File, val generatedSourcesDirectory: File, val endpointPackages: List<String>, val compiledClassesDirectory: File, val additionalClasspathDirectories: List<File>, val enabledGeneratorIds: Set<String>)

Configuration for the GenerateTask.

HttpEndpointSignature

data class HttpEndpointSignature(val name: String, val packageName: String, val file: String, val path: TypeMetadata, val parameters: TypeMetadata, val input: InputSignature, val outputs: TypeMetadata, val imports: List<String>, val rawType: String, val ownerInternalName: String, val methodName: String)

Captures the essential metadata derived from inspecting a Tapik HTTP endpoint declaration.

InputSignature

data class InputSignature(val type: TypeMetadata, val headers: TypeMetadata, val body: TypeMetadata)

Captures the input type information of an HTTP endpoint.

MarkdownDocumentationGenerator

class MarkdownDocumentationGenerator : TapikGenerator

A generator that creates Markdown documentation from tapik endpoint definitions.

TapikGenerator

interface TapikGenerator

Contract implemented by Tapik code generators loaded at runtime.

TapikGeneratorContext

data class TapikGeneratorContext(val outputDirectory: File, val generatedSourcesDirectory: File, val log: (String) -> Unit, val logDebug: (String) -> Unit, val logWarn: (String, Throwable?) -> Unit)

Carries directories and logging utilities that Tapik generators rely on.

Functions

collectSimpleNames

fun TypeMetadata.collectSimpleNames(): Set<String>

Collects the simple names of the receiver type and all of its nested generic arguments.

determineBodyValueType

fun TypeMetadata.determineBodyValueType(): String

Determines a Kotlin type that represents the payload carried by Tapik body metadata.

escapeForAnnotation

fun String.escapeForAnnotation(): String

Escapes quotes and path separators so that the string can be safely embedded inside annotation arguments.

escapeForKdoc

fun String.escapeForKdoc(): String

Escapes terminator sequences that would prematurely end a KDoc block.

linesForDocumentation

fun linesForDocumentation(text: String?): List<String>

Splits and trims multi-line documentation text into individual lines suitable for KDoc rendering.

render

fun TypeMetadata.render(): String

Renders the receiver type as a Kotlin type literal, including generics and nullability information.

renderIdentifier

fun renderIdentifier(name: String): String

Quotes Kotlin keywords and other unsafe symbols to produce a valid identifier.

sanitizeIdentifier

fun sanitizeIdentifier(rawName: String?, fallback: String): String

Sanitises an arbitrary identifier so that it is safe to use as a Kotlin name.

simpleName

fun TypeMetadata.simpleName(): String

Resolves the simple, unqualified name of the receiver type.

uniqueName

fun uniqueName(base: String, used: MutableSet<String>): String

Generates a unique identifier by applying numeric suffixes until an unused variant is discovered.