Class: Jekyll::Configuration
- Inherits:
-
Hash
- Object
- Hash
- Jekyll::Configuration
- Defined in:
- lib/jekyll/configuration.rb
Constant Summary collapse
- DEFAULTS =
Default options. Overridden by values in _config.yml. Strings rather than symbols are used for compatibility with YAML.
Configuration[{ # Where things are "source" => Dir.pwd, "destination" => File.join(Dir.pwd, "_site"), "collections_dir" => "", "plugins_dir" => "_plugins", "layouts_dir" => "_layouts", "data_dir" => "_data", "includes_dir" => "_includes", "collections" => {}, # Handling Reading "safe" => false, "include" => [".htaccess"], "exclude" => %w( Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/ ), "keep_files" => [".git", ".svn"], "encoding" => "utf-8", "markdown_ext" => "markdown,mkdown,mkdn,mkd,md", "strict_front_matter" => false, # Filtering Content "show_drafts" => nil, "limit_posts" => 0, "future" => false, "unpublished" => false, # Plugins "whitelist" => [], "plugins" => [], # Conversion "markdown" => "kramdown", "highlighter" => "rouge", "lsi" => false, "excerpt_separator" => "\n\n", "incremental" => false, # Serving "detach" => false, # default to not detaching the server "port" => "4000", "host" => "127.0.0.1", "baseurl" => nil, # this mounts at /, i.e. no subdirectory "show_dir_listing" => false, # Output Configuration "permalink" => "date", "paginate_path" => "/page:num", "timezone" => nil, # use the local timezone "quiet" => false, "verbose" => false, "defaults" => [], "liquid" => { "error_mode" => "warn", "strict_filters" => false, "strict_variables" => false, }, "rdiscount" => { "extensions" => [], }, "redcarpet" => { "extensions" => [], }, "kramdown" => { "auto_ids" => true, "toc_levels" => "1..6", "entity_output" => "as_char", "smart_quotes" => "lsquo,rsquo,ldquo,rdquo", "input" => "GFM", "hard_wrap" => false, "footnote_nr" => 1, "show_warnings" => false, }, }.map { |k, v| [k, v.freeze] }].freeze
Class Method Summary collapse
-
.from(user_config) ⇒ Object
Static: Produce a Configuration ready for use in a Site.
Instance Method Summary collapse
- #add_default_collections ⇒ Object
-
#backwards_compatibilize ⇒ Object
Public: Ensure the proper options are set in the configuration to allow for backwards-compatibility with Jekyll pre-1.0.
-
#config_files(override) ⇒ Object
Public: Generate list of configuration files from the override.
-
#csv_to_array(csv) ⇒ Object
Public: Split a CSV string into an array containing its values.
-
#fix_common_issues ⇒ Object
DEPRECATED.
- #get_config_value_with_override(config_key, override) ⇒ Object
- #quiet(override = {}) ⇒ Object (also: #quiet?)
-
#read_config_file(file) ⇒ Object
Public: Read configuration and return merged Hash.
-
#read_config_files(files) ⇒ Object
Public: Read in a list of configuration files and merge with this hash.
- #renamed_key(old, new, config, _ = nil) ⇒ Object
- #safe_load_file(filename) ⇒ Object
-
#source(override) ⇒ Object
Public: Directory of the Jekyll source folder.
-
#stringify_keys ⇒ Object
Public: Turn all keys into string.
- #verbose(override = {}) ⇒ Object (also: #verbose?)
Class Method Details
.from(user_config) ⇒ Object
Static: Produce a Configuration ready for use in a Site. It takes the input, fills in the defaults where values do not exist, and patches common issues including migrating options for backwards compatiblity. Except where a key or value is being fixed, the user configuration will override the defaults.
user_config - a Hash or Configuration of overrides.
Returns a Configuration filled with defaults and fixed for common problems and backwards-compatibility.
100 101 102 103 |
# File 'lib/jekyll/configuration.rb', line 100 def from(user_config) Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys) .add_default_collections end |
Instance Method Details
#add_default_collections ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/jekyll/configuration.rb', line 256 def add_default_collections config = clone # It defaults to `{}`, so this is only if someone sets it to null manually. return config if config["collections"].nil? # Ensure we have a hash. if config["collections"].is_a?(Array) config["collections"] = Hash[config["collections"].map { |c| [c, {}] }] end config["collections"] = Utils.deep_merge_hashes( { "posts" => {} }, config["collections"] ).tap do |collections| collections["posts"]["output"] = true if config["permalink"] collections["posts"]["permalink"] ||= style_to_permalink(config["permalink"]) end end config end |
#backwards_compatibilize ⇒ Object
Public: Ensure the proper options are set in the configuration to allow for backwards-compatibility with Jekyll pre-1.0
Returns the backwards-compatible configuration
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/jekyll/configuration.rb', line 231 def backwards_compatibilize config = clone # Provide backwards-compatibility check_auto(config) check_server(config) check_plugins(config) renamed_key "server_port", "port", config renamed_key "gems", "plugins", config renamed_key "layouts", "layouts_dir", config renamed_key "data_source", "data_dir", config check_pygments(config) check_include_exclude(config) check_coderay(config) check_maruku(config) config end |
#config_files(override) ⇒ Object
Public: Generate list of configuration files from the override
override - the command-line options hash
Returns an Array of config files
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/jekyll/configuration.rb', line 154 def config_files(override) # Adjust verbosity quickly Jekyll.logger.adjust_verbosity( :quiet => quiet?(override), :verbose => verbose?(override) ) # Get configuration from <source>/_config.yml or <source>/<config_file> config_files = override["config"] if config_files.to_s.empty? default = %w(yml yaml).find(-> { "yml" }) do |ext| File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}")) end config_files = Jekyll.sanitized_path(source(override), "_config.#{default}") @default_config_file = true end Array(config_files) end |
#csv_to_array(csv) ⇒ Object
Public: Split a CSV string into an array containing its values
csv - the string of comma-separated values
Returns an array of the values contained in the CSV
223 224 225 |
# File 'lib/jekyll/configuration.rb', line 223 def csv_to_array(csv) csv.split(",").map(&:strip) end |
#fix_common_issues ⇒ Object
DEPRECATED.
252 253 254 |
# File 'lib/jekyll/configuration.rb', line 252 def fix_common_issues self end |
#get_config_value_with_override(config_key, override) ⇒ Object
113 114 115 |
# File 'lib/jekyll/configuration.rb', line 113 def get_config_value_with_override(config_key, override) override[config_key] || self[config_key] || DEFAULTS[config_key] end |
#quiet(override = {}) ⇒ Object Also known as: quiet?
126 127 128 |
# File 'lib/jekyll/configuration.rb', line 126 def quiet(override = {}) get_config_value_with_override("quiet", override) end |
#read_config_file(file) ⇒ Object
Public: Read configuration and return merged Hash
file - the path to the YAML file to be read in
Returns this configuration, overridden by the values in the file
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/jekyll/configuration.rb', line 178 def read_config_file(file) next_config = safe_load_file(file) check_config_is_hash!(next_config, file) Jekyll.logger.info "Configuration file:", file next_config rescue SystemCallError if @default_config_file ||= nil Jekyll.logger.warn "Configuration file:", "none" {} else Jekyll.logger.error "Fatal:", "The configuration file '#{file}' could not be found." raise LoadError, "The Configuration file '#{file}' could not be found." end end |
#read_config_files(files) ⇒ Object
Public: Read in a list of configuration files and merge with this hash
files - the list of configuration file paths
Returns the full configuration, with the defaults overridden by the values in the configuration files
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/jekyll/configuration.rb', line 200 def read_config_files(files) configuration = clone begin files.each do |config_file| next if config_file.nil? || config_file.empty? new_config = read_config_file(config_file) configuration = Utils.deep_merge_hashes(configuration, new_config) end rescue ArgumentError => err Jekyll.logger.warn "WARNING:", "Error reading configuration. " \ "Using defaults (and options)." warn err end configuration.backwards_compatibilize.add_default_collections end |
#renamed_key(old, new, config, _ = nil) ⇒ Object
279 280 281 282 283 284 285 286 |
# File 'lib/jekyll/configuration.rb', line 279 def renamed_key(old, new, config, _ = nil) if config.key?(old) Jekyll::Deprecator. "The '#{old}' configuration" \ " option has been renamed to '#{new}'. Please update your config" \ " file accordingly." config[new] = config.delete(old) end end |
#safe_load_file(filename) ⇒ Object
136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/jekyll/configuration.rb', line 136 def safe_load_file(filename) case File.extname(filename) when %r!\.toml!i Jekyll::External.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb) Tomlrb.load_file(filename) when %r!\.ya?ml!i SafeYAML.load_file(filename) || {} else raise ArgumentError, "No parser for '#{filename}' is available. Use a .y(a)ml or .toml file instead." end end |
#source(override) ⇒ Object
Public: Directory of the Jekyll source folder
override - the command-line options hash
Returns the path to the Jekyll source directory
122 123 124 |
# File 'lib/jekyll/configuration.rb', line 122 def source(override) get_config_value_with_override("source", override) end |
#stringify_keys ⇒ Object
Public: Turn all keys into string
Return a copy of the hash where all its keys are strings
109 110 111 |
# File 'lib/jekyll/configuration.rb', line 109 def stringify_keys reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) } end |
#verbose(override = {}) ⇒ Object Also known as: verbose?
131 132 133 |
# File 'lib/jekyll/configuration.rb', line 131 def verbose(override = {}) get_config_value_with_override("verbose", override) end |