Detekt Custom Rules

Incorrect usage can result in SQL injection. To detect such cases, we provide custom Detekt rules.

How to use

First, please add it as a dependency in detektPlugin.

dependencies {
    detektPlugins("dev.hsbrysk.kuery-client:kuery-client-detekt:{{version}}")
}

Next, please add the following to the detekt configuration YAML. (Unfortunately, custom rules do not work unless they are explicitly enabled.)

kuery-client:
  UseStringLiteral:
    active: true

After that, by running the detektMain task, you can check for any violations.

# Please run the detektMain task, as type resolution is being used.
# ref: https://detekt.dev/docs/gettingstarted/type-resolution/
./gradlew detektMain

Rules

UseStringLiteralRule

By providing a Kotlin compiler plugin, we are customizing the behavior of string interpolation. However, this customization is only applied to SqlBuilder#add and SqlBuilder#unaryPlus(+).

Therefore, if incorrectly written as follows, problems may arise.

Noncompliant Code:

kueryClient.sql {
    // BAD !!
    val sql = "SELECT * FROM user WHERE id = $id"
    +sql
}

Compliant Code:

kueryClient.sql {
    +"SELECT * FROM user WHERE id = $id"
}