Class: Icons::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/icons/configuration.rb,
lib/icons/configuration/flags.rb,
lib/icons/configuration/radix.rb,
lib/icons/configuration/linear.rb,
lib/icons/configuration/lucide.rb,
lib/icons/configuration/tabler.rb,
lib/icons/configuration/feather.rb,
lib/icons/configuration/options.rb,
lib/icons/configuration/weather.rb,
lib/icons/configuration/animated.rb,
lib/icons/configuration/boxicons.rb,
lib/icons/configuration/phosphor.rb,
lib/icons/configuration/heroicons.rb,
lib/icons/configuration/hugeicons.rb,
lib/icons/configuration/sidekickicons.rb

Defined Under Namespace

Modules: Animated, Boxicons, Feather, Flags, Heroicons, Hugeicons, Linear, Lucide, Phosphor, Radix, Sidekickicons, Tabler, Weather Classes: Options

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



14
15
16
17
18
19
 
# File 'lib/icons/configuration.rb', line 14

def initialize
  @libraries = Options.new

  set_default_config
  set_libraries_config
end

Instance Attribute Details

#default_library ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def default_library
  @default_library
end

#default_sprite_location ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def default_sprite_location
  @default_sprite_location
end

#default_variant ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def default_variant
  @default_variant
end

#icons_path ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def icons_path
  @icons_path
end

#libraries ⇒ Options (readonly)

Returns:



12
13
14
 
# File 'lib/icons/configuration.rb', line 12

def libraries
  @libraries
end

#sprite ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def sprite
  @sprite
end

#validate_sprite_icons ⇒ String?

Returns:

  • (String, nil) 


9
10
11
 
# File 'lib/icons/configuration.rb', line 9

def validate_sprite_icons
  @validate_sprite_icons
end

Instance Method Details

#base_path ⇒ Pathname

Returns:

  • (Pathname) 


40
41
42
 
# File 'lib/icons/configuration.rb', line 40

def base_path
  @base_path ||= Pathname.new(Dir.pwd)
end

#base_path=(value) ⇒ Object

Parameters:

  • value (Pathname, String) 


46
47
48
 
# File 'lib/icons/configuration.rb', line 46

def base_path=(value)
  @base_path = value.is_a?(Pathname) ? value : Pathname.new(value)
end

#destination_path ⇒ String

Deprecated.

Use #icons_path instead

Returns:

  • (String) 


24
25
26
27
28
 
# File 'lib/icons/configuration.rb', line 24

def destination_path
  warn "[DEPRECATION] `destination_path` is deprecated. Use `icons_path` instead."

  @icons_path
end

#destination_path=(value) ⇒ Object

Deprecated.

Use #icons_path= instead



32
33
34
35
36
 
# File 'lib/icons/configuration.rb', line 32

def destination_path=(value)
  warn "[DEPRECATION] `destination_path=` is deprecated. Use `icons_path=` instead."

  @icons_path = value
end