Skip to content

LinkValidatorOptions

type LinkValidatorOptions =
    {
        CheckExternal: bool
        CheckWhileWatching: bool
        FailOnExternal: bool
        Timeout: int
        Concurrency: int
        Ignore: string list
        AllowStatusCodes: int list
        CacheHours: int
    }
AssemblyNacara.Plugin.LinkValidator

Options of the links plugin.

Fields

CheckExternal: bool

Check links that leave the site.

On by default. Answers are cached for a week, so most builds send no requests. Turn it off for a build that has no network, and see FailOnExternal for what a failure should cost.

CheckWhileWatching: bool

Check while watching too. Off by default: it is slow and rarely what you are working on.

FailOnExternal: bool

A link that leaves the site and cannot be reached fails the build, rather than warning.

Timeout: int

Seconds to wait for a server before giving up on a link.

Concurrency: int

How many external links to check at once.

Ignore: string list

Links to leave alone, as regular expressions matched against the whole url.

AllowStatusCodes: int list

Status codes to accept beyond the usual 2xx and 3xx - 403 and 429 are common for bots.

CacheHours: int

How long an answer stays good, in hours. The cache lives under ~/.cache/nacara.