html_check_hook.rb

# Copyright © Magento, Inc. All rights reserved.
# See COPYING.txt for license details.

# frozen_string_literal: true

# The hook runs html-proofer with options defined in the
#  _config.checks.yml file
#
# For more details about html-proofer, refer to: https://github.com/gjtorikian/html-proofer
# For more details about Jekyll hooks, refer to: https://jekyllrb.com/docs/plugins/hooks/
#
require 'html-proofer'
require 'yaml'
require_relative '../lib/double_slash_check.rb'

Jekyll::Hooks.register :site, :post_write do |site|
  # Do nothing unless 'site.check_links' is set
  next unless site.config['check_links']

  # Do not exit when html-proofer raises an error
  begin
    # Check 'ignore_urls' in '_config.checks.yml'
    # and add 'excludes' from Jekyll configuration.
    #
    checks_config = YAML.load_file('_config.checks.yml')
    ignore_urls = checks_config.dig('html-proofer', :ignore_urls)
    jekyll_excludes = site.config['exclude']
    jekyll_excludes_as_regex =
      jekyll_excludes.map do |item|
        Regexp.new Regexp.escape(item)
      end

    if ignore_urls
      ignore_urls.push(jekyll_excludes_as_regex).flatten!.uniq!
    else
      checks_config['html-proofer'][:ignore_urls] = jekyll_excludes_as_regex
    end

    # Read configuration options for html-proofer
    options = checks_config['html-proofer']

    # Run html-proofer to check the jekyll destination directory
    HTMLProofer.check_directory('_site', options).run

  # Show the message when html-proofer fails.
  # Expected that it fails when it finds broken links.
  rescue StandardError => e
    puts e
    puts 'Fix the broken links before you push the changes to remote branch.'.blue
  end
end