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

Package-level declarations

Types

DiagnosticReporter

fun interface DiagnosticReporter

Receives diagnostics emitted by a rule.

Rule

interface Rule

Lint or formatting rule contributed by a rule set.

RuleContext

interface RuleContext

Stable analysis view exposed to custom rules.

RuleDeprecation

class RuleDeprecation(val message: String, val replacement: QualifiedRuleId? = null)

Deprecation metadata for a rule that remains available for explicit users.

RuleProvider

fun interface RuleProvider

Creates fresh rule instances for thread-safe analysis.

RuleSetProvider

interface RuleSetProvider

Provides a named collection of rules.

SqlFacts

class SqlFacts(val statements: List<SqlStatementFacts> = emptyList())

Stable SQL structure facts exposed to custom rules.

SqlJoinFacts

class SqlJoinFacts(val range: SourceRange, val kind: String, val table: SqlTableReferenceFacts)

Stable facts for a JOIN clause.

SqlQualifiedReferenceFacts

class SqlQualifiedReferenceFacts(val range: SourceRange, val qualifier: String, val name: String)

Stable facts for a qualified reference such as table.column.

SqlResultColumnFacts

class SqlResultColumnFacts(val range: SourceRange, val alias: String? = null, val wildcard: Boolean = false)

Stable facts for a SELECT result column.

SqlSelectFacts

class SqlSelectFacts(val selectListRange: SourceRange, val resultColumns: List<SqlResultColumnFacts>)

Stable facts for a SELECT statement.

SqlStatementFacts

class SqlStatementFacts(val kind: SqlStatementKind, val range: SourceRange, val select: SqlSelectFacts? = null, val tableReferences: List<SqlTableReferenceFacts> = emptyList(), val joins: List<SqlJoinFacts> = emptyList(), val qualifiedReferences: List<SqlQualifiedReferenceFacts> = emptyList())

Stable facts for one top-level SQL statement.

SqlStatementKind

enum SqlStatementKind : Enum<SqlStatementKind>

Coarse statement kinds used by parser-backed rules.

SqlTableReferenceFacts

class SqlTableReferenceFacts(val range: SourceRange, val name: String? = null, val alias: String? = null, val subquery: Boolean = false)

Stable facts for a table or derived-table reference.

SqlToken

class SqlToken(val text: String, val startOffset: Int, val endOffset: Int)

SQL-like source token outside comments and quoted text.

SqlTokenMatch

class SqlTokenMatch(val startToken: SqlToken, val endToken: SqlToken)

A matched range in a SQL token list.

Properties

defaultEnablement

val Rule.defaultEnablement: Enablement

Default enablement derived from Rule.defaultEnable.

Functions

booleanOption

fun Map<String, String>.booleanOption(name: String, defaultValue: Boolean): Boolean

Reads a strict boolean option from rule configuration.

commaSeparatedOption

fun Map<String, String>.commaSeparatedOption(name: String): List<String>

Reads a comma-separated string list from rule configuration.

containsSourcePattern

fun List<SqlToken>.containsSourcePattern(role: SqlDialectSourcePatternRole, sourcePatterns: SqlDialectSourcePatterns): Boolean

Returns true when a source pattern match for role exists.

findSourcePattern

fun List<SqlToken>.findSourcePattern(role: SqlDialectSourcePatternRole, sourcePatterns: SqlDialectSourcePatterns): SqlTokenMatch?

Returns the first source pattern match for role.

findSourcePatternsInOrder

fun List<SqlToken>.findSourcePatternsInOrder(sourcePatterns: SqlDialectSourcePatterns, vararg roles: SqlDialectSourcePatternRole): SqlTokenMatch?

Returns the first ordered sequence of source pattern matches.

isKeyword

fun SqlToken.isKeyword(value: String): Boolean

Returns true when this token matches value ignoring case.

maskSqlCommentsAndQuotedText

fun String.maskSqlCommentsAndQuotedText(hashLineComments: Boolean = false): String

Replaces comments and quoted text with spaces while preserving offsets.

positionAt

fun String.positionAt(offset: Int): SourcePosition

Converts a source offset into a 1-based line/column position.

positiveIntOption

fun Map<String, String>.positiveIntOption(name: String, defaultValue: Int): Int

Reads a positive integer option from rule configuration.

rangeAtOffsets

fun String.rangeAtOffsets(startOffset: Int, endOffset: Int): SourceRange

Converts source offsets into a 1-based line/column range.

reportSqlStatementMatches

fun Rule.reportSqlStatementMatches(context: RuleContext, reporter: DiagnosticReporter, message: String, hashLineComments: Boolean = false, findMatch: (statement: List<SqlToken>) -> SqlTokenMatch?)

Tokenizes the current file and reports matches found per statement.

reportSqlTokenMatch

fun Rule.reportSqlTokenMatch(context: RuleContext, reporter: DiagnosticReporter, message: String, match: SqlTokenMatch)

Reports a diagnostic for match using this rule's default severity.

sqlStatements

fun List<SqlToken>.sqlStatements(): List<List<SqlToken>>

Splits a token stream into statements at semicolon tokens.

sqlTokens

fun String.sqlTokens(hashLineComments: Boolean = false): Sequence<SqlToken>

Tokenizes SQL-like identifiers, numbers, and semicolons outside comments and quoted text.