Read options from the external YAML file

Author: dshevtsov

_config.checks.yml

@@ -0,0 +1,52 @@
+# Configuration settings for html-proofer.
+# For configuration documentation, refer to: https://github.com/gjtorikian/html-proofer#configuration
+# For configuration defaults, refer to: https://github.com/gjtorikian/html-proofer/blob/master/lib/html-proofer/configuration.rb
+#
+html-proofer:
+  :disable_external: true
+  :only_4xx: true
+  :checks_to_ignore:
+  - ImageCheck
+  - ScriptCheck
+  :allow_hash_ref: true
+  :error_sort: :desc
+  :parallel:
+  :in_processes: 3
+  :file_ignore:
+  - !ruby/regexp /404.html/
+  - !ruby/regexp /action-groups.html/
+  - !ruby/regexp /cloud-fastly.html/
+  - !ruby/regexp /codelinks/
+  - !ruby/regexp /contributing.html/
+  - !ruby/regexp /css-preprocess.html/
+  - !ruby/regexp /es-overview.html/
+  - !ruby/regexp /guides\/m1x/
+  - !ruby/regexp /index.html/
+  - !ruby/regexp /magento-third-party.html/
+  - !ruby/regexp /magento-techbull.html/
+  - !ruby/regexp /pattern-library/
+  - !ruby/regexp /release-notes/
+  - !ruby/regexp /search.html/
+  - !ruby/regexp /swagger/
+  - !ruby/regexp /template.html/
+  - !ruby/regexp /theme_dictionary.html/
+  - !ruby/regexp /videos/
+  - !ruby/regexp /whats-new.html/
+  :url_ignore:
+  - !ruby/regexp /account.magento.com/
+  - !ruby/regexp /config-guide/
+  - !ruby/regexp /docs.magento.com/
+  - !ruby/regexp /extension-dev-guide/
+  - !ruby/regexp /frontend-dev-guide/
+  - !ruby/regexp /github.com/
+  - !ruby/regexp /guides\/v2.0/
+  - !ruby/regexp /howdoi/
+  - !ruby/regexp /mariadb.com/
+  - !ruby/regexp /mrg/
+  - !ruby/regexp /navigation/
+  - !ruby/regexp /pattern-library/
+  - !ruby/regexp /release-notes/
+  - !ruby/regexp /rest/
+  - !ruby/regexp /ui_comp_guide/
+  - !ruby/regexp /www.thegeekstuff.com/
+  - !ruby/regexp /yatil.net/

rakelib/proofer.rb

@@ -1,104 +1,18 @@
+# Configure html-proofer parameters
 module Proofer
-  # Constants to be used in options
-  FILE_IGNORE = %w[
-    videos
-    swagger
-    mftf
-    pattern-library
-    guides/m1x
-    search.html
-    404.html
-    codelinks
-    magento-third-party.html
-    magento-techbull.html
-    release-notes
-    index.html
-    template.html
-    whats-new.html
-    action-groups.html
-    css-preprocess.html
-    es-overview.html
-    cloud-fastly.html
-    theme_dictionary.html
-    contributing.html
-  ].freeze
-
-  URL_IGNORE = %w[
-    guides/v2.0
-    architecture
-    advanced-reporting
-    coding-standards
-    comp-mgr
-    config-guide
-    contributor-guide
-    design-styleguide
-    ext-best-practices
-    extension-dev-guide
-    frontend-dev-guide
-    get-started
-    graphql
-    howdoi
-    inventory
-    javascript-dev-guide
-    marketplace
-    magento-functional-testing-framework
-    migration
-    modules
-    mrg
-    mtf
-    pattern-library
-    payments-integrations
-    release-notes
-    rest
-    soap
-    test
-    ui-components
-    ui_comp_guide
-    pwa
-    msi
-    mftf
-    github.com
-    www.thegeekstuff.com
-    account.magento.com
-    yatil.net
-    ui-library
-    security
-    navigation
-    community
-    docs.magento.com
-    mariadb.com
-  ].freeze
-
-  # Configure htmlproofer parameters:
+  # Read options from the '_config.checks.yml'
   def options
-    {
-      log_level: :info,
-      only_4xx: true,
-      # external_only: true, # Check external links only
-      checks_to_ignore: %w[ScriptCheck ImageCheck],
-      allow_hash_ref: true,
-      alt_ignore: [/.*/],
-      file_ignore: array_to_re(FILE_IGNORE),
-      url_ignore: array_to_re(URL_IGNORE),
-      error_sort: :desc, # Sort by invalid link instead of affected file path (default). This makes it easier to see how many files the broken link affects.
-      parallel: { in_processes: 3 },
-      typhoeus: { followlocation: true, connecttimeout: 10, timeout: 30 },
-      hydra: { max_concurrency: 50 },
-      # cache: { :timeframe => '30d' }
-    }
-  end
-
-  # Convert array of strings to array of regular expressions
-  def array_to_re(array)
-    array.map { |item| /#{item}/ }
+    config = YAML.load_file('_config.checks.yml')
+    config['html-proofer']
   end
 
   # Count the number of lines in the given file
   def size_in_lines(filepath)
     f = File.new(filepath)
     f.readlines[-1]
     count = f.lineno.to_s
-    puts "#{count} lines in the #{File.basename(filepath)} file.".blue
+    puts "The link check report contains #{count} lines.".blue
+    puts "To see the report, open the #{filepath} file.".blue
   end
 
   # Read the current Git branch
@@ -113,8 +27,8 @@ def dir_name
 
   # Name the file for the link checker report
   def file_name
-    prefix = "broken-links-in-"
-    timestamp = Time.now.strftime("_%m-%d_%H-%M-%S")
+    prefix = 'broken-links-in-'
+    timestamp = Time.now.strftime('_%m-%d_%H-%M-%S')
     prefix + current_branch + timestamp
   end