Merge pull request #2 from magento/master

Merging from master

Author: sandipklevu

Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: d72768697309f7f13af8a37073af776420f6c3a7
+  revision: 21c18f2fe396b5d9ba4ca4941fae4b7b48d8ea5a
   specs:
-    devdocs (7)
+    devdocs (9)
       jekyll (>= 4.0)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     algolia_html_extractor (2.6.2)
       json (~> 2.0)
       nokogiri (~> 1.10.4)
-    algoliasearch (1.27.1)
+    algoliasearch (1.27.2)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     colorator (1.1.0)
@@ -31,7 +31,7 @@ GEM
     filesize (0.2.0)
     forwardable-extended (2.6.0)
     fspath (3.1.2)
-    html-proofer (3.15.2)
+    html-proofer (3.15.3)
       addressable (~> 2.3)
       mercenary (~> 0.3)
       nokogumbo (~> 2.0)
@@ -93,7 +93,8 @@ GEM
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     json (2.3.0)
-    kramdown (2.1.0)
+    kramdown (2.2.1)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     launchy (2.5.0)
@@ -129,12 +130,13 @@ GEM
     public_suffix (4.0.4)
     rainbow (3.0.0)
     rake (13.0.1)
-    rb-fsevent (0.10.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rouge (3.17.0)
+    rexml (3.2.4)
+    rouge (3.18.0)
     safe_yaml (1.0.5)
-    sassc (2.2.1)
+    sassc (2.3.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)

Rakefile

@@ -21,7 +21,7 @@ desc "Same as 'rake', 'rake preview'"
 task default: %w[preview]
 
 desc "Same as 'test:report'"
-task test: %w[test:report]
+task test: %w[test:md test:report]
 
 desc 'Preview the devdocs locally'
 task preview: %w[install clean] do
@@ -91,4 +91,4 @@ task :convert do
   result = `bin/kramdown --input=html --output=kramdown`
   puts 'Converted text:'.magenta
   puts result.bold
-end
+end

bin/htmlproofer

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmlproofer' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("html-proofer", "htmlproofer")

rakelib/check.rake

@@ -4,34 +4,56 @@
 # frozen_string_literal: true
 
 namespace :check do
-  desc 'Optimize images in modified files, or by path (rake image_optim path=path/to/dir/or/file).'
+
+  desc 'Optimize images in modified files, or by path (rake check:img path=path/to/dir/or/file).'
   task :image_optim do
-    puts 'Running image optimizer...'.magenta
+    puts
+    puts 'Checking images ...'.magenta
     path = ENV['path']
+
     unless path
+      puts 'Looking in uncommitted files ...'.blue
       modified_files = `git ls-files --modified --others --exclude-standard`.split("\n")
       deleted_files = `git ls-files --deleted`.split("\n")
       image_files_to_check = (modified_files - deleted_files).select { |file| File.extname(file) =~ /\.(png|jpg|jpeg|gif)/i }
-      abort 'Didn\'t find any modified files.'.blue if image_files_to_check.empty?
+      
+      next puts 'No images to check.'.magenta if image_files_to_check.empty?
+
       path = image_files_to_check.join(' ')
     end
+
     system "bin/image_optim --no-pngout --no-svgo --recursive #{path}"
   end
 
-  desc 'Check Markdown syntax in modified files or in a particular file or directory by path (e.g. path=src/mftf)'
+  desc 'Check Markdown syntax in modified files or in a particular file or directory by path (e.g. path=mftf)'
   task :mdl do
-    puts 'Running Markdown linter ...'.magenta
+    puts
+    puts 'Checking Markdown ...'.magenta
+    print 'List the rules: $ '.magenta
+    sh 'bin/mdl -l --style=_checks/styles/style-rules-dev'
+    puts 'Linting ...'.magenta
 
     path = ENV['path']
+
     unless path
+      puts 'Looking in uncommitted files ...'.blue
       modified_files = `git ls-files --modified --others --exclude-standard`.split("\n")
       deleted_files = `git ls-files --deleted`.split("\n")
       md_files_to_check = (modified_files - deleted_files).select { |file| File.extname(file) == '.md' }
-      abort 'Cannot find any modified .md files.'.magenta if md_files_to_check.empty?
+      
+      next puts 'No Markdown files to check.'.magenta if md_files_to_check.empty?
+
       path = md_files_to_check.join(' ')
     end
-    report = `bin/mdl #{path}`
-    puts report.yellow
+
+    report = `bin/mdl --style=_checks/styles/style-rules-dev --ignore-front-matter -- #{path}`
+
+    if report.empty?
+      puts 'No issues found'.green
+    else
+      puts report.yellow
+    end
+
     puts 'The rules are defined in _checks/styles/style-rules-dev'.magenta
   end
 end

rakelib/test.rake

@@ -5,33 +5,31 @@
 
 namespace :test do
   # Run html-proofer to check for broken links
-  desc 'Build devdocs and check for broken links'
+  desc 'Build site, check for broken links, write report to a file'
   task links: %w[build links_no_build]
 
-  # Run htmlproofer to check for broken external links
   desc 'Check the existing _site for broken EXTERNAL links'
   task :external_links do
     puts 'Testing external links'
-    system 'bundle exec htmlproofer _site/ --external_only'
+    system 'bin/htmlproofer _site/ --external_only'
   end
 
-  desc 'Check the entire _site for broken links and invalid HTML'
+  desc 'Check the existing _site for broken INTERNAL links'
   task :html do
-    puts 'Checking links with html-proofer...'.magenta
+    puts 'Checking HTML ...'.magenta
 
     LinkChecker.check_site
   end
 
-  desc 'Check the existing _site for broken links'
+  desc 'Check the existing _site for broken links and report to a separate file'
   task :links_no_build do
     begin
       # Write console output (stderr only) to a file.
       # Use this if you need to also capture stdout: https://stackoverflow.com/a/2480439
       report = LinkChecker.md_report_path
       $stderr.reopen(report, 'w+')
 
-      puts 'Checking links with html-proofer...'.magenta
-      LinkChecker.check_site
+      Rake::Task['test:html'].invoke
 
       # We're expecting link validation errors, but unless we rescue from
       # StandardError, rake will abort and won't run the convert task (https://stackoverflow.com/a/10048406).
@@ -56,9 +54,14 @@ namespace :test do
     print 'List the rules: $ '.magenta
     sh 'bin/mdl -l --style=_checks/styles/style-rules-prod'
     puts 'Linting ...'.magenta
-    output = `bin/mdl --style=_checks/styles/style-rules-prod --ignore-front-matter --git-recurse -- .`
+    output =
+      `bin/mdl \
+      --style=_checks/styles/style-rules-prod \
+      --ignore-front-matter \
+      --git-recurse \
+      -- .`
     puts output.yellow
-    abort "The Markdown linter detected #{output.lines.count - 2} issue(s)".red unless output.empty?
-    puts 'No issues found'.magenta
+    abort "Fix the reported issues".red unless output.empty?
+    puts 'No issues found'.green
   end
 end