Merge pull request #5195 from magento/sync-with-master

Sync develop with master

Author: jeff-matthews

.mdlrc

@@ -1,2 +1,2 @@
-style '_checks/md_style'
-ignore_front_matter true
+style '_checks/styles/style-rules-dev'
+ignore_front_matter true

Rakefile

@@ -58,10 +58,10 @@ end
 desc 'Pull docs from external repositories'
 task init: %w[multirepo:init]
 
-desc 'Run checks (image optimization).'
+desc 'Run checks (image optimization and Markdown style linting).'
 task check: %w[check:image_optim check:mdl]
 
-desc 'Generate data for a news digest. Default period is a week since today. For other period use "since" argument: since="jul 4"'
+desc 'Generate data for a news digest. Default timeframe is a week since today. For other period, use "since" argument: since="jul 4"'
 task :whatsnew do
   date = ENV['since']
   print 'Generating data for the weekly digest: $ '.magenta

_checks/html-check-hook.rb renamed to _checks/html_check_hook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The hook runs html-proofer with options defined in the
 #  _config.checks.yml file
 #
@@ -15,17 +17,20 @@
   # Do not exit when html-proofer raises an error
   begin
     # Check 'url_ignore' in '_config.checks.yml'
-    # and add 'excludes' from Jekyll configurtiuon.
+    # and add 'excludes' from Jekyll configuration.
     #
     checks_config = YAML.load_file('_config.checks.yml')
     url_ignore = checks_config.dig('html-proofer', :url_ignore)
     jekyll_excludes = site.config['exclude']
-    jekyll_excludes_as_regex = jekyll_excludes.map { |item| Regexp.new Regexp.escape(item) }
+    jekyll_excludes_as_regex =
+      jekyll_excludes.map do |item|
+        Regexp.new Regexp.escape(item)
+      end
 
     if url_ignore
       url_ignore.push(jekyll_excludes_as_regex).flatten!.uniq!
     else
-      checks_config['html-proofer'].merge!({ url_ignore: jekyll_excludes_as_regex })
+      checks_config['html-proofer'].merge!(url_ignore: jekyll_excludes_as_regex)
     end
 
     # Read configuration options for html-proofer
@@ -36,8 +41,8 @@
 
   # Show the message when html-proofer fails.
   # Expected that it fails when it finds broken links.
-  rescue StandardError => msg
-    puts msg
+  rescue StandardError => e
+    puts e
     puts 'Fix the broken links before you push the changes to remote branch.'.blue
   end
 end

_checks/md-check-hook.rb renamed to _checks/md_check_hook.rb

@@ -1,19 +1,23 @@
+# frozen_string_literal: true
+
 # This Jekyll hook runs Markdown linter (https://github.com/markdownlint/markdownlint)
 # on .md files that git tracks as 'modified' ('git ls-files -m').
-# '_checks/md_style' sets a style (https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md)
+# '_checks/styles/style-rules-dev' sets a style (https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md)
 # that is a set of rules to be applied when linting (https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md).
 # '.mdlrc' sets linting configuration (https://github.com/markdownlint/markdownlint/blob/master/docs/configuration.md).
 #
 # The plugin runs in serving mode only.
 #
 Jekyll::Hooks.register :site, :post_write do |site|
   next unless site.config['serving']
+
   staged_files = `git ls-files -m`.split("\n")
   staged_md_files = staged_files.select { |file| File.extname(file) == '.md' }
   next if staged_md_files.empty?
+
   puts 'Checking Markdown syntax...'.blue
   staged_md_files_as_a_string = staged_md_files.join(' ')
   report = `bin/mdl #{staged_md_files_as_a_string}`
   puts report.yellow
-  puts 'The style is defined in _checks/md_style'.yellow
+  puts 'The style is defined in _checks/styles/style-rules-dev'.yellow
 end

_checks/md_style renamed to _checks/styles/style-rules-dev

@@ -0,0 +1,38 @@
+exclude_rule 'MD001'
+exclude_rule 'MD002'
+exclude_rule 'MD003'
+exclude_rule 'MD004'
+exclude_rule 'MD005'
+exclude_rule 'MD006'
+exclude_rule 'MD007'
+exclude_rule 'MD009'
+exclude_rule 'MD010'
+exclude_rule 'MD011'
+exclude_rule 'MD012'
+exclude_rule 'MD013'
+exclude_rule 'MD014'
+exclude_rule 'MD018'
+exclude_rule 'MD019'
+exclude_rule 'MD020'
+exclude_rule 'MD021'
+exclude_rule 'MD022'
+exclude_rule 'MD023'
+exclude_rule 'MD024'
+exclude_rule 'MD025'
+exclude_rule 'MD026'
+exclude_rule 'MD027'
+exclude_rule 'MD028'
+exclude_rule 'MD029'
+exclude_rule 'MD030'
+exclude_rule 'MD031'
+exclude_rule 'MD032'
+exclude_rule 'MD033'
+exclude_rule 'MD034'
+exclude_rule 'MD035'
+exclude_rule 'MD036'
+exclude_rule 'MD037'
+exclude_rule 'MD038'
+exclude_rule 'MD039'
+exclude_rule 'MD040'
+exclude_rule 'MD041'
+exclude_rule 'MD046'

_checks/styles/style-rules-prod

@@ -4,6 +4,9 @@
 #
 html-proofer:
 
+  # Validate HTML
+  :check_html: true
+  
   # Do not check external links.
   :disable_external: true