jekyll-v4-github-pages 232 → 233

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec66e769e01b1d4742041cc722e946ca77166e9a0df03106688651d4455ce04
-  data.tar.gz: 56ad6f63329c5d397c3a7f489a45c82f1e9fa5f13b59face93a07f6937ecd89b
+  metadata.gz: 6261b7568c6aaf356ce8046a6f73877535b2acfa3ff7e539a14c02529c546cd4
+  data.tar.gz: 1ca23404fd54cd61efc08c24bde40e86d5d8e2d30dae3332d771dfd95139dd16
 SHA512:
-  metadata.gz: a930e8f7b707ae7d2c4362c7b2d9531397558361450fd53223f31619f7054a82cb265f679dc5c99a1578de68fa86093ddf492168faef476cabd601a101dd42c7
-  data.tar.gz: 9a9763209bc8c9b64dbd40e453c29ef6f288e0297679b646da9bc515e148a251d580eb5d2ad631ed947711f1c0826ce76b65786e980bbf2ae7018488442d4f76
+  metadata.gz: 94c8a430291c9f6609f2175ea5d14da77222b2c3f60e5aea4d58f3e3acc745b744ff7a1f8ade3ad2f0fce59103f26c262a0465a8515c47431b12b0eb149090dd
+  data.tar.gz: c2b43512877eb1d2f4fb7cf44b4731bbeb6ba22f1ec44e6be3b9d46d133a1b8f67ae63ba35bd63d1a4970cc9604debfb16eb90dd4446d9401dd9dbcb73084d1a

data/bin/jekyll-v4-github-pages

@@ -65,8 +65,21 @@ Mercenary.program(:"jekyll-v4-github-pages") do |p|
     c.option 'source', '--source DIR', 'From where to collect the source files'
     c.option 'destination', '--destination DIR', 'To where the compiled files should be written'
     c.option 'future', '--future', 'Publishes posts with a future date'
+    c.option 'config', '--config FILE1[,FILE2[,FILE3]]', Array, 'Specify config files instead of using _config.yml'
 
     c.action do |_, options|
+      config = options["config"] || ["_config.yml"]
+
+      default_config = File.expand_path("../../lib/_default_config.yml", __FILE__)
+      options["config"] = [default_config]
+
+      config.each { |item|
+        user_config = File.join(options["source"] || Dir.pwd, item)
+        if File.exist?(user_config)
+          options["config"].push(user_config)
+        end
+      }
+      
       Jekyll::Commands::Build.process(options)
     end
   end

data/lib/_default_config.yml

@@ -0,0 +1,23 @@
+# Default, user overwritable options
+jailed: false
+future: false
+theme: jekyll-v4-theme-primer
+markdown: kramdown
+kramdown:
+  input: GFM
+  hard_wrap: false
+  gfm_quirks: paragraph_end
+  syntax_highlighter_opts:
+    default_lang: plaintext
+  template: ""
+  math_engine: mathjax
+  syntax_highlighter: rouge
+exclude:
+  - CNAME
+
+# Previously not overwritable, now these can be configured as well
+lsi: false
+safe: true
+highlighter: rouge
+gist:
+  noscript: false

data/lib/github-pages/configuration.rb

@@ -3,7 +3,8 @@
 require "securerandom"
 
 module GitHubPages
-  # Sets and manages Jekyll configuration defaults and overrides
+  # Sets and manages Jekyll configuration defaults
+  # Most configuration is now set in _default_config.yml
   class Configuration
     # Backward compatability of constants
     DEFAULT_PLUGINS     = GitHubPages::Plugins::DEFAULT_PLUGINS
@@ -11,57 +12,13 @@ module GitHubPages
     DEVELOPMENT_PLUGINS = GitHubPages::Plugins::DEVELOPMENT_PLUGINS
     THEMES              = GitHubPages::Plugins::THEMES
 
-    # Default, user overwritable options
-    DEFAULTS = {
-      "jailed" => false,
-      "plugins" => GitHubPages::Plugins::DEFAULT_PLUGINS,
-      "future" => true,
-      "theme" => "jekyll-v4-theme-primer",
-      "markdown" => "kramdown",
-      "kramdown" => {
-        "input" => "GFM",
-        "hard_wrap" => false,
-        "gfm_quirks" => "paragraph_end",
-        "syntax_highlighter_opts" => {
-          "default_lang" => "plaintext",
-        },
-      },
-      "exclude" => ["CNAME"],
-    }.freeze
-
     # User-overwritable defaults used only in production for practical reasons
-    PRODUCTION_DEFAULTS = Jekyll::Utils.deep_merge_hashes DEFAULTS, {
+    PRODUCTION_DEFAULTS = {
       "sass" => {
         "style" => "compressed",
       },
     }.freeze
 
-    # Options which GitHub Pages sets, regardless of the user-specified value
-    #
-    # The following values are also overridden by GitHub Pages, but are not
-    # overridden locally, for practical purposes:
-    # * source
-    # * destination
-    # * jailed
-    # * verbose
-    # * incremental
-    # * GH_ENV
-    OVERRIDES = {
-      "lsi" => false,
-      "safe" => true,
-      "plugins_dir" => SecureRandom.hex,
-      "whitelist" => GitHubPages::Plugins::PLUGIN_WHITELIST,
-      "highlighter" => "rouge",
-      "kramdown" => {
-        "template" => "",
-        "math_engine" => "mathjax",
-        "syntax_highlighter" => "rouge",
-      },
-      "gist" => {
-        "noscript" => false,
-      },
-    }.freeze
-
     class << self
       def processed?(site)
         site.instance_variable_get(:@_github_pages_processed) == true
@@ -79,31 +36,19 @@ module GitHubPages
         Jekyll.env == "development"
       end
 
-      def defaults_for_env
-        defaults = development? ? DEFAULTS : PRODUCTION_DEFAULTS
-        Jekyll::Utils.deep_merge_hashes Jekyll::Configuration::DEFAULTS, defaults
-      end
-
-      # Given a user's config, determines the effective configuration by building a user
-      # configuration sandwhich with our overrides overriding the user's specified
-      # values which themselves override our defaults.
-      #
       # Returns the effective Configuration
       #
       # Note: this is a highly modified version of Jekyll#configuration
       def effective_config(user_config)
-        # Merge user config into defaults
-        config = Jekyll::Utils.deep_merge_hashes(defaults_for_env, user_config)
-          .add_default_collections
+        config = user_config
+        if !development?
+          config = Jekyll::Utils.deep_merge_hashes PRODUCTION_DEFAULTS, config
+        end
 
         # Allow theme to be explicitly disabled via "theme: null"
         config["theme"] = user_config["theme"] if user_config.key?("theme")
 
         migrate_theme_to_remote_theme(config)
-        exclude_cname(config)
-
-        # Merge overwrites into user config
-        config = Jekyll::Utils.deep_merge_hashes config, OVERRIDES
 
         restrict_and_config_markdown_processor(config)
 
@@ -123,7 +68,7 @@ module GitHubPages
         processed(site)
       end
 
-      # Set the site's configuration with all the proper defaults and overrides.
+      # Set the site's configuration with all the proper defaults.
       # Should be called by #set to protect against multiple processings.
       def set!(site)
         site.config = effective_config(site.config)
@@ -154,17 +99,11 @@ module GitHubPages
         # This functionality has been rolled back due to complications with jekyll-remote-theme.
       end
 
-      # If the user's 'exclude' config is the default, also exclude the CNAME
-      def exclude_cname(config)
-        return unless config["exclude"].eql? Jekyll::Configuration::DEFAULT_EXCLUDES
-
-        config["exclude"].concat(DEFAULTS["exclude"])
-      end
-
       # Requires default plugins and configures whitelist in development
       def configure_plugins(config)
         # Ensure we have those gems we want.
         config["plugins"] = Array(config["plugins"]) | DEFAULT_PLUGINS
+        config["whitelist"] = Array(config["whitelist"]) | PLUGIN_WHITELIST
 
         # To minimize errors, lazy-require jekyll-remote-theme if requested by the user
         config["plugins"].push("jekyll-remote-theme") if config.key? "remote_theme"

data/lib/github-pages/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHubPages
-  VERSION = 232
+  VERSION = 233
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-v4-github-pages
 version: !ruby/object:Gem::Version
-  version: '232'
+  version: '233'
 platform: ruby
 authors:
 - GitHub, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -700,6 +700,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - bin/jekyll-v4-github-pages
+- lib/_default_config.yml
 - lib/github-pages.rb
 - lib/github-pages/configuration.rb
 - lib/github-pages/dependencies.rb