Update docs and code formatting

magento · Aug 12, 2019 · c007adb · c007adb
1 parent 0edc999
commit c007adb
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 8 deletions.
diff --git a/Rakefile b/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

diff --git a/_checks/md_check_hook.rb b/_checks/md_check_hook.rb
@@ -1,16 +1,20 @@
+# 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/styles/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}`

diff --git a/lib/link_checker.rb b/lib/link_checker.rb
@@ -13,6 +13,7 @@ def self.options
     config = YAML.load_file('_config.checks.yml')
     baseurl = ENV['BUILD_NUMBER']
     return config['html-proofer'] unless baseurl
+
     url_swap = { url_swap: { %r{\A/#{baseurl}} => '' } }
     config['html-proofer'].merge(url_swap)
   end

diff --git a/rakelib/check.rake b/rakelib/check.rake
@@ -1,3 +1,5 @@
+# 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).'
   task :image_optim do
@@ -24,6 +26,6 @@ namespace :check do
     puts 'Running Markdown linter ...'.magenta
     report = `bin/mdl #{path}`
     puts report.yellow
-    puts 'The rules are defined in _checks/styles/md_style'.magenta
+    puts 'The rules are defined in _checks/styles/style-rules-dev'.magenta
   end
 end
diff --git a/rakelib/multirepo.rake b/rakelib/multirepo.rake
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :multirepo do
   desc 'Create a file tree for devdocs website and get all required content'
   task :init do

diff --git a/rakelib/test.rake b/rakelib/test.rake
@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 namespace :test do
-  # Run htmlproofer to check for broken links
+  # Run html-proofer to check for broken links
   desc 'Build devdocs and check for broken links'
   task links: %w[build links_no_build]
 
   desc 'Check the existing _site for broken links on Jenkins'
   task cicd: %w[style] do
-    puts 'Checking links with htmlproofer...'.magenta
+    puts 'Checking links with html-proofer...'.magenta
 
     LinkChecker.check_site
   end
@@ -20,7 +20,7 @@ namespace :test do
       report = LinkChecker.md_report_path
       $stderr.reopen(report, 'w+')
 
-      puts 'Checking links with htmlproofer...'.magenta
+      puts 'Checking links with html-proofer...'.magenta
       LinkChecker.check_site
 
       # We're expecting link validation errors, but unless we rescue from

diff --git a/rakelib/update.rake b/rakelib/update.rake
@@ -73,7 +73,7 @@ namespace :update do
     sh 'git status -sb'
   end
 
-  desc 'Update devodcs and subrepositories'
+  desc 'Update devdocs and subrepositories'
   task all: %w[devdocs subrepos]
 
   desc 'Update subrepositories only'