Skip to content

RumdlOptions

type RumdlOptions =
    {
        BinaryPath: string option
        Source: string
        UseDefaults: bool
        ConfigPath: string option
        Isolated: bool
        Settings: string list
        Disable: string list
        Severity: LintSeverity
        LintWhileWatching: bool
    }
AssemblyNacara.Plugin.Linter.Rumdl

Options of the rumdl linter.

Fields

BinaryPath: string option

Path of an existing rumdl binary. Downloaded and cached when not set.

Source: string

Where that release is published, with {version} and {target} in it.

UseDefaults: bool

Ship the defaults this plugin was written with.

They are what makes rumdl agree with the engine: the rules it turns off are the ones Nacara already answers, and better. Turn them off to start from rumdl's own.

ConfigPath: string option

A rumdl.toml to read, when it is not the one rumdl would find itself.

Isolated: bool

Ignore any configuration file, so only what is said here applies.

Settings: string list

Rule settings, as inline TOML: "MD013.line-length = 100".

Applied above everything else, so this is where a site settles an argument.

Disable: string list

Rules to switch off by name - [ "MD033" ].

Severity: LintSeverity

Whether a finding is a warning or an error.

LintWhileWatching: bool

Lint while watching too.

On by default: a lint pass costs milliseconds.