sqldelight-check-api/dev.s7a.sqldelight.check.api

Package-level declarations

Types

class DatabaseContext(val name: String, val dialect: SqlDialect)

Lightweight SQLDelight database context visible to rules and reporters.

class Diagnostic(val ruleId: QualifiedRuleId, val severity: Severity, val message: String, val file: SourceFile?, val range: SourceRange?, val database: DatabaseContext?, val fixes: List<Fix> = emptyList())

Diagnostic resolved by the engine and passed to reporters.

DialectCapability

class DialectCapability(val id: String)

Dialect capability identifier used by rules to check feature support without depending on artifact names.

DialectFamily

enum DialectFamily : Enum<DialectFamily>

Database family for known SQLDelight dialects.

Enablement

enum Enablement : Enum<Enablement>

User-facing enablement state for rules and rule sets.

Fix

class Fix(val title: String, val safety: FixSafety, val edits: List<TextEdit>)

A fix proposed by a rule diagnostic.

FixSafety

enum FixSafety : Enum<FixSafety>

Safety classification for a write operation proposed by a rule or formatter.

InternalSqldelightCheckApi

@RequiresOptIn(message = "This API is public for sqldelight-check internals and may change without source compatibility.", level = RequiresOptIn.Level.ERROR)

annotation class InternalSqldelightCheckApi

Marks API that is public only for sqldelight-check module boundaries.

LogLevel

enum LogLevel : Enum<LogLevel>

Controls how much execution detail sqldelight-check should emit.

QualifiedRuleId

class QualifiedRuleId(val ruleSetId: RuleSetId, val ruleId: RuleId)

Identifies a rule after combining a rule set ID and a rule-local ID.

RuleDiagnostic

class RuleDiagnostic(val severity: Severity, val message: String, val file: SourceFile?, val range: SourceRange?, val database: DatabaseContext?, val fixes: List<Fix> = emptyList())

Diagnostic emitted by a rule before the engine attaches the containing rule set.

RuleId

@JvmInline

value class RuleId(val value: String)

Identifies a rule within its containing rule set.

RuleSetId

@JvmInline

value class RuleSetId(val value: String)

Identifies a rule set such as standard, sqlite, or a third-party provider ID.

Severity

enum Severity : Enum<Severity>

Severity assigned to a diagnostic after rule defaults and user configuration are resolved.

SourceFile

class SourceFile(val path: String, val content: String)

Source file known to sqldelight-check.

SourceFileKind

enum SourceFileKind : Enum<SourceFileKind>

SQLDelight source file kind inferred from the file extension.

SourcePosition

class SourcePosition(val line: Int, val column: Int)

One-based source position for diagnostics and edits.

SourceRange

class SourceRange(val start: SourcePosition, val end: SourcePosition)

Source range in a file.

SqlDialect

class SqlDialect(val family: DialectFamily, val capabilities: Set<DialectCapability> = emptySet(), val sourceKeywords: SqlDialectSourceKeywords = SqlDialectSourceKeywords.SourceScannerDefault)

Rule-relevant SQL dialect metadata for a SQLDelight database.

SqlDialectCoordinate

class SqlDialectCoordinate(val group: String, val module: String, val version: String?)

Gradle module coordinate for a SQLDelight dialect artifact.

SqlDialectProvider

fun interface SqlDialectProvider

Resolves rule-relevant dialect metadata for a SQLDelight dialect artifact.

SqlDialectSourceKeywords

class SqlDialectSourceKeywords(val aliasBoundaryKeywords: Set<String> = SourceScannerDefault.aliasBoundaryKeywords, val tableReferenceBoundaryKeywords: Set<String> = SourceScannerDefault.tableReferenceBoundaryKeywords, val joinModifierKeywords: Set<String> = SourceScannerDefault.joinModifierKeywords)

Dialect-specific keyword groups used by the conservative source scanner.

TextEdit

class TextEdit(val range: SourceRange, val replacement: String)

Text edit represented as a replacement over a source range.