Hello! I created custom Ktlint rule which works perfectly, but sometimes I want to suppress it. I tr...

# ktlint

[Filip Lastic]

Hello! I created custom Ktlint rule which works perfectly, but sometimes I want to suppress it. I tried // ktlint-disable my-custom-rule and also

/* ktlint-disable my-custom-rule */
...this should not fail
/* ktlint-enable my-custom-rule */

But it does not work. Please, is there any way how to suppress my custom rule?

Thank you!

[Filip Lastic]

it works with // ktlint-disable but I am not sure if it is correct usage 🙂

[romtsn]

file an issue? both should work actually, that's likely a bug

[Filip Lastic]

My custom rule:

class NoExposedTransactionImportRule : Rule("no-exposed-transaction-import") {
    override fun visit(
        node: ASTNode,
        autoCorrect: Boolean,
        emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
    ) {
        if (node.elementType == KtStubElementTypes.IMPORT_DIRECTIVE) {
            val importDirective = node.psi as KtImportDirective
            val path = importDirective.importPath?.pathStr
            if (path?.equals("org.jetbrains.exposed.sql.transactions.transaction") == true) {
                emit(node.startOffset, "Importing exposed transaction: '$path'. You should use exposedTransactionWrapper instead", false)
            }
        }
    }
}

RulesetProvider:

class CustomRuleSetProvider : RuleSetProvider {
    override fun get() = RuleSet("custom-ktlint-rules", NoExposedTransactionImportRule())
}

Usage in `build.gradle`:

dependencies {

        ktlintRuleset project(":custom-ktlint-rules")
    }

    ktlint {
        disabledRules = ['import-ordering', 'no-wildcard-imports', 'no-semi'] // some of globally disabled rules
    }

[Filip Lastic]

I also tried to use // ktlint-disable custom-ktlint-rules but ktlintCheck still fails.

[Sha Sha Chu]

@Filip Lastic you need to prefix it with the ruleset name - so custom-ktlint-rules:my-custom-rule

[Filip Lastic]

Eh thank you!! I knew that I am doing something wrong 🙂