Rule

interface Rule

Lint or formatting rule contributed by a rule set.

Rule implementations are loaded through a RuleSetProvider and run after SQLDelight accepts the source file.

Properties

Whether this rule can run by default before user configuration and auto applicability are resolved.

Default severity used when user configuration does not override it.

Deprecation metadata when this rule is kept only for compatibility.

abstract val id: RuleId

Rule-local ID, such as no-select-star.

Typed options supported by this rule.

Dialect ID required when this rule is resolved with Auto.

Returns whether this rule applies to the current context when enablement is Auto.

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.

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

abstract fun run(context: RuleContext, reporter: DiagnosticReporter)

Runs this rule against the current context.