Skip to content

Update link checker #3240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kolchfa-aws wants to merge 2 commits into from
Closed

Update link checker #3240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
844ffba
Update link checker
kolchfa-aws Mar 6, 2023
e5db550
Adds a check for a malformed internal link
kolchfa-aws Mar 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions _plugins/link-checker.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,19 @@ module Jekyll::LinkChecker
# Driven by environment variables, it indicates the need to fail the build for dead links
@should_build_fatally

# For red warning/error output to terminal
class String
def red; "\e[31m#{self}\e[0m" end
end

# Initializes the singleton by recording the site
# return [void]
def self.init(site)
@site = site
@urls = {}
@failures = []
@base_url_matcher = /^#{@site.config["url"]}#{@site.baseurl}(\/.*)$/.freeze
@bad_url_matcher = /^#{@site.config["url"]}#{@site.baseurl}[^\/]/.freeze
end

# Processes a Document or Page and adds the links to a collection
Expand Down Expand Up @@ -111,10 +117,15 @@ def self.verify(site)

msg = "Found #{@failures.size} dead link#{@failures.size > 1 ? 's' : ''}:\n#{@failures.join("\n")}" unless @failures.empty?

if @should_build_fatally
raise msg
unless @failures.empty?
if @should_build_fatally
puts "\nLinkChecker: [Error] #{msg}\n".red
exit(1)
else
puts "\nLinkChecker: [Warning] #{msg}\n".red
end
else
puts "\nLinkChecker: [Warning] #{msg}\n"
puts "\nLinkChecker: [Notice] All links verified.\n"
end
end

Expand All @@ -127,6 +138,8 @@ def self.check(url)
url = match[1]
end

return false if @bad_url_matcher =~ url

if @external_matcher =~ url
return true unless @check_external_links
return self.check_external(url)
Expand Down