Xrefcheck.Config

Documentation

type Config = Config' Identity

Type alias for Config' with all required fields.

type NetworkingConfig = NetworkingConfig' Identity

Type alias for NetworkingConfig' with all required fields.

data NetworkingConfig' f

Config of networking.

Constructors

NetworkingConfig

Fields

• ncExternalRefCheckTimeout :: Field f (Time Second)

  When checking external references, how long to wait on request before declaring "Response timeout".

• ncIgnoreAuthFailures :: Field f Bool

  If True - links which return 403 or 401 code will be skipped, otherwise – will be marked as broken, because we can't check it.

• ncDefaultRetryAfter :: Field f (Time Second)

  Default Retry-After delay, applicable when we receive a 429 response and it does not contain a Retry-After header.

• ncMaxRetries :: Field f Int

  How many attempts to retry an external link after getting a "429 Too Many Requests" response. Timeouts may also be accounted here, see the description of maxTimeoutRetries field.

  If a site once responded with 429 error code, subsequent request timeouts will also be treated as hitting the site's rate limiter and result in retry attempts, unless the maximum retries number has been reached.

  On other errors xrefcheck fails immediately, without retrying.

• ncMaxTimeoutRetries :: Field f Int

  Querying a given domain that ever returned 429 before, this defines how many timeouts are allowed during retries.

  For such domains, timeouts likely mean hitting the rate limiter, and so xrefcheck considers timeouts in the same way as 429 errors.

  For other domains, a timeout results in a respective error, no retry attempts will be performed. Use externalRefCheckTimeout option to increase the time after which timeout is declared.

  This option is similar to maxRetries, the difference is that this maxTimeoutRetries option limits only the number of retries caused by timeouts, and maxRetries limits the number of retries caused both by 429s and timeouts.

• ncMaxRedirectFollows :: Field f Int

  Maximum number of links that can be followed in a single redirect chain.

• ncExternalRefRedirects :: Field f RedirectConfig

  Rules to override the redirect behavior for external references.

Instances

FromJSON NetworkingConfig

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser NetworkingConfig

parseJSONList :: Value -> Parser [NetworkingConfig]

omittedField :: Maybe NetworkingConfig

FromJSON (NetworkingConfig' Maybe)

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser (NetworkingConfig' Maybe)

parseJSONList :: Value -> Parser [NetworkingConfig' Maybe]

omittedField :: Maybe (NetworkingConfig' Maybe)

Generic (NetworkingConfig' f)

Defined in Xrefcheck.Config

Associated Types

type Rep (NetworkingConfig' f) :: Type -> Type

Methods

from :: NetworkingConfig' f -> Rep (NetworkingConfig' f) x

to :: Rep (NetworkingConfig' f) x -> NetworkingConfig' f

type Rep (NetworkingConfig' f)

Defined in Xrefcheck.Config

type Rep (NetworkingConfig' f) = D1 ('MetaData "NetworkingConfig'" "Xrefcheck.Config" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "NetworkingConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ncExternalRefCheckTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f (Time Second))) :*: (S1 ('MetaSel ('Just "ncIgnoreAuthFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f Bool)) :*: S1 ('MetaSel ('Just "ncDefaultRetryAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f (Time Second))))) :*: ((S1 ('MetaSel ('Just "ncMaxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f Int)) :*: S1 ('MetaSel ('Just "ncMaxTimeoutRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f Int))) :*: (S1 ('MetaSel ('Just "ncMaxRedirectFollows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f Int)) :*: S1 ('MetaSel ('Just "ncExternalRefRedirects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f RedirectConfig))))))

data Config' f

Overall config.

Constructors

Config

Fields

• cExclusions :: Field f (ExclusionConfig' f)
• cNetworking :: Field f (NetworkingConfig' f)
• cScanners :: ScannersConfig' f

Instances

FromJSON Config

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

omittedField :: Maybe Config

FromJSON ConfigOptional

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser ConfigOptional

parseJSONList :: Value -> Parser [ConfigOptional]

omittedField :: Maybe ConfigOptional

Generic (Config' f)

Defined in Xrefcheck.Config

Associated Types

type Rep (Config' f) :: Type -> Type

Methods

from :: Config' f -> Rep (Config' f) x

to :: Rep (Config' f) x -> Config' f

type Rep (Config' f)

Defined in Xrefcheck.Config

type Rep (Config' f) = D1 ('MetaData "Config'" "Xrefcheck.Config" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) (S1 ('MetaSel ('Just "cExclusions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f (ExclusionConfig' f))) :*: (S1 ('MetaSel ('Just "cNetworking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f (NetworkingConfig' f))) :*: S1 ('MetaSel ('Just "cScanners") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ScannersConfig' f)))))

type ScannersConfig = ScannersConfig' Identity

Type alias for ScannersConfig' with all required fields.

data ScannersConfig' f

Configs for all the supported scanners.

Constructors

ScannersConfig

Fields

• scMarkdown :: MarkdownConfig
• scAnchorSimilarityThreshold :: Field f Double

  On 'anchor not found' error, how much similar anchors should be displayed as hint. Number should be between 0 and 1, larger value means stricter filter.

Instances

FromJSON ScannersConfig

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser ScannersConfig

parseJSONList :: Value -> Parser [ScannersConfig]

omittedField :: Maybe ScannersConfig

FromJSON (ScannersConfig' Maybe)

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser (ScannersConfig' Maybe)

parseJSONList :: Value -> Parser [ScannersConfig' Maybe]

omittedField :: Maybe (ScannersConfig' Maybe)

Generic (ScannersConfig' f)

Defined in Xrefcheck.Config

Associated Types

type Rep (ScannersConfig' f) :: Type -> Type

Methods

from :: ScannersConfig' f -> Rep (ScannersConfig' f) x

to :: Rep (ScannersConfig' f) x -> ScannersConfig' f

type Rep (ScannersConfig' f)

Defined in Xrefcheck.Config

type Rep (ScannersConfig' f) = D1 ('MetaData "ScannersConfig'" "Xrefcheck.Config" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "ScannersConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "scMarkdown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkdownConfig) :*: S1 ('MetaSel ('Just "scAnchorSimilarityThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f Double))))

type ConfigOptional = Config' Maybe

Type alias for Config' with optional fields.

type RedirectConfig = [RedirectRule]

A list of custom redirect rules.

defConfig :: HasCallStack => Flavor -> Config

overrideConfig :: ConfigOptional -> Config

Override missed fields with default values.

ncExternalRefRedirectsL :: forall f. Lens' (NetworkingConfig' f) (Field f RedirectConfig)

cExclusionsL :: forall f. Lens' (Config' f) (Field f (ExclusionConfig' f))

cNetworkingL :: forall f. Lens' (Config' f) (Field f (NetworkingConfig' f))

cScannersL :: forall f. Lens' (Config' f) (ScannersConfig' f)

ncDefaultRetryAfterL :: forall f. Lens' (NetworkingConfig' f) (Field f (Time Second))

ncExternalRefCheckTimeoutL :: forall f. Lens' (NetworkingConfig' f) (Field f (Time Second))

ncIgnoreAuthFailuresL :: forall f. Lens' (NetworkingConfig' f) (Field f Bool)

ncMaxRedirectFollowsL :: forall f. Lens' (NetworkingConfig' f) (Field f Int)

ncMaxRetriesL :: forall f. Lens' (NetworkingConfig' f) (Field f Int)

ncMaxTimeoutRetriesL :: forall f. Lens' (NetworkingConfig' f) (Field f Int)

module Xrefcheck.Data.Redirect

defConfigText :: Flavor -> Text

Orphan instances

KnownRatName unit => FromJSON (Time unit)

Methods

parseJSON :: Value -> Parser (Time unit)

parseJSONList :: Value -> Parser [Time unit]

omittedField :: Maybe (Time unit)