Skip to main content

Module filter

Module filter 

Source
Expand description

Filters are a way to define behavior when encountering URIs that need to be treated differently, such as local IPs or e-mail addresses

ModulesΒ§

regex_filter πŸ”’

StructsΒ§

Filter
A generic URI filter Used to decide if a given URI should be checked or skipped

ConstantsΒ§

FALSE_POSITIVE_PAT πŸ”’
Pre-defined exclusions for known false-positives

StaticsΒ§

EXAMPLE_DOMAINS πŸ”’
These domains are explicitly defined by RFC 2606, section 3 Reserved Example Second Level Domain Names for describing example cases and should not be dereferenced as they should not have content.
EXAMPLE_TLDS πŸ”’
We also exclude the example TLDs in section 2 of the same RFC. This exclusion gets subsumed by the check_example_domains feature.
FALSE_POSITIVE_SET πŸ”’
UNSUPPORTED_DOMAINS πŸ”’

FunctionsΒ§

is_example_domain
Check if the host belongs to a known example domain as defined in RFC 2606
is_false_positive
The given input is a well-known false-positive, which won’t be checked by default. This behavior can be explicitly overwritten by defining an Include pattern, which will match on a false positive
is_unsupported_domain
Check if the host belongs to a known unsupported domain

Type AliasesΒ§

Excludes
Exclude configuration for the link checker. You can ignore links based on regex patterns.
Includes
Include configuration for the link checker. You can include links based on regex patterns.
PathExcludes
You can exclude paths and files based on regex patterns.