jekyll 4.2.1 → 4.3.2

data/lib/jekyll/command.rb

@@ -1,105 +1,105 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Command
-    class << self
-      # A list of subclasses of Jekyll::Command
-      def subclasses
-        @subclasses ||= []
-      end
-
-      # Keep a list of subclasses of Jekyll::Command every time it's inherited
-      # Called automatically.
-      #
-      # base - the subclass
-      #
-      # Returns nothing
-      def inherited(base)
-        subclasses << base
-        super(base)
-      end
-
-      # Run Site#process and catch errors
-      #
-      # site - the Jekyll::Site object
-      #
-      # Returns nothing
-      def process_site(site)
-        site.process
-      rescue Jekyll::Errors::FatalException => e
-        Jekyll.logger.error "ERROR:", "YOUR SITE COULD NOT BE BUILT:"
-        Jekyll.logger.error "", "------------------------------------"
-        Jekyll.logger.error "", e.message
-        exit(1)
-      end
-
-      # Create a full Jekyll configuration with the options passed in as overrides
-      #
-      # options - the configuration overrides
-      #
-      # Returns a full Jekyll configuration
-      def configuration_from_options(options)
-        return options if options.is_a?(Jekyll::Configuration)
-
-        Jekyll.configuration(options)
-      end
-
-      # Add common options to a command for building configuration
-      #
-      # cmd - the Jekyll::Command to add these options to
-      #
-      # Returns nothing
-      # rubocop:disable Metrics/MethodLength
-      def add_build_options(cmd)
-        cmd.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
-                   Array, "Custom configuration file"
-        cmd.option "destination", "-d", "--destination DESTINATION",
-                   "The current folder will be generated into DESTINATION"
-        cmd.option "source", "-s", "--source SOURCE", "Custom source directory"
-        cmd.option "future", "--future", "Publishes posts with a future date"
-        cmd.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
-                   "Limits the number of posts to parse and publish"
-        cmd.option "watch", "-w", "--[no-]watch", "Watch for changes and rebuild"
-        cmd.option "baseurl", "-b", "--baseurl URL",
-                   "Serve the website from the given base URL"
-        cmd.option "force_polling", "--force_polling", "Force watch to use polling"
-        cmd.option "lsi", "--lsi", "Use LSI for improved related posts"
-        cmd.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
-        cmd.option "unpublished", "--unpublished",
-                   "Render posts that were marked as unpublished"
-        cmd.option "disable_disk_cache", "--disable-disk-cache",
-                   "Disable caching to disk in non-safe mode"
-        cmd.option "quiet", "-q", "--quiet", "Silence output."
-        cmd.option "verbose", "-V", "--verbose", "Print verbose output."
-        cmd.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
-        cmd.option "strict_front_matter", "--strict_front_matter",
-                   "Fail if errors are present in front matter"
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      # Run ::process method in a given set of Jekyll::Command subclasses and suggest
-      # re-running the associated command with --trace switch to obtain any additional
-      # information or backtrace regarding the encountered Exception.
-      #
-      # cmd     - the Jekyll::Command to be handled
-      # options - configuration overrides
-      # klass   - an array of Jekyll::Command subclasses associated with the command
-      #
-      # Note that all exceptions are rescued..
-      # rubocop: disable Lint/RescueException
-      def process_with_graceful_fail(cmd, options, *klass)
-        klass.each { |k| k.process(options) if k.respond_to?(:process) }
-      rescue Exception => e
-        raise e if cmd.trace
-
-        msg = " Please append `--trace` to the `#{cmd.name}` command "
-        dashes = "-" * msg.length
-        Jekyll.logger.error "", dashes
-        Jekyll.logger.error "Jekyll #{Jekyll::VERSION} ", msg
-        Jekyll.logger.error "", " for any additional information or backtrace. "
-        Jekyll.logger.abort_with "", dashes
-      end
-      # rubocop: enable Lint/RescueException
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Command
+    class << self
+      # A list of subclasses of Jekyll::Command
+      def subclasses
+        @subclasses ||= []
+      end
+
+      # Keep a list of subclasses of Jekyll::Command every time it's inherited
+      # Called automatically.
+      #
+      # base - the subclass
+      #
+      # Returns nothing
+      def inherited(base)
+        subclasses << base
+        super(base)
+      end
+
+      # Run Site#process and catch errors
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns nothing
+      def process_site(site)
+        site.process
+      rescue Jekyll::Errors::FatalException => e
+        Jekyll.logger.error "ERROR:", "YOUR SITE COULD NOT BE BUILT:"
+        Jekyll.logger.error "", "------------------------------------"
+        Jekyll.logger.error "", e.message
+        exit(1)
+      end
+
+      # Create a full Jekyll configuration with the options passed in as overrides
+      #
+      # options - the configuration overrides
+      #
+      # Returns a full Jekyll configuration
+      def configuration_from_options(options)
+        return options if options.is_a?(Jekyll::Configuration)
+
+        Jekyll.configuration(options)
+      end
+
+      # Add common options to a command for building configuration
+      #
+      # cmd - the Jekyll::Command to add these options to
+      #
+      # Returns nothing
+      # rubocop:disable Metrics/MethodLength
+      def add_build_options(cmd)
+        cmd.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
+                   Array, "Custom configuration file"
+        cmd.option "destination", "-d", "--destination DESTINATION",
+                   "The current folder will be generated into DESTINATION"
+        cmd.option "source", "-s", "--source SOURCE", "Custom source directory"
+        cmd.option "future", "--future", "Publishes posts with a future date"
+        cmd.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
+                   "Limits the number of posts to parse and publish"
+        cmd.option "watch", "-w", "--[no-]watch", "Watch for changes and rebuild"
+        cmd.option "baseurl", "-b", "--baseurl URL",
+                   "Serve the website from the given base URL"
+        cmd.option "force_polling", "--force_polling", "Force watch to use polling"
+        cmd.option "lsi", "--lsi", "Use LSI for improved related posts"
+        cmd.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
+        cmd.option "unpublished", "--unpublished",
+                   "Render posts that were marked as unpublished"
+        cmd.option "disable_disk_cache", "--disable-disk-cache",
+                   "Disable caching to disk in non-safe mode"
+        cmd.option "quiet", "-q", "--quiet", "Silence output."
+        cmd.option "verbose", "-V", "--verbose", "Print verbose output."
+        cmd.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
+        cmd.option "strict_front_matter", "--strict_front_matter",
+                   "Fail if errors are present in front matter"
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # Run ::process method in a given set of Jekyll::Command subclasses and suggest
+      # re-running the associated command with --trace switch to obtain any additional
+      # information or backtrace regarding the encountered Exception.
+      #
+      # cmd     - the Jekyll::Command to be handled
+      # options - configuration overrides
+      # klass   - an array of Jekyll::Command subclasses associated with the command
+      #
+      # Note that all exceptions are rescued..
+      # rubocop: disable Lint/RescueException
+      def process_with_graceful_fail(cmd, options, *klass)
+        klass.each { |k| k.process(options) if k.respond_to?(:process) }
+      rescue Exception => e
+        raise e if cmd.trace
+
+        msg = " Please append `--trace` to the `#{cmd.name}` command "
+        dashes = "-" * msg.length
+        Jekyll.logger.error "", dashes
+        Jekyll.logger.error "Jekyll #{Jekyll::VERSION} ", msg
+        Jekyll.logger.error "", " for any additional information or backtrace. "
+        Jekyll.logger.abort_with "", dashes
+      end
+      # rubocop: enable Lint/RescueException
+    end
+  end
+end

data/lib/jekyll/commands/build.rb

@@ -1,93 +1,82 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Commands
-    class Build < Command
-      class << self
-        # Create the Mercenary command for the Jekyll CLI for this Command
-        def init_with_program(prog)
-          prog.command(:build) do |c|
-            c.syntax      "build [options]"
-            c.description "Build your site"
-            c.alias :b
-
-            add_build_options(c)
-
-            c.action do |_, options|
-              options["serving"] = false
-              process_with_graceful_fail(c, options, self)
-            end
-          end
-        end
-
-        # Build your jekyll site
-        # Continuously watch if `watch` is set to true in the config.
-        def process(options)
-          # Adjust verbosity quickly
-          Jekyll.logger.adjust_verbosity(options)
-
-          options = configuration_from_options(options)
-          site = Jekyll::Site.new(options)
-
-          if options.fetch("skip_initial_build", false)
-            Jekyll.logger.warn "Build Warning:", "Skipping the initial build." \
-                               " This may result in an out-of-date site."
-          else
-            build(site, options)
-          end
-
-          if options.fetch("detach", false)
-            Jekyll.logger.info "Auto-regeneration:",
-                               "disabled when running server detached."
-          elsif options.fetch("watch", false)
-            watch(site, options)
-          else
-            Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
-          end
-        end
-
-        # Build your Jekyll site.
-        #
-        # site - the Jekyll::Site instance to build
-        # options - A Hash of options passed to the command
-        #
-        # Returns nothing.
-        def build(site, options)
-          t = Time.now
-          source      = File.expand_path(options["source"])
-          destination = File.expand_path(options["destination"])
-          incremental = options["incremental"]
-          Jekyll.logger.info "Source:", source
-          Jekyll.logger.info "Destination:", destination
-          Jekyll.logger.info "Incremental build:",
-                             (incremental ? "enabled" : "disabled. Enable with --incremental")
-          Jekyll.logger.info "Generating..."
-          process_site(site)
-          Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
-        end
-
-        # Private: Watch for file changes and rebuild the site.
-        #
-        # site - A Jekyll::Site instance
-        # options - A Hash of options passed to the command
-        #
-        # Returns nothing.
-        def watch(site, options)
-          # Warn Windows users that they might need to upgrade.
-          if Utils::Platforms.bash_on_windows?
-            Jekyll.logger.warn "",
-                               "Auto-regeneration may not work on some Windows versions."
-            Jekyll.logger.warn "",
-                               "Please see: https://github.com/Microsoft/BashOnWindows/issues/216"
-            Jekyll.logger.warn "",
-                               "If it does not work, please upgrade Bash on Windows or "\
-                               "run Jekyll with --no-watch."
-          end
-
-          External.require_with_graceful_fail "jekyll-watch"
-          Jekyll::Watcher.watch(options, site)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Commands
+    class Build < Command
+      class << self
+        # Create the Mercenary command for the Jekyll CLI for this Command
+        def init_with_program(prog)
+          prog.command(:build) do |c|
+            c.syntax      "build [options]"
+            c.description "Build your site"
+            c.alias :b
+
+            add_build_options(c)
+
+            c.action do |_, options|
+              options["serving"] = false
+              process_with_graceful_fail(c, options, self)
+            end
+          end
+        end
+
+        # Build your jekyll site
+        # Continuously watch if `watch` is set to true in the config.
+        def process(options)
+          # Adjust verbosity quickly
+          Jekyll.logger.adjust_verbosity(options)
+
+          options = configuration_from_options(options)
+          site = Jekyll::Site.new(options)
+
+          if options.fetch("skip_initial_build", false)
+            Jekyll.logger.warn "Build Warning:",
+                               "Skipping the initial build. This may result in an out-of-date site."
+          else
+            build(site, options)
+          end
+
+          if options.fetch("detach", false)
+            Jekyll.logger.info "Auto-regeneration:",
+                               "disabled when running server detached."
+          elsif options.fetch("watch", false)
+            watch(site, options)
+          else
+            Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
+          end
+        end
+
+        # Build your Jekyll site.
+        #
+        # site - the Jekyll::Site instance to build
+        # options - A Hash of options passed to the command
+        #
+        # Returns nothing.
+        def build(site, options)
+          t = Time.now
+          source      = File.expand_path(options["source"])
+          destination = File.expand_path(options["destination"])
+          incremental = options["incremental"]
+          Jekyll.logger.info "Source:", source
+          Jekyll.logger.info "Destination:", destination
+          Jekyll.logger.info "Incremental build:",
+                             (incremental ? "enabled" : "disabled. Enable with --incremental")
+          Jekyll.logger.info "Generating..."
+          process_site(site)
+          Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
+        end
+
+        # Private: Watch for file changes and rebuild the site.
+        #
+        # site - A Jekyll::Site instance
+        # options - A Hash of options passed to the command
+        #
+        # Returns nothing.
+        def watch(site, options)
+          External.require_with_graceful_fail "jekyll-watch"
+          Jekyll::Watcher.watch(options, site)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/clean.rb

@@ -1,45 +1,44 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Commands
-    class Clean < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:clean) do |c|
-            c.syntax "clean [subcommand]"
-            c.description "Clean the site " \
-                  "(removes site output and metadata file) without building."
-
-            add_build_options(c)
-
-            c.action do |_, options|
-              Jekyll::Commands::Clean.process(options)
-            end
-          end
-        end
-
-        def process(options)
-          options = configuration_from_options(options)
-          destination = options["destination"]
-          metadata_file = File.join(options["source"], ".jekyll-metadata")
-          cache_dir = File.join(options["source"], options["cache_dir"])
-          sass_cache = ".sass-cache"
-
-          remove(destination, :checker_func => :directory?)
-          remove(metadata_file, :checker_func => :file?)
-          remove(cache_dir, :checker_func => :directory?)
-          remove(sass_cache, :checker_func => :directory?)
-        end
-
-        def remove(filename, checker_func: :file?)
-          if File.public_send(checker_func, filename)
-            Jekyll.logger.info "Cleaner:", "Removing #{filename}..."
-            FileUtils.rm_rf(filename)
-          else
-            Jekyll.logger.info "Cleaner:", "Nothing to do for #{filename}."
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Commands
+    class Clean < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:clean) do |c|
+            c.syntax "clean [subcommand]"
+            c.description "Clean the site (removes site output and metadata file) without building."
+
+            add_build_options(c)
+
+            c.action do |_, options|
+              Jekyll::Commands::Clean.process(options)
+            end
+          end
+        end
+
+        def process(options)
+          options = configuration_from_options(options)
+          destination = options["destination"]
+          metadata_file = File.join(options["source"], ".jekyll-metadata")
+          cache_dir = File.join(options["source"], options["cache_dir"])
+          sass_cache = ".sass-cache"
+
+          remove(destination, :checker_func => :directory?)
+          remove(metadata_file, :checker_func => :file?)
+          remove(cache_dir, :checker_func => :directory?)
+          remove(sass_cache, :checker_func => :directory?)
+        end
+
+        def remove(filename, checker_func: :file?)
+          if File.public_send(checker_func, filename)
+            Jekyll.logger.info "Cleaner:", "Removing #{filename}..."
+            FileUtils.rm_rf(filename)
+          else
+            Jekyll.logger.info "Cleaner:", "Nothing to do for #{filename}."
+          end
+        end
+      end
+    end
+  end
+end