Module: Bridgetown::Commands::ConfigurationOverridable

Included in:

Build, Clean, Console, Plugins::CD, Plugins::List, Start

Defined in:

bridgetown-core/lib/bridgetown-core/commands/concerns/configuration_overridable.rb

Class Method Summary

• .include_options(klass) ⇒ Object

Instance Method Summary

• #configuration_with_overrides(options, preloaded = nil) ⇒ Bridgetown::Configuration

  Create a full Bridgetown configuration with the options passed in as overrides.

Class Method Details

.include_options(klass) ⇒ Object

# File 'bridgetown-core/lib/bridgetown-core/commands/concerns/configuration_overridable.rb', line 6

def self.include_options(klass)
  desc = "The environment used for this command (aka development, test, production, etc.)"
  klass.option "-e/--environment <ENV>", desc
end

Instance Method Details

#configuration_with_overrides(options, preloaded = nil) ⇒ Bridgetown::Configuration

Create a full Bridgetown configuration with the options passed in as overrides

Parameters:

• options (Hash) —

  the configuration overrides

• preloaded (Bridgetown::Configuration, Bridgetown::Configuration::Preflight) (defaults to: nil) —

  a preloaded config or preflight

Returns:

• (Bridgetown::Configuration) —

  a full Bridgetown configuration

# File 'bridgetown-core/lib/bridgetown-core/commands/concerns/configuration_overridable.rb', line 17

def configuration_with_overrides(options, preloaded = nil)
  return preloaded.merge!(options) if preloaded.is_a?(Bridgetown::Configuration)

  Bridgetown.configuration(options)
end