22
33# Verbose program output
44# Accepts log level: "error", "warn", "info", "debug", "trace"
5- verbose = " warn"
6-
7- # Output format
8- format = " detailed"
9-
10- # Output display mode
11- mode = " emoji"
5+ # verbose = "warn"
126
137# Don't show interactive progress bar while checking links.
148no_progress = false
159
1610# Path to summary output file.
1711output = " .github/link_report.md"
1812
19- # Show host statistics
20- host_stats = true
21-
22- # Extract links instead of checking them
23- dump = true
24-
25- # Dump inputs instead of doing link extraction / checking
26- dump_inputs = true
27-
2813# ############################ Cache ###############################
2914
3015# Enable link caching. This can be helpful to avoid checking the same links on
@@ -34,14 +19,8 @@ cache = true
3419# Discard all cached requests older than this duration.
3520max_cache_age = " 1d"
3621
37- # A list of status codes that will be ignored from the cache
38- cache_exclude_status = " 500.."
39-
4022# ############################ Runtime #############################
4123
42- # File to read and write cookies
43- cookie_jar = " cookie-jar"
44-
4524# Number of threads to utilize.
4625# Defaults to number of cores available to the system if omitted.
4726threads = 2
@@ -55,18 +34,6 @@ max_retries = 2
5534# Maximum number of concurrent link checks.
5635max_concurrency = 14
5736
58- # extension applied to files without extension
59- default_extension = " md"
60-
61- # GitHub API token
62- github_token = " secret"
63-
64- # Resolve directories to index files
65- index_files = [" index.html" ]
66-
67- # Preprocess input files
68- preprocess = { command = " preprocess.sh" }
69-
7037# ############################ Requests ############################
7138
7239# User agent to send with each request.
@@ -79,21 +46,14 @@ timeout = 20
7946retry_wait_time = 2
8047
8148# Comma-separated list of accepted status codes for valid links.
82- # Supported values are:
83- #
84- # accept = ["200..=204", "429"]
85- # accept = "200..=204, 429"
86- # accept = ["200", "429"]
87- # accept = "200, 429"
88- accept = [" 200" , " 429" ]
49+ accept = [200 , 429 ]
8950
9051# Proceed for server connections considered insecure (invalid TLS).
9152insecure = false
9253
9354# Only test links with the given schemes (e.g. https).
94- # Omit to check links with any other scheme.
95- # At the moment, we support http, https, file, and mailto.
96- scheme = [" https" ]
55+ # Omit to check links with any scheme.
56+ scheme = [ " https" ]
9757
9858# When links are available using HTTPS, treat HTTP links as errors.
9959require_https = false
@@ -102,70 +62,45 @@ require_https = false
10262method = " get"
10363
10464# Custom request headers
105- header = { "accept" = " text/html " , "x-custom-header" = " value " }
65+ headers = []
10666
10767# Remap URI matching pattern to different URI.
108- remap = [" https://example.com http://example.invalid" ]
109-
110- # Fallback extensions to apply when a URL does not specify one.
111- # This is common in documentation tools that cross-reference files without extensions.
112- fallback_extensions = [" md" , " html" ]
68+ remap = [ " https://example.com http://example.invalid" ]
11369
11470# Base URL or website root directory to check relative URLs.
115- base_url = " https://pestphp.com"
116-
117- # Root path to use when checking absolute local links, must be an absolute path
118- root_dir = " /dist"
71+ # base = "https://pestphp.com"
11972
12073# HTTP basic auth support. This will be the username and password passed to the
12174# authorization HTTP header. See
12275# <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization>
12376# basic_auth = ["example.com user:pwd"]
12477
125- # Enable the checking of fragments in links.
126- include_fragments = true
127-
128- # Minimum accepted TLS Version
129- min_tls = " TLSv1_3"
130-
13178# ############################ Exclusions ##########################
13279
13380# Skip missing input files (default is to error if they don't exist).
13481skip_missing = false
13582
136- # Do not skip hidden directories and files
137- hidden = true
138-
139- # Do not skip files that are ignored
140- no_ignore = true
141-
14283# Check links inside `<code>` and `<pre>` blocks as well as Markdown code
14384# blocks.
14485include_verbatim = false
14586
14687# Ignore case of paths when matching glob patterns.
14788glob_ignore_case = false
14889
149- # Exclude URLs and mail addresses from checking. The values are treated as regular expressions
90+ # Exclude URLs and mail addresses from checking (supports regex).
91+ # receiving forbidden but valid link, receiving timeout but valid link
15092exclude = [
15193 ' https://opensource.org/licenses/MIT' ,
15294 ' https://twitter.com/pestphp' ,
15395 ' ^https://laracasts.com/series/(pest-driven-laravel|pest-from-scratch)$' ,
15496 ' ^https://www.linkedin.com/learning/.*$' ,
15597]
15698
157- # Exclude paths from getting checked. The values are treated as regular expressions
158- # exclude_path = [
159- # "\\.txt$", # skip .txt extensions
160- # "(^|/)test/", # skip directories named "test"
161- # "[aeiouAEIOU]", # exclude paths containing vowels
162- # ]
163-
164- # Check the specified file extensions
165- extensions = [" md" ]
99+ # Exclude these filesystem paths from getting checked.
100+ # exclude_path = ["file/path/to/Ignore", "./other/file/path/to/Ignore"]
166101
167102# URLs to check (supports regex). Has preference over all excludes.
168- # include = ['gist\.github\.com.*']
103+ # include = [ 'gist\.github\.com.*' ]
169104
170105# Exclude all private IPs from checking.
171106# Equivalent to setting `exclude_private`, `exclude_link_local`, and
@@ -181,26 +116,6 @@ exclude_link_local = false
181116# Exclude loopback IP address range and localhost from checking.
182117exclude_loopback = false
183118
184- # Check mail addresses
185- include_mail = false
186-
187- # Check WikiLinks in Markdown files
188- include_wikilinks = true
189-
190- # Only check local files
191- # offline = true
192-
193- # ############################ Hosts #############################
194-
195- # Maximum simultaneous requests to the same host
196- host_concurrency = 5
197-
198- # Minimum interval between requests to the same host
199- host_request_interval = " 50ms"
119+ # Exclude all mail addresses from checking.
120+ exclude_mail = false
200121
201- # Overwrite `host_concurrency` for this host
202- concurrency = 5
203- # Overwrite `host_request_interval` for this host
204- request_interval = " 0" # zero disables rate limiting
205- # Merge global `header` values with the following `headers` for this host
206- headers = { "A" = " B" }
0 commit comments