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

RegexRule

abstract class RegexRule(ruleName: String, pattern: String, message: String, val defaultSeverity: Severity = Severity.Warning, val defaultEnable: Boolean = true, val targetCapability: DialectCapability? = null, hashLineComments: Boolean = false) : Rule

Base implementation for rules that report regular expression matches in masked SQL source text.

Comments and quoted text are replaced with spaces before matching, so diagnostic ranges still point at the original source offsets.

Constructors

constructor(ruleName: String, pattern: String, message: String, defaultSeverity: Severity = Severity.Warning, defaultEnable: Boolean = true, targetCapability: DialectCapability? = null, hashLineComments: Boolean = false)

Properties

open override val defaultEnable: Boolean

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

defaultEnablement

val Rule.defaultEnablement: Enablement

Default enablement derived from Rule.defaultEnable.

defaultSeverity

open override val defaultSeverity: Severity

Default severity used when user configuration does not override it.

open override val id: RuleId

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

targetCapability

open override val targetCapability: DialectCapability?

Dialect capability required when this rule is resolved with Auto.

Functions

open fun isApplicable(context: RuleContext): Boolean

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

open override fun run(context: RuleContext, reporter: DiagnosticReporter)

Runs this rule against the current context.