Spell Check/com.darkrockstudios.texteditor.spellcheck.diagnostics/TextDiagnosticsChecker

TextDiagnosticsChecker

fun interface TextDiagnosticsChecker(source)

Finds issues other than spelling, such as grammar, in lines of text.

Functions

abstract suspend fun check(lines: List<String>): List<List<LineDiagnostic>>

The issues in each of lines, in the same order. A line is one of the editor's lines, a paragraph, without its line break. Called only for lines whose text it has not seen, so it should judge each line on its own. It must not throw: it runs inside the editor's effects.

checkText

open suspend fun checkText(lines: List<String>): List<List<LineDiagnostic>>?

The issues that depend on more than their own line, such as a word used again a line later: one list per line of lines, the whole text. Called with every line, blank ones included, each time the text is checked, so it should be quick. Null, as by default, when the checker has no such issues to find. It must not throw either.