Rumdl

module Rumdl


Assembly	`Nacara.Plugin.Linter.Rumdl`
Attributes	`[<RequireQualifiedAccess>]`

Lints the site's markdown with rumdl.

The pages of the build are what it reads - the files a collection actually publishes - so a note kept beside your content is not linted, and a generated page has nothing to lint.

What it finds becomes ordinary diagnostics, with a position an editor can jump to. A linter that cannot run is reported as a warning, not a failure.

Declared inside


`Finding`	What a finding is: rumdl's own JSON, which says everything a diagnostic needs

Functions and values

Defaults: string list

What this plugin asks of rumdl before you say anything.

Two of these turn a rule off because the engine answers the same question and knows more while doing it - which pages exist, and what a directive is. The others are the settings a prose file wants rather than a source file.

binaryPath (value: string option) (options: RumdlOptions) : RumdlOptions

Path of an existing rumdl binary.

Parameter
`value`	The value to use.
`options`	The options so far.

configPath (value: string option) (options: RumdlOptions) : RumdlOptions

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

Parameter
`value`	The value to use.
`options`	The options so far.

create () : IPlugin

Lint the site's markdown, with the default options.

createWith (configure: RumdlOptions -> RumdlOptions) : IPlugin

Lint the site's markdown, configured.

Parameter
`configure`	Given the defaults, the options to use. Anything it leaves alone keeps its default.

defaults: RumdlOptions

disable (value: string list) (options: RumdlOptions) : RumdlOptions

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

Parameter
`value`	The value to use.
`options`	The options so far.

isolated (value: bool) (options: RumdlOptions) : RumdlOptions

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

Parameter
`value`	The value to use.
`options`	The options so far.

lintWhileWatching (value: bool) (options: RumdlOptions) : RumdlOptions

Lint while watching too.

Parameter
`value`	The value to use.
`options`	The options so far.

readFindings (json: string) : Finding list

Reads what rumdl said, which is a JSON array of findings.

Parameter
`json`	The output of `rumdl check --output-format json`.

Returns. One finding per element, with what a diagnostic needs from it.

register (site: Site) : Site

Lint the site's markdown.

Parameter
`site`	The site being described.

registerWith (configure: RumdlOptions -> RumdlOptions) (site: Site) : Site

Lint the site's markdown, configured.

Parameter
`configure`	Given the defaults, the options to use.
`site`	The site being described.

settings (value: string list) (options: RumdlOptions) : RumdlOptions

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

Parameter
`value`	The value to use.
`options`	The options so far.

severity (value: LintSeverity) (options: RumdlOptions) : RumdlOptions

Whether a finding is a warning or an error.

Parameter
`value`	The value to use.
`options`	The options so far.

source (value: string) (options: RumdlOptions) : RumdlOptions

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

Parameter
`value`	The value to use.
`options`	The options so far.

useDefaults (value: bool) (options: RumdlOptions) : RumdlOptions

Ship the defaults this plugin was written with.

Parameter
`value`	The value to use.
`options`	The options so far.