Module: Shakapacker

Extended by:

Shakapacker

Included in:

Shakapacker

Defined in:

lib/shakapacker.rb,
lib/shakapacker/doctor.rb,
lib/shakapacker/runner.rb,
lib/shakapacker/version.rb,
lib/shakapacker/utils/misc.rb,
lib/shakapacker/install/env.rb,
lib/shakapacker/swc_migrator.rb,
lib/shakapacker/base_strategy.rb,
lib/shakapacker/rspack_runner.rb,
lib/shakapacker/utils/manager.rb,
lib/shakapacker/mtime_strategy.rb,
lib/shakapacker/webpack_runner.rb,
lib/shakapacker/digest_strategy.rb,
lib/shakapacker/version_checker.rb,
lib/shakapacker/bundler_switcher.rb,
lib/shakapacker/compiler_strategy.rb,
lib/shakapacker/dev_server_runner.rb,
lib/shakapacker/deprecation_helper.rb,
lib/shakapacker/build_config_loader.rb,
lib/shakapacker/utils/version_syntax_converter.rb,
sig/shakapacker.rbs,
sig/shakapacker/helper.rbs,
sig/shakapacker/version.rbs,
sig/shakapacker/compiler_strategy.rbs

Overview

Compiler strategy for determining staleness

Defined Under Namespace

Modules: Helper, Install, Utils Classes: BaseStrategy, BuildConfigLoader, BundlerSwitcher, Commands, Compiler, CompilerStrategy, Configuration, DevServer, DevServerProxy, DevServerRunner, DigestStrategy, Doctor, Engine, Env, Instance, Manifest, MtimeStrategy, RspackRunner, Runner, SwcMigrator, VersionChecker, WebpackRunner

Constant Summary

DEFAULT_ENV =

Default environment when RAILS_ENV is not set

Returns:

• (String)

"development".freeze

DEV_ENVS =

Environments that use "development" for NODE_ENV All other environments (production, staging, etc.) use "production" for webpack optimizations Note: Both development and test RAILS_ENV use NODE_ENV=development because webpack/rspack only recognize "development" and "production" values for NODE_ENV. Using "test" causes DefinePlugin conflicts with optimization.nodeEnv.

%w[development test].freeze

VERSION =

The current version of Shakapacker

Returns:

• (String)

"10.3.1".freeze

SHELL =

Thor::Shell::Color.new

DEV_TEST_ENVS =

Environments that use their RAILS_ENV value for NODE_ENV

Returns:

• (Array[String])

Class Method Summary

• .bootstrap ⇒ void

  Creates the default configuration files and directory structure.

• .clean ⇒ Boolean

  Removes old compiled packs, keeping the most recent versions.

• .clobber ⇒ void

  Removes all compiled packs.

• .commands ⇒ Commands

  Returns the commands instance for build operations.

• .compile ⇒ Boolean

  Compiles all webpack/rspack packs.

• .compiler ⇒ Compiler

  Returns the compiler instance for compiling assets.

• .config ⇒ Configuration

  Returns the Shakapacker configuration object.

• .dev_server ⇒ DevServer

  Returns the dev server instance for querying server status.

• .ensure_log_goes_to_stdout ⇒ void

  Temporarily redirects Shakapacker logging to STDOUT.

• .ensure_node_env! ⇒ String

  Sets NODE_ENV based on RAILS_ENV if not already set.

• .env ⇒ ActiveSupport::StringInquirer

  Returns the current Rails environment as an ActiveSupport::StringInquirer.

• .inlining_css? ⇒ Boolean

  Returns whether CSS inlining is enabled.

• .instance ⇒ Instance

  Returns the shared Shakapacker instance.

• .instance= ⇒ Instance

  Sets the shared Shakapacker instance.

• .logger ⇒ ActiveSupport::TaggedLogging

  Returns the logger instance used by Shakapacker.

• .logger= ⇒ ActiveSupport::TaggedLogging

  Sets the logger instance used by Shakapacker.

• .manifest ⇒ Manifest

  Returns the manifest instance for looking up compiled assets.

• .with_node_env ⇒ void

  Temporarily overrides NODE_ENV for the duration of the block.

Instance Method Summary

• #append_javascript_pack_tag ⇒ nil

  Appends javascript pack names to the queue.

• #append_stylesheet_pack_tag ⇒ nil

  Appends stylesheet pack names to the queue.

• #asset_pack_path ⇒ String

  Computes the relative path for a given Shakapacker asset.

• #asset_pack_url ⇒ String

  Computes the absolute path for a given Shakapacker asset.

• #available_sources_from_manifest_entrypoints ⇒ Array[String]
• #bootstrap ⇒ void

  Creates the default configuration files and directory structure.

• #build_link_header ⇒ String
• #clean(count = nil, age = nil) ⇒ void

  Removes old compiled packs, keeping the most recent versions.

• #clobber ⇒ void

  Removes all compiled packs.

• #commands ⇒ Shakapacker::Commands

  Returns the commands instance for build operations.

• #compile ⇒ Boolean

  Compiles all webpack/rspack packs.

• #compiler ⇒ Shakapacker::Compiler

  Returns the compiler instance for compiling assets.

• #config ⇒ Shakapacker::Configuration

  Returns the Shakapacker configuration object.

• #current_shakapacker_instance ⇒ Instance

  Returns the current Shakapacker instance.

• #dev_server ⇒ Shakapacker::DevServer

  Returns the dev server instance for querying server status.

• #early_hints_debug_enabled? ⇒ Boolean
• #early_hints_enabled? ⇒ Boolean
• #early_hints_skip_reason ⇒ String
• #early_hints_store ⇒ Hash[String, untyped]
• #early_hints_supported? ⇒ Boolean
• #ensure_log_goes_to_stdout { ... } ⇒ Object

  Temporarily redirects Shakapacker logging to STDOUT.

• #ensure_node_env! ⇒ String private

  Sets NODE_ENV based on RAILS_ENV if not already set.

• #env ⇒ ActiveSupport::StringInquirer

  Returns the current Rails environment as an ActiveSupport::StringInquirer.

• #favicon_pack_tag ⇒ ActiveSupport::SafeBuffer

  Creates a link tag for a favicon that references the named pack file.

• #flush_early_hints ⇒ void
• #image_pack_path ⇒ String

  Computes the relative path for a given Shakapacker image.

• #image_pack_tag ⇒ ActiveSupport::SafeBuffer

  Creates an image tag that references the named pack file.

• #image_pack_url ⇒ String

  Computes the absolute path for a given Shakapacker image.

• #inlining_css? ⇒ Boolean

  Returns whether CSS inlining is enabled.

• #instance ⇒ Shakapacker::Instance

  Returns the shared Shakapacker instance.

• #instance=(instance) ⇒ Shakapacker::Instance

  Sets the shared Shakapacker instance.

• #javascript_pack_tag ⇒ Object

  Creates script tags that reference the js chunks from entrypoints.

• #javascript_pack_tag_queue ⇒ Hash[Symbol, Array[String]]
• #logger ⇒ Logger

  Returns the logger instance used by Shakapacker.

• #logger=(logger) ⇒ Logger

  Sets the logger instance used by Shakapacker.

• #lookup_integrity ⇒ String^?
• #lookup_source ⇒ String
• #manifest ⇒ Shakapacker::Manifest

  Returns the manifest instance for looking up compiled assets.

• #normalize_hint_value ⇒ String
• #normalize_pack_hints ⇒ Hash[String, String]
• #preload_pack_asset ⇒ ActiveSupport::SafeBuffer

  Creates a link tag for preloading that references a given Shakapacker asset.

• #prepend_javascript_pack_tag ⇒ nil

  Prepends javascript pack names to the queue.

• #puts_deprecation_message(message) ⇒ Object
• #render_tags ⇒ nil
• #resolve_early_hints_value ⇒ String
• #resolve_path_to_image ⇒ String
• #send_early_hints_internal ⇒ void
• #send_javascript_early_hints_internal ⇒ void
• #send_pack_early_hints ⇒ nil

  Sends HTTP 103 Early Hints for specified packs.

• #send_stylesheet_early_hints_internal ⇒ void
• #sources_from_manifest_entrypoints ⇒ Array[String]
• #stylesheet_pack_tag ⇒ Object

  Creates link tags that reference the css chunks from entrypoints.

• #update_javascript_pack_tag_queue {|arg0| ... } ⇒ nil
• #with_node_env(env) { ... } ⇒ Object

  Temporarily overrides NODE_ENV for the duration of the block.

Class Method Details

.bootstrap ⇒ void

This method returns an undefined value.

Creates the default configuration files and directory structure

# File 'sig/shakapacker.rbs', line 56

def self.bootstrap: () -> void

.clean ⇒ Boolean

Removes old compiled packs, keeping the most recent versions

Parameters:

• (Integer)
• (Integer)

Returns:

• (Boolean)

# File 'sig/shakapacker.rbs', line 59

def self.clean: (?Integer, ?Integer) -> bool

.clobber ⇒ void

This method returns an undefined value.

Removes all compiled packs

# File 'sig/shakapacker.rbs', line 62

def self.clobber: () -> void

.commands ⇒ Commands

Returns the commands instance for build operations

Returns:

• (Commands)

# File 'sig/shakapacker.rbs', line 50

def self.commands: () -> Commands

.compile ⇒ Boolean

Compiles all webpack/rspack packs

Returns:

• (Boolean)

# File 'sig/shakapacker.rbs', line 65

def self.compile: () -> bool

.compiler ⇒ Compiler

Returns the compiler instance for compiling assets

Returns:

• (Compiler)

# File 'sig/shakapacker.rbs', line 44

def self.compiler: () -> Compiler

.config ⇒ Configuration

Returns the Shakapacker configuration object

Returns:

• (Configuration)

# File 'sig/shakapacker.rbs', line 41

def self.config: () -> Configuration

.dev_server ⇒ DevServer

Returns the dev server instance for querying server status

Returns:

• (DevServer)

# File 'sig/shakapacker.rbs', line 53

def self.dev_server: () -> DevServer

.ensure_log_goes_to_stdout ⇒ void

This method returns an undefined value.

Temporarily redirects Shakapacker logging to STDOUT

# File 'sig/shakapacker.rbs', line 26

def self.ensure_log_goes_to_stdout: [T] () { () -> T } -> T

.ensure_node_env! ⇒ String

Sets NODE_ENV based on RAILS_ENV if not already set

Returns:

• (String)

# File 'sig/shakapacker.rbs', line 23

def self.ensure_node_env!: () -> String

.env ⇒ ActiveSupport::StringInquirer

Returns the current Rails environment as an ActiveSupport::StringInquirer

Returns:

• (ActiveSupport::StringInquirer)

# File 'sig/shakapacker.rbs', line 35

def self.env: () -> ActiveSupport::StringInquirer

.inlining_css? ⇒ Boolean

Returns whether CSS inlining is enabled

Returns:

• (Boolean)

# File 'sig/shakapacker.rbs', line 38

def self.inlining_css?: () -> bool

.instance ⇒ Instance

Returns the shared Shakapacker instance

Returns:

• (Instance)

# File 'sig/shakapacker.rbs', line 14

def self.instance: () -> Instance

.instance= ⇒ Instance

Sets the shared Shakapacker instance

Parameters:

• (Instance instance)

Returns:

• (Instance)

# File 'sig/shakapacker.rbs', line 17

def self.instance=: (Instance instance) -> Instance

.logger ⇒ ActiveSupport::TaggedLogging

Returns the logger instance used by Shakapacker

Returns:

• (ActiveSupport::TaggedLogging)

# File 'sig/shakapacker.rbs', line 29

def self.logger: () -> ActiveSupport::TaggedLogging

.logger= ⇒ ActiveSupport::TaggedLogging

Sets the logger instance used by Shakapacker

Parameters:

• logger (ActiveSupport::TaggedLogging)

Returns:

• (ActiveSupport::TaggedLogging)

# File 'sig/shakapacker.rbs', line 32

def self.logger=: (ActiveSupport::TaggedLogging logger) -> ActiveSupport::TaggedLogging

.manifest ⇒ Manifest

Returns the manifest instance for looking up compiled assets

Returns:

• (Manifest)

# File 'sig/shakapacker.rbs', line 47

def self.manifest: () -> Manifest

.with_node_env ⇒ void

This method returns an undefined value.

Temporarily overrides NODE_ENV for the duration of the block

# File 'sig/shakapacker.rbs', line 20

def self.with_node_env: [T] (String env) { () -> T } -> T

Instance Method Details

#append_javascript_pack_tag ⇒ nil

Appends javascript pack names to the queue

Parameters:

• names (String)
• defer: (Boolean)
• async: (Boolean)

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 50

def append_javascript_pack_tag: (*String names, ?defer: bool, ?async: bool) -> nil

#append_stylesheet_pack_tag ⇒ nil

Appends stylesheet pack names to the queue

Parameters:

• names (String)

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 47

def append_stylesheet_pack_tag: (*String names) -> nil

#asset_pack_path ⇒ String

Computes the relative path for a given Shakapacker asset

Parameters:

• name (String)
• options (Object)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 7

def asset_pack_path: (String name, **untyped options) -> String

#asset_pack_url ⇒ String

Computes the absolute path for a given Shakapacker asset

Parameters:

• name (String)
• options (Object)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 10

def asset_pack_url: (String name, **untyped options) -> String

#available_sources_from_manifest_entrypoints ⇒ Array[String]

Parameters:

• names (Array[String | Symbol])
• type: (Symbol)

Returns:

• (Array[String])

# File 'sig/shakapacker/helper.rbs', line 63

def available_sources_from_manifest_entrypoints: (Array[String | Symbol] names, type: Symbol) -> Array[String]

#bootstrap ⇒ void

This method returns an undefined value.

Creates the default configuration files and directory structure

See Also:

• Shakapacker::Commands#bootstrap

# File 'lib/shakapacker.rb', line 194

delegate :bootstrap, :clean, :clobber, :compile, to: :commands

#build_link_header ⇒ String

Parameters:

• source_path (String)
• source (String, Hash[String, untyped])
• as: (String)
• rel: (String)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 87

def build_link_header: (String source_path, String | Hash[String, untyped] source, as: String, ?rel: String) -> String

#clean(count = nil, age = nil) ⇒ void

This method returns an undefined value.

Removes old compiled packs, keeping the most recent versions

Parameters:

• count (Integer, nil) (defaults to: nil) —

  number of versions to keep per entry

• age (Integer, nil) (defaults to: nil) —

  maximum age in seconds for packs to keep

See Also:

• Shakapacker::Commands#clean

# File 'lib/shakapacker.rb', line 194

delegate :bootstrap, :clean, :clobber, :compile, to: :commands

#clobber ⇒ void

This method returns an undefined value.

Removes all compiled packs

See Also:

• Shakapacker::Commands#clobber

# File 'lib/shakapacker.rb', line 194

delegate :bootstrap, :clean, :clobber, :compile, to: :commands

#commands ⇒ Shakapacker::Commands

Returns the commands instance for build operations

Returns:

• (Shakapacker::Commands) —

  the commands object

See Also:

• Shakapacker::Instance#commands

# File 'lib/shakapacker.rb', line 174

delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance

#compile ⇒ Boolean

Compiles all webpack/rspack packs

Returns:

• (Boolean) —

  true if compilation succeeded

See Also:

• Shakapacker::Commands#compile

# File 'lib/shakapacker.rb', line 194

delegate :bootstrap, :clean, :clobber, :compile, to: :commands

#compiler ⇒ Shakapacker::Compiler

Returns the compiler instance for compiling assets

Returns:

• (Shakapacker::Compiler) —

  the compiler

See Also:

• Shakapacker::Instance#compiler

# File 'lib/shakapacker.rb', line 174

delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance

#config ⇒ Shakapacker::Configuration

Returns the Shakapacker configuration object

Returns:

• (Shakapacker::Configuration) —

  the configuration

See Also:

• Shakapacker::Instance#config

# File 'lib/shakapacker.rb', line 174

delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance

#current_shakapacker_instance ⇒ Instance

Returns the current Shakapacker instance

Returns:

• (Instance)

# File 'sig/shakapacker/helper.rbs', line 4

def current_shakapacker_instance: () -> Instance

#dev_server ⇒ Shakapacker::DevServer

Returns the dev server instance for querying server status

Returns:

• (Shakapacker::DevServer) —

  the dev server

See Also:

• Shakapacker::Instance#dev_server

# File 'lib/shakapacker.rb', line 174

delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance

#early_hints_debug_enabled? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/shakapacker/helper.rbs', line 77

def early_hints_debug_enabled?: () -> bool

#early_hints_enabled? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/shakapacker/helper.rbs', line 75

def early_hints_enabled?: () -> bool

#early_hints_skip_reason ⇒ String

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 85

def early_hints_skip_reason: () -> String

#early_hints_store ⇒ Hash[String, untyped]

Returns:

• (Hash[String, untyped])

# File 'sig/shakapacker/helper.rbs', line 89

def early_hints_store: () -> Hash[String, untyped]

#early_hints_supported? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/shakapacker/helper.rbs', line 73

def early_hints_supported?: () -> bool

#ensure_log_goes_to_stdout { ... } ⇒ Object

Temporarily redirects Shakapacker logging to STDOUT

This is useful for debugging or when you want to see compilation output in the console instead of the Rails log.

Examples:

Shakapacker.ensure_log_goes_to_stdout do
  Shakapacker.compile
end

Yields:

• the block to execute with STDOUT logging

Returns:

• (Object) —

  the return value of the block

# File 'lib/shakapacker.rb', line 127

def ensure_log_goes_to_stdout
  old_logger = Shakapacker.logger
  Shakapacker.logger = Logger.new(STDOUT)
  yield
ensure
  Shakapacker.logger = old_logger
end

#ensure_node_env! ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets NODE_ENV based on RAILS_ENV if not already set

Environment mapping:

• development and test environments use "development" for NODE_ENV
• All other environments (+production+, staging, etc.) use "production" for webpack optimizations

Note: We always use "development" (not "test") for test environments because webpack/rspack only recognize "development" and "production" as valid NODE_ENV values. Using "test" causes DefinePlugin conflicts with optimization.nodeEnv.

This method is typically called automatically during Rails initialization.

Returns:

• (String) —

  the NODE_ENV value that was set

# File 'lib/shakapacker.rb', line 111

def ensure_node_env!
  ENV["NODE_ENV"] ||= DEV_ENVS.include?(ENV["RAILS_ENV"]) ? "development" : "production"
end

#env ⇒ ActiveSupport::StringInquirer

Returns the current Rails environment as an ActiveSupport::StringInquirer

Returns:

• (ActiveSupport::StringInquirer) —

  the environment

See Also:

• Shakapacker::Instance#env

# File 'lib/shakapacker.rb', line 152

delegate :logger, :logger=, :env, :inlining_css?, to: :instance

#favicon_pack_tag ⇒ ActiveSupport::SafeBuffer

Creates a link tag for a favicon that references the named pack file

Parameters:

• name (String)
• options (Object)

Returns:

• (ActiveSupport::SafeBuffer)

# File 'sig/shakapacker/helper.rbs', line 22

def favicon_pack_tag: (String name, **untyped options) -> ActiveSupport::SafeBuffer

#flush_early_hints ⇒ void

This method returns an undefined value.

# File 'sig/shakapacker/helper.rbs', line 93

def flush_early_hints: () -> void

#image_pack_path ⇒ String

Computes the relative path for a given Shakapacker image

Parameters:

• name (String)
• options (Object)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 13

def image_pack_path: (String name, **untyped options) -> String

#image_pack_tag ⇒ ActiveSupport::SafeBuffer

Creates an image tag that references the named pack file

Parameters:

• name (String)
• options (Object)

Returns:

• (ActiveSupport::SafeBuffer)

# File 'sig/shakapacker/helper.rbs', line 19

def image_pack_tag: (String name, **untyped options) -> ActiveSupport::SafeBuffer

#image_pack_url ⇒ String

Computes the absolute path for a given Shakapacker image

Parameters:

• name (String)
• options (Object)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 16

def image_pack_url: (String name, **untyped options) -> String

#inlining_css? ⇒ Boolean

Returns whether CSS inlining is enabled

Returns:

• (Boolean) —

  true if CSS should be inlined

See Also:

• Shakapacker::Instance#inlining_css?

# File 'lib/shakapacker.rb', line 152

delegate :logger, :logger=, :env, :inlining_css?, to: :instance

#instance ⇒ Shakapacker::Instance

Returns the shared Shakapacker instance

This instance is used by all module-level delegate methods. It provides access to configuration, compilation, manifest lookup, and more.

Returns:

• (Shakapacker::Instance) —

  the shared instance

# File 'lib/shakapacker.rb', line 71

def instance
  @instance ||= Shakapacker::Instance.new
end

#instance=(instance) ⇒ Shakapacker::Instance

Sets the shared Shakapacker instance

This is primarily used for testing or advanced customization scenarios. In most applications, the default instance is sufficient.

Parameters:

• instance (Shakapacker::Instance) —

  the instance to use

Returns:

• (Shakapacker::Instance) —

  the instance that was set

# File 'lib/shakapacker.rb', line 60

def instance=(instance)
  @instance = instance
end

#javascript_pack_tag ⇒ Object

Creates script tags that reference the js chunks from entrypoints

# File 'sig/shakapacker/helper.rbs', line 25

def javascript_pack_tag: (

#javascript_pack_tag_queue ⇒ Hash[Symbol, Array[String]]

Returns:

• (Hash[Symbol, Array[String]])

# File 'sig/shakapacker/helper.rbs', line 59

def javascript_pack_tag_queue: () -> Hash[Symbol, Array[String]]

#logger ⇒ Logger

Returns the logger instance used by Shakapacker

Returns:

• (Logger) —

  the logger instance

See Also:

• Shakapacker::Instance#logger

# File 'lib/shakapacker.rb', line 152

delegate :logger, :logger=, :env, :inlining_css?, to: :instance

#logger=(logger) ⇒ Logger

Sets the logger instance used by Shakapacker

Parameters:

• logger (Logger) —

  the logger to use

Returns:

• (Logger) —

  the logger that was set

See Also:

• Shakapacker::Instance.logger=

# File 'lib/shakapacker.rb', line 152

delegate :logger, :logger=, :env, :inlining_css?, to: :instance

#lookup_integrity ⇒ String^?

Parameters:

• source (String, Hash[String, untyped])

Returns:

• (String, nil)

# File 'sig/shakapacker/helper.rbs', line 67

def lookup_integrity: (String | Hash[String, untyped] source) -> String?

#lookup_source ⇒ String

Parameters:

• source (String, Hash[String, untyped])

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 69

def lookup_source: (String | Hash[String, untyped] source) -> String

#manifest ⇒ Shakapacker::Manifest

Returns the manifest instance for looking up compiled assets

Returns:

• (Shakapacker::Manifest) —

  the manifest

See Also:

• Shakapacker::Instance#manifest

# File 'lib/shakapacker.rb', line 174

delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance

#normalize_hint_value ⇒ String

Parameters:

• value (String, bool, nil)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 83

def normalize_hint_value: (String | bool | nil value) -> String

#normalize_pack_hints ⇒ Hash[String, String]

Parameters:

• packs (Array[String])
• early_hints (Hash[String | Symbol, String], String, bool)

Returns:

• (Hash[String, String])

# File 'sig/shakapacker/helper.rbs', line 81

def normalize_pack_hints: (Array[String] packs, Hash[String | Symbol, String] | String | bool early_hints) -> Hash[String, String]

#preload_pack_asset ⇒ ActiveSupport::SafeBuffer

Creates a link tag for preloading that references a given Shakapacker asset

Parameters:

• name (String)
• options (Object)

Returns:

• (ActiveSupport::SafeBuffer)

# File 'sig/shakapacker/helper.rbs', line 34

def preload_pack_asset: (String name, **untyped options) -> ActiveSupport::SafeBuffer

#prepend_javascript_pack_tag ⇒ nil

Prepends javascript pack names to the queue

Parameters:

• names (String)
• defer: (Boolean)
• async: (Boolean)

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 53

def prepend_javascript_pack_tag: (*String names, ?defer: bool, ?async: bool) -> nil

#puts_deprecation_message(message) ⇒ Object

# File 'lib/shakapacker/deprecation_helper.rb', line 6

def puts_deprecation_message(message)
  SHELL.say "\n#{message}\n", :yellow
end

#render_tags ⇒ nil

Parameters:

• sources (Array[String])
• type (Symbol)
• options (Hash[Symbol, untyped])

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 71

def render_tags: (Array[String] sources, Symbol type, Hash[Symbol, untyped] options) -> nil

#resolve_early_hints_value ⇒ String

Parameters:

• early_hints (Hash[String | Symbol, String], String, bool, nil)
• asset_type (Symbol)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 79

def resolve_early_hints_value: ((Hash[String | Symbol, String] | String | bool)? early_hints, Symbol asset_type) -> String

#resolve_path_to_image ⇒ String

Parameters:

• name (String)
• options (Object)

Returns:

• (String)

# File 'sig/shakapacker/helper.rbs', line 65

def resolve_path_to_image: (String name, **untyped options) -> String

#send_early_hints_internal ⇒ void

This method returns an undefined value.

Parameters:

• config (Hash[String, String])
• type: (Symbol)

# File 'sig/shakapacker/helper.rbs', line 91

def send_early_hints_internal: (Hash[String, String] config, type: Symbol) -> void

#send_javascript_early_hints_internal ⇒ void

This method returns an undefined value.

Parameters:

• config (Hash[String, String])

# File 'sig/shakapacker/helper.rbs', line 95

def send_javascript_early_hints_internal: (Hash[String, String] config) -> void

#send_pack_early_hints ⇒ nil

Sends HTTP 103 Early Hints for specified packs

Parameters:

• config (Hash[String | Symbol, Hash[String | Symbol, String | bool]])

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 37

def send_pack_early_hints: (Hash[String | Symbol, Hash[String | Symbol, String | bool]] config) -> nil

#send_stylesheet_early_hints_internal ⇒ void

This method returns an undefined value.

Parameters:

• config (Hash[String, String])

# File 'sig/shakapacker/helper.rbs', line 97

def send_stylesheet_early_hints_internal: (Hash[String, String] config) -> void

#sources_from_manifest_entrypoints ⇒ Array[String]

Parameters:

• names (Array[String | Symbol])
• type: (Symbol)

Returns:

• (Array[String])

# File 'sig/shakapacker/helper.rbs', line 61

def sources_from_manifest_entrypoints: (Array[String | Symbol] names, type: Symbol) -> Array[String]

#stylesheet_pack_tag ⇒ Object

Creates link tags that reference the css chunks from entrypoints

# File 'sig/shakapacker/helper.rbs', line 40

def stylesheet_pack_tag: (

#update_javascript_pack_tag_queue {|arg0| ... } ⇒ nil

Parameters:

• defer: (Boolean)
• async: (Boolean)

Yields:

Yield Parameters:

• arg0 (Symbol)

Yield Returns:

• (void)

Returns:

• (nil)

# File 'sig/shakapacker/helper.rbs', line 57

def update_javascript_pack_tag_queue: (defer: bool, async: bool) { (Symbol) -> void } -> nil

#with_node_env(env) { ... } ⇒ Object

Temporarily overrides NODE_ENV for the duration of the block

This is useful when you need to perform operations with a specific NODE_ENV value without permanently changing the environment.

Examples:

Shakapacker.with_node_env("production") do
  # This code runs with NODE_ENV=production
  Shakapacker.compile
end

Parameters:

• env (String) —

  the NODE_ENV value to use temporarily

Yields:

• the block to execute with the temporary NODE_ENV

Returns:

• (Object) —

  the return value of the block

# File 'lib/shakapacker.rb', line 89

def with_node_env(env)
  original = ENV["NODE_ENV"]
  ENV["NODE_ENV"] = env
  yield
ensure
  ENV["NODE_ENV"] = original
end