Class: ViteRuby

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/vite_ruby.rb,
lib/vite_ruby/version.rb

Defined Under Namespace

Modules: CompatibilityCheck, IO Classes: Builder, CLI, Commands, Config, DevServerProxy, Error, Manifest, MissingEntrypointError, MissingExecutableError, Runner

Constant Summary collapse

ENV_PREFIX =

Internal: Prefix used for environment variables that modify the configuration.

'VITE_RUBY'
COMPANION_LIBRARIES =

Internal: Companion libraries for Vite Ruby, and their target framework.

{
  'vite_rails' => 'rails',
  'vite_hanami' => 'hanami',
  'vite_padrino' => 'padrino',
  'jekyll-vite' => 'jekyll',
  'vite_rails_legacy' => 'rails',
  'vite_plugin_legacy' => 'rack',
}
VERSION = 
'3.5.0'
DEFAULT_VITE_VERSION =

Internal: Versions used by default when running ‘vite install`.

'^5.0.0'
DEFAULT_PLUGIN_VERSION = 
'^5.0.0'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**config_options) ⇒ ViteRuby

Returns a new instance of ViteRuby.



70
71
72
 
# File 'lib/vite_ruby.rb', line 70

def initialize(**config_options)
  @config_options = config_options
end

Instance Attribute Details

#logger ⇒ Object 



74
75
76
 
# File 'lib/vite_ruby.rb', line 74

def logger
  @logger ||= Logger.new($stdout)
end

Class Method Details

.bootstrap ⇒ Object

Internal: Refreshes the manifest.



43
44
45
 
# File 'lib/vite_ruby.rb', line 43

def bootstrap
  instance.manifest.refresh
end

.framework_libraries ⇒ Object

Internal: Detects if the application has installed a framework-specific variant of Vite Ruby.



59
60
61
62
63
64
65
 
# File 'lib/vite_ruby.rb', line 59

def framework_libraries
  COMPANION_LIBRARIES.map { |name, framework|
    if library = Gem.loaded_specs[name]
      [framework, library]
    end
  }.compact
end

.install_tasks ⇒ Object

Internal: Loads all available rake tasks.



48
49
50
 
# File 'lib/vite_ruby.rb', line 48

def install_tasks
  load File.expand_path('tasks/vite.rake', __dir__)
end

.instance ⇒ Object 



38
39
40
 
# File 'lib/vite_ruby.rb', line 38

def instance
  @instance ||= new
end

.reload_with(**config_options) ⇒ Object

Internal: Creates a new instance with the specified options.



53
54
55
 
# File 'lib/vite_ruby.rb', line 53

def reload_with(**config_options)
  @instance = new(**config_options)
end

Instance Method Details

#builder ⇒ Object

Public: Keeps track of watched files and triggers builds as needed.



122
123
124
 
# File 'lib/vite_ruby.rb', line 122

def builder
  @builder ||= ViteRuby::Builder.new(self)
end

#commands ⇒ Object

Internal: Helper to run commands related with Vite.



127
128
129
 
# File 'lib/vite_ruby.rb', line 127

def commands
  @commands ||= ViteRuby::Commands.new(self)
end

#config ⇒ Object

Public: Current instance configuration for Vite.



132
133
134
135
136
137
138
139
 
# File 'lib/vite_ruby.rb', line 132

def config
  unless defined?(@config)
    configure
    @config.load_ruby_config
  end

  @config
end

#configure(**options) ⇒ Object

Public: Allows overriding the configuration for this instance.



142
143
144
 
# File 'lib/vite_ruby.rb', line 142

def configure(**options)
  @config = ViteRuby::Config.resolve_config(**@config_options, **options)
end

#dev_server_running? ⇒ Boolean

Public: Returns true if the Vite development server is currently running. NOTE: Checks only once every second since every lookup calls this method.

Returns:

  • (Boolean) 


86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/vite_ruby.rb', line 86

def dev_server_running?
  return false unless run_proxy?
  return @running if defined?(@running) && Time.now - @running_checked_at < 1

  begin
    Socket.tcp(config.host, config.port, connect_timeout: config.dev_server_connect_timeout).close
    @running = true
  rescue StandardError
    @running = false
  ensure
    @running_checked_at = Time.now
  end
end

#digest ⇒ Object

Public: Returns a digest of all the watched files, allowing to detect changes. Useful to perform version checks in single-page applications.



80
81
82
 
# File 'lib/vite_ruby.rb', line 80

def digest
  builder.send(:watched_files_digest)
end

#env ⇒ Object

Public: Additional environment variables to pass to Vite.

Example:

ViteRuby.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'



104
105
106
 
# File 'lib/vite_ruby.rb', line 104

def env
  @env ||= ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
end

#manifest ⇒ Object

Public: Enables looking up assets managed by Vite using name and type.



147
148
149
 
# File 'lib/vite_ruby.rb', line 147

def manifest
  @manifest ||= ViteRuby::Manifest.new(self)
end

#run(argv, **options) ⇒ Object

Internal: Executes the vite binary.



117
118
119
 
# File 'lib/vite_ruby.rb', line 117

def run(argv, **options)
  (@runner ||= ViteRuby::Runner.new(self)).run(argv, **options)
end

#run_proxy? ⇒ Boolean

Public: The proxy for assets should only run in development mode.

Returns:

  • (Boolean) 


109
110
111
112
113
114
 
# File 'lib/vite_ruby.rb', line 109

def run_proxy?
  config.mode == 'development' || (config.mode == 'test' && !ENV['CI'])
rescue StandardError => error
  logger.error("Failed to check mode for Vite: #{ error.message }")
  false
end