Diagnostics

Diagnostics in a KtFile

To collect diagnostics for an entire file, use collectDiagnostics():

analyze(ktFile) {
    val diagnostics = ktFile
        .collectDiagnostics(KaDiagnosticCheckerFilter.ONLY_COMMON_CHECKERS)
        .filterIsInstance<KaFirDiagnostic.WrongAnnotationTarget>()
}

The KaDiagnosticCheckerFilter enum allows you to control which kinds of diagnostics are included:

• ONLY_COMMON_CHECKERS: Includes diagnostics only from the compiler checkers.

• ONLY_EXTENDED_CHECKERS: Includes diagnostics from extended checkers (that typically run only in the IDE).

• EXTENDED_AND_COMMON_CHECKERS: Includes diagnostics from both common and extended checkers.

Diagnostics on an element

note

Experimental API. Subject to changes.

To get diagnostics for a specific element, use diagnostics:

analyze(ktElement) {
    val diagnostics = ktElement
        .diagnostics(KaDiagnosticCheckerFilter.ONLY_COMMON_CHECKERS)
}

Note that the returned list of diagnostics does not include diagnostics for nested KtElements.

KtDiagnosticWithPsi

collectDiagnostics and diagnostics return a collection of KtDiagnosticWithPsi instances. This interface provides access to information about the diagnostic.