class Jekyll::Configuration

Constants

DEFAULTS

Default options. Overridden by values in _config.yml. Strings rather than symbols are used for compatibility with YAML.

Public Instance Methods

add_default_collections() click to toggle source
# File lib/jekyll/configuration.rb, line 269
def add_default_collections
  config = clone

  return config if config['collections'].nil?

  if config['collections'].is_a?(Array)
    config['collections'] = Hash[config['collections'].map { |c| [c, {}] }]
  end
  config['collections']['posts'] ||= {}
  config['collections']['posts']['output'] = true
  config['collections']['posts']['permalink'] = style_to_permalink(config['permalink'])

  config
end
backwards_compatibilize() click to toggle source

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

# File lib/jekyll/configuration.rb, line 195
def backwards_compatibilize
  config = clone
  # Provide backwards-compatibility
  if config.key?('auto') || config.key?('watch')
    Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer"                              " be set from your configuration file(s). Use the"                             " --[no-]watch/-w command-line option instead."
    config.delete('auto')
    config.delete('watch')
  end

  if config.key? 'server'
    Jekyll::Deprecator.deprecation_message "The 'server' configuration option"                              " is no longer accepted. Use the 'jekyll serve'"                              " subcommand to serve your site with WEBrick."
    config.delete('server')
  end

  renamed_key 'server_port', 'port', config
  renamed_key 'plugins', 'plugins_dir', config
  renamed_key 'layouts', 'layouts_dir', config
  renamed_key 'data_source', 'data_dir', config

  if config.key? 'pygments'
    Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option"                              " has been renamed to 'highlighter'. Please update your"                              " config file accordingly. The allowed values are 'rouge', "                              "'pygments' or null."

    config['highlighter'] = 'pygments' if config['pygments']
    config.delete('pygments')
  end

  %w(include exclude).each do |option|
    config[option] ||= []
    if config[option].is_a?(String)
      Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option"              " must now be specified as an array, but you specified"              " a string. For now, we've treated the string you provided"              " as a list of comma-separated values."
      config[option] = csv_to_array(config[option])
    end
    config[option].map!(&:to_s)
  end

  if (config['kramdown'] || {}).key?('use_coderay')
    Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'"            " to 'enable_coderay' in your configuration file."
    config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay')
  end

  if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
    Jekyll.logger.abort_with "Error:", "You're using the 'maruku' "            "Markdown processor, which has been removed as of 3.0.0. "            "We recommend you switch to Kramdown. To do this, replace "            "`markdown: maruku` with `markdown: kramdown` in your "            "`_config.yml` file."
  end

  config
end
config_files(override) click to toggle source

Public: Generate list of configuration files from the override

override - the command-line options hash

Returns an Array of config files

# File lib/jekyll/configuration.rb, line 122
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.delete('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
  config_files = [config_files] unless config_files.is_a? Array
  config_files
end
csv_to_array(csv) click to toggle source

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

# File lib/jekyll/configuration.rb, line 187
def csv_to_array(csv)
  csv.split(",").map(&:strip)
end
fix_common_issues() click to toggle source
# File lib/jekyll/configuration.rb, line 257
def fix_common_issues
  config = clone

  if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
    Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a"            " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
    config['paginate'] = nil
  end

  config
end
get_config_value_with_override(config_key, override) click to toggle source
# File lib/jekyll/configuration.rb, line 82
def get_config_value_with_override(config_key, override)
  override[config_key] || self[config_key] || DEFAULTS[config_key]
end
quiet(override = {}) click to toggle source
# File lib/jekyll/configuration.rb, line 95
def quiet(override = {})
  get_config_value_with_override('quiet', override)
end
Also aliased as: quiet?
quiet?(override = {})
Alias for: quiet
read_config_file(file) click to toggle source

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

# File lib/jekyll/configuration.rb, line 144
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
    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) click to toggle source

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

# File lib/jekyll/configuration.rb, line 165
def read_config_files(files)
  configuration = clone

  begin
    files.each do |config_file|
      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)."
    $stderr.puts "#{err}"
  end

  configuration.fix_common_issues.backwards_compatibilize.add_default_collections
end
renamed_key(old, new, config, _ = nil) click to toggle source
# File lib/jekyll/configuration.rb, line 284
def renamed_key(old, new, config, _ = nil)
  if config.key?(old)
    Jekyll::Deprecator.deprecation_message "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) click to toggle source
# File lib/jekyll/configuration.rb, line 105
def safe_load_file(filename)
  case File.extname(filename)
  when /\.toml/i
    Jekyll::External.require_with_graceful_fail('toml') unless defined?(TOML)
    TOML.load_file(filename)
  when /\.ya?ml/i
    SafeYAML.load_file(filename) || {}
  else
    raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
  end
end
source(override) click to toggle source

Public: Directory of the Jekyll source folder

override - the command-line options hash

Returns the path to the Jekyll source directory

# File lib/jekyll/configuration.rb, line 91
def source(override)
  get_config_value_with_override('source', override)
end
stringify_keys() click to toggle source

Public: Turn all keys into string

Return a copy of the hash where all its keys are strings

# File lib/jekyll/configuration.rb, line 78
def stringify_keys
  reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
end
verbose(override = {}) click to toggle source
# File lib/jekyll/configuration.rb, line 100
def verbose(override = {})
  get_config_value_with_override('verbose', override)
end
Also aliased as: verbose?
verbose?(override = {})
Alias for: verbose

Private Instance Methods

check_config_is_hash!(extracted_config, file) click to toggle source

Private: Checks if a given config is a hash

extracted_config - the value to check file - the file from which the config was extracted

Raises an ArgumentError if given config is not a hash

# File lib/jekyll/configuration.rb, line 316
def check_config_is_hash!(extracted_config, file)
  unless extracted_config.is_a?(Hash)
    raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow)
  end
end