html-proofer 4.4.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e54554dcf4b21e6724cff760438b0a116c2871922f7ae0373b9d234d8202b2af
-  data.tar.gz: 4ab71e2407af3f65381bd48fec4ef9bba19a9849265884adfa7d6a7d7dd797ac
+  metadata.gz: f2c984bfe049fba10c746d289d8d0256f219d6ae8f5af152f6f8af68e639301b
+  data.tar.gz: c407f3995e873bbbc42d90de1f082827a40caa90cb12e5cdba7fd514500d1124
 SHA512:
-  metadata.gz: 228448293b92c6e5e5938201278f963fc2573c28869721d90671f31e84747cde91c6cfc5059da3b8404c4de874e67c319391b270de24e1df5afcf20062bda698
-  data.tar.gz: da4e98326f717141c3c433cd9afd651987a8a091f5a07cd2cf95e0b5034e0a33214bf63cc1f85b234999b2eb6047afb926437ca4ab56d0eb8f81e5eaaa4aab2f
+  metadata.gz: 732365ae4207754f70b27843a52d4f8186673fe1282ddaae03244ebff07517816371e970b75e465539bac51e931d51d4b1856866fcd6a3a575ae6e980d7c6465
+  data.tar.gz: ab01a8425d206863584e6c84f395ab85a22eff9d2e1df0daa4e0f72771fc9bde95a8992da17d2ef8195439ad1de2412135758989bb9ba29766b1978d95e0fad4

data/exe/htmlproofer

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "html-proofer"
+require "benchmark"
+
+exit_status = -1
+cli = HTMLProofer::CLI.new
+
+time = Benchmark.realtime { exit_status = cli.run }
+
+puts "Finished in #{time.round(2)} seconds"
+exit exit_status

data/lib/html_proofer/check/images.rb

@@ -3,7 +3,7 @@
 module HTMLProofer
   class Check
     class Images < HTMLProofer::Check
-      SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/.freeze
+      SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/
 
       def run
         @html.css("img, source").each do |node|

data/lib/html_proofer/cli.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module HTMLProofer
+  # The CLI is a class responsible of handling all the command line interface
+  # logic.
+  class CLI
+    attr_reader :options
+
+    def initialize
+      @options = {}
+    end
+
+    def run(args = ARGV)
+      @options, path = HTMLProofer::Configuration.new.parse_cli_options(args)
+
+      paths = path.split(",")
+
+      if @options[:as_links]
+        links = path.split(",").map(&:strip)
+        HTMLProofer.check_links(links, @options).run
+      elsif File.directory?(paths.first)
+        HTMLProofer.check_directories(paths, @options).run
+      else
+        HTMLProofer.check_file(path, @options).run
+      end
+    end
+  end
+end

data/lib/html_proofer/configuration.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "optparse"
+
 module HTMLProofer
-  module Configuration
+  class Configuration
     DEFAULT_TESTS = ["Links", "Images", "Scripts"].freeze
 
     PROOFER_DEFAULTS = {
@@ -41,71 +43,279 @@ module HTMLProofer
       max_concurrency: 50,
     }.freeze
 
-    PARALLEL_DEFAULTS = {
-      enable: true,
-    }.freeze
-
     CACHE_DEFAULTS = {}.freeze
 
     class << self
       def generate_defaults(opts)
-        validate_options(default_options, opts)
-
         options = PROOFER_DEFAULTS.merge(opts)
 
         options[:typhoeus] = HTMLProofer::Configuration::TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
         options[:hydra] = HTMLProofer::Configuration::HYDRA_DEFAULTS.merge(opts[:hydra] || {})
 
-        options[:parallel] = HTMLProofer::Configuration::PARALLEL_DEFAULTS.merge(opts[:parallel] || {})
         options[:cache] = HTMLProofer::Configuration::CACHE_DEFAULTS.merge(opts[:cache] || {})
 
         options.delete(:src)
 
         options
       end
+    end
+
+    def initialize
+      @options = {}
+    end
+
+    def parse_cli_options(args)
+      define_options.parse!(args)
 
-      def to_regex?(item)
-        if item.start_with?("/") && item.end_with?("/")
-          Regexp.new(item[1...-1])
-        else
-          item
+      input = ARGV.empty? ? "." : ARGV.join(",")
+
+      [@options, input]
+    end
+
+    private def define_options
+      OptionParser.new do |opts|
+        opts.banner = "Usage: htmlproofer [options] PATH/LINK"
+
+        section(opts, "Input Options") do
+          set_option(opts, "--as-links") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--assume-extension EXT") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--directory-index-file FILENAME") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--extensions [EXT1,EXT2,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
+          end
         end
-      end
 
-      def parse_json_option(option_name, config, symbolize_names: true)
-        raise ArgumentError, "Must provide an option name in string format." unless option_name.is_a?(String)
-        raise ArgumentError, "Must provide an option name in string format." if option_name.strip.empty?
+        section(opts, "Check Configuration") do
+          set_option(opts, "--[no-]allow-hash-href") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]allow-missing-href") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--checks [CHECK1,CHECK2,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
+          end
+
+          set_option(opts, "--[no-]check-external-hash") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]check-internal-hash") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]check-sri") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]disable-external") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]enforce-https") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--root-dir <DIR>") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+        end
+
+        section(opts, "Ignore Configuration") do
+          set_option(opts, "--ignore-files [FILE1,FILE2,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
+          end
+
+          set_option(opts, "--[no-]ignore-empty-alt") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]ignore-empty-mailto") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--[no-]ignore-missing-alt") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+
+          set_option(opts, "--ignore-status-codes [500,401,420,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",").map(&:to_i)
+          end
+
+          set_option(opts, "--ignore-urls [URL1, URL2,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = if list.nil?
+              []
+            else
+              list.split(",").each_with_object([]) do |url, arr|
+                arr << to_regex?(url)
+              end
+            end
+          end
+
+          set_option(opts, "--only-status-codes [404,451,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
+          end
 
-        return {} if config.nil?
+          set_option(opts, "--only-4xx") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg
+          end
+        end
+
+        section(opts, "Transforms Configuration") do
+          set_option(opts, "--swap-attributes <CONFIG>") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = parse_json_option("swap_attributes", arg, symbolize_names: false)
+          end
+
+          set_option(opts, "--swap-urls [re:string,re:string,...]") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = str_to_regexp_map(arg)
+          end
+        end
 
-        raise ArgumentError, "Must provide a JSON configuration in string format." unless config.is_a?(String)
+        section(opts, "Dependencies Configuration") do
+          set_option(opts, "--typhoeus <CONFIG>") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = parse_json_option("typhoeus", arg, symbolize_names: false)
+          end
 
-        return {} if config.strip.empty?
+          set_option(opts, "--hydra <CONFIG>") do |long_opt_symbol, _list|
+            @options[long_opt_symbol] = parse_json_option("hydra", arg, symbolize_names: false)
+          end
+
+          set_option(opts, "--cache <CONFIG>") do |long_opt_symbol, _list|
+            @options[long_opt_symbol] = parse_json_option("cache", arg, symbolize_names: false)
+          end
+        end
+
+        section(opts, "Reporting Configuration") do
+          set_option(opts, "--log-level <LEVEL>") do |long_opt_symbol, arg|
+            @options[long_opt_symbol] = arg.to_sym
+          end
+        end
 
-        begin
-          JSON.parse(config, { symbolize_names: symbolize_names })
-        rescue StandardError
-          raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
+        section(opts, "General Configuration") do
+          set_option(opts, "--version") do
+            puts HTMLProofer::VERSION
+            exit(0)
+          end
         end
       end
+    end
+
+    private def to_regex?(item)
+      if item.start_with?("/") && item.end_with?("/")
+        Regexp.new(item[1...-1])
+      else
+        item
+      end
+    end
 
-      private
+    private def str_to_regexp_map(arg)
+      arg.split(",").each_with_object({}) do |s, hsh|
+        split = s.split(/(?<!\\):/, 2)
 
-      def default_options
-        PROOFER_DEFAULTS.merge(typhoeus: TYPHOEUS_DEFAULTS).merge(hydra: HYDRA_DEFAULTS).merge(parallel: PARALLEL_DEFAULTS)
+        re = split[0].gsub(/\\:/, ":")
+        string = split[1].gsub(/\\:/, ":")
+        hsh[Regexp.new(re)] = string
       end
+    end
 
-      def validate_options(defaults, options)
-        defaults.each do |key, default_value|
-          next unless options.key?(key)
+    private def section(opts, heading, &_block)
+      opts.separator("\n#{heading}:\n")
+      yield
+    end
 
-          value = options[key]
-          raise TypeError, "Invalid value for '#{key}': '#{value}'. Expected #{default_value.class}." unless value.is_a?(default_value.class)
+    private def set_option(opts, long_arg, &block)
+      long_opt_symbol = parse_long_opt(long_arg)
+      args = []
+      args += Array(ConfigurationHelp::TEXT[long_opt_symbol])
 
-          # Iterate over nested hashes
-          validate_options(default_value, value) if default_value.is_a?(Hash)
-        end
+      opts.on(long_arg, *args) do |arg|
+        yield long_opt_symbol, arg
+      end
+    end
+
+    # Converts the option into a symbol,
+    # e.g. '--allow-hash-href' => :allow_hash_href.
+    private def parse_long_opt(long_opt)
+      long_opt[2..].sub("[no-]", "").sub(/ .*/, "").tr("-", "_").gsub(/[\[\]]/, "").to_sym
+    end
+
+    def parse_json_option(option_name, config, symbolize_names: true)
+      raise ArgumentError, "Must provide an option name in string format." unless option_name.is_a?(String)
+      raise ArgumentError, "Must provide an option name in string format." if option_name.strip.empty?
+
+      return {} if config.nil?
+
+      raise ArgumentError, "Must provide a JSON configuration in string format." unless config.is_a?(String)
+
+      return {} if config.strip.empty?
+
+      begin
+        JSON.parse(config, { symbolize_names: symbolize_names })
+      rescue StandardError
+        raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
       end
     end
+
+    module ConfigurationHelp
+      TEXT = {
+        as_links: ["Assumes that `PATH` is a comma-separated array of links to check."],
+        assume_extension: ["Automatically add specified extension to files for internal links, ",
+                           "to allow extensionless URLs (as supported by most servers) (default: `.html`).",],
+        directory_index_file: ["Sets the file to look for when a link refers to a directory. (default: `index.html`)."],
+        extensions: ["A comma-separated list of Strings indicating the file extensions you",
+                     "would like to check (default: `.html`)",],
+
+        allow_hash_href: ['"If `true`, assumes `href="#"` anchors are valid (default: `true`)"'],
+        allow_missing_href: ["If `true`, does not flag `a` tags missing `href`. In HTML5, this is technically ",
+                             "allowed, but could also be human error. (default: `false`)",],
+        checks: ["A comma-separated list of Strings indicating which checks you",
+                 "want to run (default: `[\"Links\", \"Images\", \"Scripts\"]",],
+        check_external_hash: ["Checks whether external hashes exist (even if the webpage exists) (default: `true`)."],
+        check_internal_hash: ["Checks whether internal hashes exist (even if the webpage exists) (default: `true`)."],
+        check_sri: ["Check that `<link>` and `<script>` external resources use SRI (default: `false`)."],
+        disable_external: ["If `true`, does not run the external link checker (default: `false`)."],
+        enforce_https: ["Fails a link if it\'s not marked as `https` (default: `true`)."],
+        root_dir: ["The absolute path to the directory serving your html-files."],
+
+        ignore_empty_alt: ["If `true`, ignores images with empty/missing ",
+                           "alt tags (in other words, `<img alt>` and `<img alt=\"\">`",
+                           "are valid; set this to `false` to flag those) (default: `true`).",],
+        ignore_empty_mailto: ["If `true`, allows `mailto:` `href`s which don't",
+                              "contain an email address (default: `false`)'.",],
+        ignore_missing_alt: ["If `true`, ignores images with missing alt tags (default: `false`)."],
+        ignore_status_codes: ["A comma-separated list of numbers representing status codes to ignore."],
+        ignore_files: ["A comma-separated list of Strings or RegExps containing file paths that are safe to ignore"],
+        ignore_urls: ["A comma-separated list of Strings or RegExps containing URLs that are",
+                      "safe to ignore. This affects all HTML attributes, such as `alt` tags on images.",],
+        only_status_codes: ["A comma-separated list of numbers representing the only status codes to report on."],
+        only_4xx: ["Only reports errors for links that fall within the 4xx status code range."],
+
+        swap_attributes: ["JSON-formatted config that maps element names to the",
+                          "preferred attribute to check (default: `{}`).",],
+        swap_urls: ["A comma-separated list containing key-value pairs of `RegExp => String`.",
+                    "It transforms URLs that match `RegExp` into `String` via `gsub`.",
+                    "The escape sequences `\\:` should be used to produce literal `:`s.",],
+
+        typhoeus: ["JSON-formatted string of Typhoeus config; if set, overrides the html-proofer defaults."],
+        hydra: ["JSON-formatted string of Hydra config; if set, overrides the html-proofer defaults."],
+        cache: ["JSON-formatted string of cache config; if set, overrides the html-proofer defaults."],
+
+        log_level: ["Sets the logging level. One of `:debug`, `:info`, ",
+                    "`:warn`, `:error`, or `:fatal`. (default: `:info`)",],
+
+        version: ["Prints the version of html-proofer."],
+      }.freeze
+    end
   end
 end

data/lib/html_proofer/element.rb

@@ -13,6 +13,8 @@ module HTMLProofer
       @runner = runner
       @node = node
 
+      swap_attributes!
+
       @base_url = base_url
       @url = Attribute::Url.new(runner, link_attribute, base_url: base_url)
 
@@ -26,7 +28,6 @@ module HTMLProofer
 
     def meta_content
       return nil unless meta_tag?
-      return swap_attributes("content") if attribute_swapped?
 
       @node["content"]
     end
@@ -37,7 +38,6 @@ module HTMLProofer
 
     def src
       return nil if !img_tag? && !script_tag? && !source_tag?
-      return swap_attributes("src") if attribute_swapped?
 
       @node["src"]
     end
@@ -52,7 +52,6 @@ module HTMLProofer
 
     def srcset
       return nil if !img_tag? && !source_tag?
-      return swap_attributes("srcset") if attribute_swapped?
 
       @node["srcset"]
     end
@@ -63,7 +62,6 @@ module HTMLProofer
 
     def href
       return nil if !a_tag? && !link_tag?
-      return swap_attributes("href") if attribute_swapped?
 
       @node["href"]
     end
@@ -123,16 +121,17 @@ module HTMLProofer
       return true unless blank?(attrs)
     end
 
-    private def swap_attributes(old_attr)
-      attrs = @runner.options[:swap_attributes][@node.name]
+    private def swap_attributes!
+      return unless attribute_swapped?
 
-      new_attr = attrs.find do |(o, _)|
-        o == old_attr
-      end&.last
+      attr_swaps = @runner.options[:swap_attributes][@node.name]
 
-      return nil if blank?(new_attr)
+      attr_swaps.flatten.each_slice(2) do |(old_attr, new_attr)|
+        next if blank?(node[old_attr])
 
-      @node[new_attr]
+        node[new_attr] = node[old_attr]
+        node.delete(old_attr)
+      end
     end
 
     private def ancestors_ignorable?

data/lib/html_proofer/reporter/{cli.rb → terminal.rb}

@@ -2,7 +2,7 @@
 
 module HTMLProofer
   class Reporter
-    class Cli < HTMLProofer::Reporter
+    class Terminal < HTMLProofer::Reporter
       def report
         msg = failures.each_with_object([]) do |(check_name, failures), arr|
           str = ["For the #{check_name} check, the following failures were found:\n"]

data/lib/html_proofer/runner.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "async"
+
 module HTMLProofer
   class Runner
     include HTMLProofer::Utils
@@ -30,18 +32,18 @@ module HTMLProofer
       @current_source = nil
       @current_filename = nil
 
-      @reporter = Reporter::Cli.new(logger: @logger)
+      @reporter = Reporter::Terminal.new(logger: @logger)
     end
 
     def run
       check_text = pluralize(checks.length, "check", "checks")
 
       if @type == :links
-        @logger.log(:info, "Running #{check_text} (#{format_checks_list(checks)}) on #{@source} ... \n\n")
+        @logger.log(:info, "Running #{check_text} (#{format_checks_list(checks)}) on #{@source} ...\n\n")
         check_list_of_links unless @options[:disable_external]
       else
         @logger.log(:info,
-          "Running #{check_text} (#{format_checks_list(checks)}) in #{@source} on *#{@options[:extensions].join(", ")} files...\n\n")
+          "Running #{check_text} (#{format_checks_list(checks)}) in #{@source} on *#{@options[:extensions].join(", ")} files ...\n\n")
 
         check_files
         @logger.log(:info, "Ran on #{pluralize(files.length, "file", "files")}!\n\n")
@@ -97,13 +99,15 @@ module HTMLProofer
 
     # Walks over each implemented check and runs them on the files, in parallel.
     def process_files
-      if @options[:parallel][:enable]
-        Parallel.map(files, @options[:parallel]) { |file| load_file(file[:path], file[:source]) }
-      else
-        files.map do |file|
-          load_file(file[:path], file[:source])
+      loaded_files = []
+      files.each do |file|
+        Async do |task|
+          task.async do
+            loaded_files << load_file(file[:path], file[:source])
+          end
         end
       end
+      loaded_files
     end
 
     def load_file(path, source)
@@ -238,7 +242,7 @@ module HTMLProofer
     private def format_checks_list(checks)
       checks.map do |check|
         check.sub(/HTMLProofer::Check::/, "")
-      end.join(", ")
+      end.sort.join(", ")
     end
   end
 end

data/lib/html_proofer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  VERSION = "4.4.2"
+  VERSION = "5.0.0"
 end

data/lib/html_proofer.rb

@@ -5,13 +5,13 @@ lib_dir = File.join(File.dirname(__dir__), "lib")
 gem_loader = Zeitwerk::Loader.for_gem
 gem_loader.inflector.inflect(
   "html_proofer" => "HTMLProofer",
+  "cli" => "CLI",
 )
 gem_loader.ignore(File.join(lib_dir, "html-proofer.rb"))
 gem_loader.setup
 
 require "html_proofer/version"
 
-require "parallel"
 require "fileutils"
 
 if ENV.fetch("DEBUG", false)
@@ -22,10 +22,10 @@ end
 module HTMLProofer
   class << self
     def check_file(file, options = {})
-      raise ArgumentError unless file.is_a?(String)
+      raise ArgumentError, "File isn't a string" unless file.is_a?(String)
       raise ArgumentError, "#{file} does not exist" unless File.exist?(file)
 
-      options = prepare_options(options, :file)
+      options[:type] = :file
       HTMLProofer::Runner.new(file, options)
     end
 
@@ -33,14 +33,14 @@ module HTMLProofer
       raise ArgumentError unless directory.is_a?(String)
       raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
 
-      options = prepare_options(options, :directory)
+      options[:type] = :directory
       HTMLProofer::Runner.new([directory], options)
     end
 
     def check_directories(directories, options = {})
       raise ArgumentError unless directories.is_a?(Array)
 
-      options = prepare_options(options, :directory)
+      options[:type] = :directory
       directories.each do |directory|
         raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
       end
@@ -50,20 +50,9 @@ module HTMLProofer
     def check_links(links, options = {})
       raise ArgumentError unless links.is_a?(Array)
 
-      options = prepare_options(options, :links)
+      options[:type] = :links
       HTMLProofer::Runner.new(links, options)
     end
-
-    private
-
-    def prepare_options(options, type)
-      options = {} if options.nil?
-
-      raise ArgumentError, "Options must be a Hash" unless options.is_a?(Hash)
-
-      options[:type] = type
-      options
-    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: parallel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -270,7 +256,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/htmlproofer
+- exe/htmlproofer
 - lib/html-proofer.rb
 - lib/html_proofer.rb
 - lib/html_proofer/attribute.rb
@@ -282,12 +268,13 @@ files:
 - lib/html_proofer/check/links.rb
 - lib/html_proofer/check/open_graph.rb
 - lib/html_proofer/check/scripts.rb
+- lib/html_proofer/cli.rb
 - lib/html_proofer/configuration.rb
 - lib/html_proofer/element.rb
 - lib/html_proofer/failure.rb
 - lib/html_proofer/log.rb
 - lib/html_proofer/reporter.rb
-- lib/html_proofer/reporter/cli.rb
+- lib/html_proofer/reporter/terminal.rb
 - lib/html_proofer/runner.rb
 - lib/html_proofer/url_validator.rb
 - lib/html_proofer/url_validator/external.rb
@@ -309,7 +296,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'

data/bin/htmlproofer

@@ -1,102 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$stdout.sync = true
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'html-proofer'
-require 'mercenary'
-
-Mercenary.program(:htmlproofer) do |p|
-  p.version HTMLProofer::VERSION
-  p.description %(Test your rendered HTML files to make sure they're accurate.)
-  p.syntax 'htmlproofer PATH [options]'
-
-  p.description 'Runs the HTML-Proofer suite on the files in PATH. For more details, see the README.'
-
-  p.option 'allow_hash_href', '--allow-hash-href=<true|false>',  'String', 'If `true`, assumes `href="#"` anchors are valid (default: `true`)'
-  p.option 'allow_missing_href', '--allow-missing-href=<true|false>',  'String', 'If `true`, does not flag `a` tags missing `href`. In HTML5, this is technically allowed, but could also be human error. (default: `false`)'
-  p.option 'as_links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
-  p.option 'assume_extension', '--assume-extension <ext>', 'Automatically add specified extension to files for internal links, to allow extensionless URLs (as supported by most servers) (default: `.html`).'
-  p.option 'checks', '--checks check1,[check2,...]', Array, 'A comma-separated list of Strings indicating which checks you want to run (default: `["Links", "Images", "Scripts"]`)'
-  p.option 'check_external_hash', '--check-external-hash=<true|false>', 'String', 'Checks whether external hashes exist (even if the webpage exists) (default: `true`).'
-  p.option 'check_internal_hash', '--check-internal-hash=<true|false>',  'String', 'Checks whether internal hashes exist (even if the webpage exists) (default: `true`).'
-  p.option 'check_sri', '--check-sri=<true|false>', 'String', 'Check that `<link>` and `<script>` external resources use SRI (default: `false`).'
-  p.option 'directory_index_file', '--directory-index-file <filename>', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)'
-  p.option 'disable_external', '--disable-external=<true|false>', String, 'If `true`, does not run the external link checker (default: `false`)'
-  p.option 'enforce_https', '--enforce-https=<true|false>', String, 'Fails a link if it\'s not marked as `https` (default: `true`).'
-  p.option 'extensions', '--extensions ext1,[ext2,...[', Array, 'A comma-separated list of Strings indicating the file extensions you would like to check (including the dot) (default: `.html`)'
-  p.option 'ignore_empty_alt', '--ignore-empty-alt=<true|false>', 'String', 'If `true`, ignores images with empty/missing alt tags (in other words, `<img alt>` and `<img alt="">` are valid; set this to `false` to flag those) (default: `true`)'
-  p.option 'ignore_empty_mailto', '--ignore-empty-mailto=<true|false>',  'String', 'If `true`, allows `mailto:` `href`s which do not contain an email address (default: `false`)'
-  p.option 'ignore_files', '--ignore-files file1,[file2,...]', Array, 'A comma-separated list of Strings or RegExps containing file paths that are safe to ignore'
-  p.option 'ignore_missing_alt', '--ignore-missing-alt=<true|false>',  'String', 'If `true`, ignores images with missing alt tags (default: `false`)'
-  p.option 'ignore_status_codes', '--ignore-status-codes 123,[xxx, ...]', Array, 'A comma-separated list of numbers representing status codes to ignore.'
-  p.option 'ignore_urls', '--ignore-urls link1,[link2,...]', Array, 'A comma-separated list of Strings or RegExps containing URLs that are safe to ignore. This affects all HTML attributes, such as `alt` tags on images.'
-  p.option 'log_level', '--log-level <level>', String, 'Sets the logging level, as determined by Yell. One of `:debug`, `:info`, `:warn`, `:error`, or `:fatal`. (default: `:info`)'
-  p.option 'only_4xx', '--only-4xx', 'Only reports errors for links that fall within the 4xx status code range'
-  p.option 'root_dir', '--root-dir PATH', String, 'The absolute path to the directory serving your html-files.'
-  p.option 'swap_attributes', '--swap-attributes CONFIG', String, 'JSON-formatted config that maps element names to the preferred attribute to check (default: `{}`).'
-  p.option 'swap_urls', '--swap-urls re:string,[re:string,...]', Array, 'A comma-separated list containing key-value pairs of `RegExp => String`. It transforms URLs that match `RegExp` into `String` via `gsub`. The escape sequences `\\:` should be used to produce literal `:`s.'
-
-  p.option 'typhoeus', '--typhoeus CONFIG', String, 'JSON-formatted string of Typhoeus config. Will override the html-proofer defaults.'
-  p.option 'hydra', '--hydra CONFIG', String, 'JSON-formatted string of Hydra config. Will override the html-proofer defaults.'
-  p.option 'parallel', '--parallel CONFIG', String, 'JSON-formatted string of Parallel config. Will override the html-proofer defaults.'
-  p.option 'cache', '--cache CONFIG', String, 'JSON-formatted string of cache config. Will override the html-proofer defaults.'
-
-  p.action do |args, opts|
-    args = ['.'] if args.empty?
-    path = args.first
-
-    options = {}
-
-    # prepare everything to go to proofer
-    p.options.reject { |o| opts[o.config_key].nil? }.each do |option|
-      opts[option.config_key] = opts[option.config_key].map { |i| HTMLProofer::Configuration.to_regex?(i) } if opts[option.config_key].is_a?(Array)
-      options[option.config_key.to_sym] = opts[option.config_key]
-    end
-
-    # some minor manipulation of a special option
-    unless opts['swap_urls'].nil?
-      options[:swap_urls] = {}
-      opts['swap_urls'].each do |s|
-        splt = s.split(/(?<!\\):/, 2)
-
-        re = splt[0].gsub(/\\:/, ':')
-        string = splt[1].gsub(/\\:/, ':')
-        options[:swap_urls][Regexp.new(re)] = string
-      end
-    end
-
-    # check booleans
-    [:allow_hash_href, :allow_missing_href, :check_external_hash, :check_internal_hash, :check_sri, :disable_external, :enforce_https, :ignore_empty_alt, :ignore_empty_mailto, :ignore_missing_alt].each do |option|
-      next if (val = opts[option.to_s]).nil?
-      if val == "false"
-        options[option] = false
-      else
-        options[option] = true
-      end
-    end
-
-    options[:log_level] = opts['log_level'].to_sym unless opts['log_level'].nil?
-
-    options[:typhoeus] = HTMLProofer::Configuration.parse_json_option('typhoeus', opts['typhoeus'], symbolize_names: false) unless opts['typhoeus'].nil?
-    options[:hydra] = HTMLProofer::Configuration.parse_json_option('hydra', opts['hydra']) unless opts['hydra'].nil?
-    options[:parallel] = HTMLProofer::Configuration.parse_json_option('parallel', opts['parallel']) unless opts['parallel'].nil?
-    options[:cache] = HTMLProofer::Configuration.parse_json_option('cache', opts['cache']) unless opts['cache'].nil?
-
-    options[:swap_attributes] = HTMLProofer::Configuration.parse_json_option('swap_attributes', opts['swap_attributes'], symbolize_names: false) unless opts['swap_attributes'].nil?
-
-    options[:ignore_status_codes] = Array(options[:ignore_status_codes]).map(&:to_i)
-
-    paths = path.split(',')
-    if opts['as_links']
-      links = path.split(',').map(&:strip)
-      HTMLProofer.check_links(links, options).run
-    elsif File.directory?(paths.first)
-      HTMLProofer.check_directories(paths, options).run
-    else
-      HTMLProofer.check_file(path, options).run
-    end
-  end
-end