Index

Modules: lint, lint/private/cli, lint/private/config, lint/private/runner, lint/private/suppress, lint/private/types.

API symbols

`$`:

• runner: proc `$`(report: RunReport; format: string = "text"): string

addCheck:

• types: proc addCheck[S](linter: Linter; run: proc (ast: PNode; settings: S): seq[Finding]; defaults: S = default(S)): Check[S]

Check:

• types: object Check

Config:

• types: object Config

emCheckError:

• runner: ExitMode.emCheckError

emClean:

• runner: ExitMode.emClean

emErrorsFound:

• runner: ExitMode.emErrorsFound

emNoSources:

• runner: ExitMode.emNoSources

emParseError:

• runner: ExitMode.emParseError

error:

• types: Severity.error

ExitMode:

• runner: enum ExitMode

exitMode:

• runner: proc exitMode(report: RunReport): ExitMode

FileReport:

• runner: object FileReport

Finding:

• types: object Finding

FindingTag:

• runner: object FindingTag

helpText:

• cli: const helpText

hint:

• types: Severity.hint

inRanges:

• cli: proc inRanges(line: int; ranges: seq[tuple[first, last: int]]): bool

isSuppressed:

• suppress: proc isSuppressed(lines: seq[string]; line: int): bool
• suppress: proc isSuppressed(line: string): bool

Linter:

• types: object Linter

Options:

• cli: object Options

ParseFailure:

• runner: object ParseFailure

parseOptions:

• cli: proc parseOptions(args: seq[string]): Options

parseTarget:

• cli: proc parseTarget(arg: string): Target

run:

• runner: proc run(config: Config; targets: seq[Target] = @[]; format: string = "text")

runLint:

• config: macro runLint(body: untyped): untyped

RunReport:

• runner: object RunReport

Severity:

• types: enum Severity

Step:

• types: object Step

StepReport:

• runner: object StepReport

StepSetting:

• types: object StepSetting

suppressionMarker:

• suppress: const suppressionMarker

Target:

• cli: object Target

toFinding:

• types: proc toFinding(node: PNode; msg: string): Finding