lint/com.monkopedia.kodemirror.lint

Package-level declarations

Types

data class Action(val name: String, val apply: (EditorSession) -> Unit)

A quick-fix action that can be applied to resolve a diagnostic.

data class Diagnostic(val from: DocPos, val to: DocPos, val severity: Severity, val message: String, val source: String? = null, val actions: List<Action> = emptyList())

A diagnostic message attached to a range in the document.

data class LintConfig(val delay: Long = 750, val markerFilter: (diagnostics: List<Diagnostic>) -> List<Diagnostic>? = null, val tooltipFilter: (diagnostics: List<Diagnostic>) -> List<Diagnostic>? = null, val autoPanel: Boolean = false)

Configuration for the linter.

LintGutterConfig

data class LintGutterConfig(val hoverTime: Long = 300, val markerFilter: (diagnostics: List<Diagnostic>) -> List<Diagnostic>? = null, val tooltipFilter: (diagnostics: List<Diagnostic>) -> List<Diagnostic>? = null)

Configuration for the lint gutter.

typealias LintSource = (EditorSession) -> List<Diagnostic>

A lint source function that produces diagnostics for the current editor state.

enum Severity : Enum<Severity>

Severity levels for diagnostics.

SuspendLintSource

typealias SuspendLintSource = suspend (EditorSession) -> List<Diagnostic>

A suspend lint source function for asynchronous linting.

Properties

val closeLintPanel: (EditorSession) -> Boolean

Close the lint diagnostics panel.

val lintErrorColor: ThemeKey<Color>

Theme color for error-level diagnostics.

val lintHintColor: ThemeKey<Color>

Theme color for hint-level diagnostics.

val lintInfoColor: ThemeKey<Color>

Theme color for info-level diagnostics.

val lintKeymap: List<KeyBinding>

Default lint keymap bindings.

lintSourceColor

val lintSourceColor: ThemeKey<Color>

Theme color for the diagnostic source label in the lint panel.

lintWarningColor

val lintWarningColor: ThemeKey<Color>

Theme color for warning-level diagnostics.

val nextDiagnostic: (EditorSession) -> Boolean

Jump to the next diagnostic after the cursor.

val openLintPanel: (EditorSession) -> Boolean

Open the lint diagnostics panel.

previousDiagnostic

val previousDiagnostic: (EditorSession) -> Boolean

Jump to the previous diagnostic before the cursor.

setDiagnosticsEffect

val setDiagnosticsEffect: StateEffectType<List<Diagnostic>>

Effect used to update the set of diagnostics.

Functions

diagnosticCount

fun diagnosticCount(state: EditorState): Int

Get the total number of diagnostics in the given state.

fun forceLinting(view: EditorSession)

Force the linter to re-run immediately.

forEachDiagnostic

fun forEachDiagnostic(state: EditorState, callback: (Diagnostic) -> Unit)

Iterate over all diagnostics in the given state.

fun linter(source: LintSource, config: LintConfig = LintConfig()): Extension

Create a linter extension.

fun linter(source: SuspendLintSource, config: LintConfig = LintConfig()): Extension

Create a linter extension with a suspend source.

fun lintGutter(config: LintGutterConfig = LintGutterConfig()): Extension

Extension that adds a lint gutter column showing colored markers for lines that have diagnostics.

fun setDiagnostics(view: EditorSession, diagnostics: List<Diagnostic>)

Set diagnostics on an editor view.