shakapacker 9.3.4.beta.0 → 9.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f91e082c004aed62a936ae04be5d4a86adb4532deebe84f55662660f3735f67
-  data.tar.gz: aa26a6595a4f37bb61f83d10e978e77f5b6cbe2df50debb7428ecb9f8a6f1072
+  metadata.gz: 20f8244a121f25f9c018754007b3588d99e4860677cc8ef4e2f8b55858edbd57
+  data.tar.gz: 4e5d80d804e55cfbce44d9139e70ea7f60d8709e92f1f07c95391e7e128a7e8e
 SHA512:
-  metadata.gz: efeea8ba10d3a7df9d4a5d14d7f7f34169202ebd2f7f9c16e1875cdb55531be5155600ba2a06cb2fa53866785fd0a374742f2b420be68c12430a7597b553e23c
-  data.tar.gz: 89965343135e74749d0a04cafd1c6a931b311d62432c25cfc6f3e9c1bcbee4274605a200211d39622e6934a376f00b092b556238586d1742603398b0862b7d34
+  metadata.gz: 02e7f011c8b6d839672e485146221a2e76f014926f4226a4394720837d56a9b646bd4d5732cbf48c0a3639b5067fcbc597c2fd44a3cc7bb2b77242a6d5ecaf41
+  data.tar.gz: f0510466924af335241216dc70e021ab26942012d3cdaf735fcd1bfa34d4b1ad615a4a9e7906ca5d348c519dde308a26fc46a34d0a54ebcdb9518ae3265ca209

data/.github/workflows/ruby.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     paths:
       - "**.rb"
+      - "**.rbs"
       - "**.gemspec"
       - "Gemfile"
       - "Rakefile"
@@ -41,6 +42,25 @@ jobs:
       - name: Ruby rubocop
         run: bundle exec rubocop
 
+  rbs-validate:
+    name: RBS Type Validation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Remove Gemfile.lock
+        # Remove lock to test compatibility with latest gem versions
+        run: rm -f Gemfile.lock
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          rubygems: latest
+          bundler-cache: true
+
+      - name: Validate RBS signatures
+        run: bundle exec rbs validate
+
   test:
     name: Testing
     runs-on: ${{ matrix.os }}

data/CHANGELOG.md

@@ -11,6 +11,12 @@
 
 Changes since the last non-beta release.
 
+## [v9.3.4-beta.0] - November 17, 2025
+
+### Fixed
+
+- **Fixed `switch_bundler` task to remove packages from both dependencies and devDependencies**. [PR #838](https://github.com/shakacode/shakapacker/pull/838) by [justin808](https://github.com/justin808). The task now correctly removes old bundler packages regardless of whether they're in `dependencies` or `devDependencies` sections, fixing an issue where packages in `dependencies` were not being removed when switching bundlers.
+
 ## [v9.3.3] - November 15, 2025
 
 ### Fixed
@@ -42,8 +48,9 @@ Changes since the last non-beta release.
 
 ### Added
 
+- **RBS type signatures for all public APIs**. [PR #822](https://github.com/shakacode/shakapacker/pull/822) by [justin808](https://github.com/justin808). Shakapacker now includes comprehensive RBS type signatures in the `sig/` directory for static type checking and improved IDE support (autocomplete, Steep/TypeProf integration). See README for usage examples.
 - **Support for `css_modules_export_mode` configuration option**. [PR #817](https://github.com/shakacode/shakapacker/pull/817) by [justin808](https://github.com/justin808). Adds `css_modules_export_mode` setting in `shakapacker.yml` to control CSS Modules export style. Set to `"named"` (default, v9+ behavior with true named exports) or `"default"` (v8 behavior with default export object). Allows teams to opt into v8-style exports for easier migration from v8 or when using TypeScript with strict type checking.
-- **`Configuration#data` public API method** with enhanced documentation and safety. [PR #818](https://github.com/shakacode/shakapacker/pull/818) by [justin808](https://github.com/justin808). The `Configuration#data` method is now part of the public Ruby API, providing stable access to raw configuration data. Returns a frozen hash with symbolized keys to prevent accidental mutations. Includes comprehensive test coverage and detailed RDoc documentation.
+- **`Configuration#data` public API method** with enhanced documentation and safety. [PR #820](https://github.com/shakacode/shakapacker/pull/820) by [justin808](https://github.com/justin808). The `Configuration#data` method is now part of the public Ruby API, providing stable access to raw configuration data. Returns a frozen hash with symbolized keys to prevent accidental mutations. Includes comprehensive test coverage and detailed RDoc documentation.
 - **Support for `javascript_transpiler: 'none'`** for completely custom webpack configurations. [PR #799](https://github.com/shakacode/shakapacker/pull/799) by [justin808](https://github.com/justin808). Allows users with custom webpack configs to skip Shakapacker's transpiler setup and validation by setting `javascript_transpiler: 'none'` in `shakapacker.yml`. Useful when managing transpilation entirely outside of Shakapacker's defaults.
 
 ## [v9.3.0] - November 2, 2025
@@ -752,7 +759,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md)
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v9.3.3...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v9.3.4-beta.0...main
+[v9.3.4-beta.0]: https://github.com/shakacode/shakapacker/compare/v9.3.3...v9.3.4-beta.0
 [v9.3.3]: https://github.com/shakacode/shakapacker/compare/v9.3.2...v9.3.3
 [v9.3.2]: https://github.com/shakacode/shakapacker/compare/v9.3.1...v9.3.2
 [v9.3.1]: https://github.com/shakacode/shakapacker/compare/v9.3.0...v9.3.1

data/CONTRIBUTING.md

@@ -27,6 +27,7 @@ We welcome pull requests that fix bugs, add new features, or improve existing on
 - Write tests for your changes and [make sure all tests pass](#making-sure-your-changes-pass-all-tests).
 - Update the documentation as needed.
 - Update CHANGELOG.md if the changes affect public behavior of the project.
+- Update RBS type signatures in `sig/` directory if you modify public APIs.
 
 ---
 
@@ -49,6 +50,91 @@ npx husky add .husky/pre-commit "npx lint-staged"
 
 ---
 
+## RBS Type Signatures
+
+Shakapacker includes RBS type signatures for all public APIs in the `sig/` directory. These signatures provide static type checking and improved IDE support.
+
+### When to Update RBS Files
+
+Update RBS signatures when you:
+
+- Add new public methods or classes
+- Change method signatures (parameters, return types)
+- Modify public APIs
+- Add or remove public attributes
+
+### RBS File Structure
+
+```
+sig/
+├── shakapacker.rbs                    # Main Shakapacker module
+└── shakapacker/
+    ├── configuration.rbs              # Configuration class
+    ├── helper.rbs                     # View helper module
+    ├── manifest.rbs                   # Manifest class
+    ├── compiler.rbs                   # Compiler class
+    └── ...                            # Other components
+```
+
+### Validating RBS Signatures
+
+To validate your RBS signatures:
+
+```bash
+# Install RBS if not already installed
+gem install rbs
+
+# Validate all signatures
+rbs validate
+
+# Check a specific file
+rbs validate sig/shakapacker/configuration.rbs
+```
+
+### RBS Best Practices
+
+1. **Use specific types** instead of `untyped` when possible
+2. **Document optional parameters** with `?` prefix
+3. **Use union types** for methods that can return multiple types (e.g., `String | nil`)
+4. **Keep signatures in sync** with implementation changes
+5. **Test with type checkers** like [Steep](https://github.com/soutaro/steep) when possible
+6. **Use `void` vs `nil` appropriately**:
+   - Use `void` when the return value is expected to be discarded (e.g., `initialize`)
+   - Use `nil` when a method explicitly returns nil as a meaningful value
+7. **Module singleton methods**: For modules using `extend self`, use `module ModuleName : _Singleton` to indicate all methods are module-level singleton methods
+
+### Example RBS Signature
+
+```rbs
+# Good: Specific types with documentation
+class Shakapacker::Configuration
+  def initialize: (
+    root_path: Pathname,
+    config_path: Pathname,
+    env: ActiveSupport::StringInquirer,
+    ?bundler_override: String?
+  ) -> void
+
+  def source_path: () -> Pathname
+  def webpack?: () -> bool
+  def assets_bundler: () -> String
+end
+
+# Module with singleton methods (using extend self)
+module Shakapacker : _Singleton
+  def self.config: () -> Configuration
+  def self.compile: () -> bool
+end
+
+# Avoid: Overly generic types
+class Shakapacker::Configuration
+  def initialize: (**untyped) -> void
+  def source_path: () -> untyped
+end
+```
+
+---
+
 ## Linting and Code Quality
 
 ### Running Linters

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (9.3.4.beta.0)
+    shakapacker (9.3.4)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)
@@ -178,6 +178,8 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
+    rbs (3.9.5)
+      logger
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
@@ -242,6 +244,7 @@ DEPENDENCIES
   rails (>= 6.1.6)
   rails-html-sanitizer (>= 1.4.3)
   rake (>= 11.1)
+  rbs (~> 3.0)
   rspec-rails (~> 6.0.2)
   rubocop
   rubocop-performance

data/README.md

@@ -721,6 +721,61 @@ open doc/index.html
 
 The generated documentation includes all public and private methods with detailed descriptions.
 
+#### Type Signatures with RBS
+
+Shakapacker includes **RBS type signatures** for all public APIs, enabling static type checking and improved IDE support:
+
+**Benefits:**
+
+- **IDE Autocomplete**: Get accurate method signatures and parameter hints in your editor
+- **Static Type Checking**: Catch type errors before runtime using [Steep](https://github.com/soutaro/steep) or [TypeProf](https://github.com/ruby/typeprof)
+- **Self-Documenting Code**: Types provide machine-readable API documentation
+- **Safer Refactoring**: Type checker catches breaking changes across your codebase
+
+**RBS Signatures Location:**
+Type signatures are in the `sig/` directory and included with the gem:
+
+```
+sig/
+├── shakapacker.rbs                    # Main module
+└── shakapacker/
+    ├── configuration.rbs              # Configuration API
+    ├── helper.rbs                     # View helpers
+    ├── manifest.rbs                   # Asset lookup
+    ├── compiler.rbs                   # Compilation
+    ├── dev_server.rbs                 # Dev server
+    └── ...                            # Other components
+```
+
+**Using with Steep (Type Checker):**
+
+```yaml
+# Steepfile
+target :app do
+signature "sig"
+check "app"
+library "shakapacker"
+end
+```
+
+**Example Type Checking:**
+
+```ruby
+# Your code
+config = Shakapacker.config
+config.source_path  # Type checker knows this returns Pathname
+config.webpack?     # Type checker knows this returns bool
+
+# Type error caught at development time:
+config.invalid_method  # ⚠️ Steep reports: Method `invalid_method` is not defined
+```
+
+**Learn More:**
+
+- [RBS Documentation](https://github.com/ruby/rbs)
+- [Steep Type Checker](https://github.com/soutaro/steep)
+- [TypeProf](https://github.com/ruby/typeprof)
+
 ### Webpack Configuration
 
 First, you don't _need_ to use Shakapacker's webpack configuration. However, the `shakapacker` NPM package provides convenient access to configuration code that reads the `config/shakapacker.yml` file which the view helpers also use. If you have your customized webpack configuration, at the minimum, you must ensure:

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "9.3.4.beta.0".freeze
+  VERSION = "9.3.4".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "9.3.4-beta.0",
+  "version": "9.3.4",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {

data/shakapacker.gemspec

@@ -24,12 +24,13 @@ Gem::Specification.new do |s|
   s.add_dependency "semantic_range", ">= 2.3.0"
 
   s.add_development_dependency "bundler", ">= 1.3.0"
+  s.add_development_dependency "rbs", "~> 3.0"
   s.add_development_dependency "rubocop"
   s.add_development_dependency "rubocop-performance"
 
   s.files = `git ls-files -z`.split("\x0").reject { |f|
     f.match(%r{^(test|spec|features|tmp|node_modules|packages|coverage|Gemfile.lock|rakelib)/})
-  }
+  } + Dir.glob("sig/**/*.rbs")
 
   s.test_files = `git ls-files -- test/*`.split("\n")
 end

data/sig/shakapacker/commands.rbs

@@ -0,0 +1,35 @@
+# Build operation commands for Shakapacker
+class Shakapacker::Commands
+  # Creates a new commands instance
+  def initialize: (Instance instance) -> void
+
+  # Cleanup old assets in the compile directory
+  def clean: (?Integer, ?Integer) -> bool
+
+  # Removes all compiled packs
+  def clobber: () -> void
+
+  # Creates the default configuration files and directory structure
+  def bootstrap: () -> void
+
+  # Compiles all webpack/rspack packs
+  def compile: () -> bool
+
+  # Returns the configuration object
+  def config: () -> Configuration
+
+  # Returns the compiler instance
+  def compiler: () -> Compiler
+
+  # Returns the manifest instance
+  def manifest: () -> Manifest
+
+  # Returns the logger instance
+  def logger: () -> ActiveSupport::TaggedLogging
+
+  private
+
+  def packs: () -> Array[String]
+
+  def current_version: () -> Array[String]
+end

data/sig/shakapacker/compiler.rbs

@@ -0,0 +1,60 @@
+# Compiler for compiling assets with webpack/rspack
+class Shakapacker::Compiler
+  # Additional environment variables that the compiler is being run with
+  def self.env: () -> Hash[String, String]
+
+  # Sets additional environment variables
+  def self.env=: (Hash[String, String] env) -> Hash[String, String]
+
+  # Creates a new compiler instance
+  def initialize: (Instance instance) -> void
+
+  # Compiles all webpack/rspack packs
+  def compile: () -> bool
+
+  # Returns the configuration object
+  def config: () -> Configuration
+
+  # Returns the logger instance
+  def logger: () -> ActiveSupport::TaggedLogging
+
+  # Returns the compiler strategy
+  def strategy: () -> CompilerStrategy
+
+  # Returns whether assets are fresh (up-to-date)
+  def fresh?: () -> bool
+
+  # Returns whether assets are stale (need recompilation)
+  def stale?: () -> bool
+
+  # Runs the post-compile hook
+  def after_compile_hook: () -> void
+
+  private
+
+  attr_reader instance: Instance
+
+  def acquire_ipc_lock: [T] () { () -> T } -> T
+
+  def locked?: () -> bool
+
+  alias compiling? locked?
+
+  def wait_for_compilation_to_complete: () -> void
+
+  def open_lock_file: [T] () { (File) -> T } -> T
+
+  def create_lock_file_dir: () -> void
+
+  def lock_file_path: () -> Pathname
+
+  def optional_ruby_runner: () -> String?
+
+  def bin_shakapacker_path: () -> Pathname
+
+  def run_precompile_hook: () -> void
+
+  def run_webpack: () -> bool
+
+  def webpack_env: () -> Hash[String, String]
+end

data/sig/shakapacker/compiler_strategy.rbs

@@ -0,0 +1,41 @@
+# Compiler strategy for determining staleness
+module Shakapacker
+  # Factory class for creating compiler strategies
+  class CompilerStrategy
+    # Creates a compiler strategy from the configuration
+    def self.from_config: () -> (MtimeStrategy | DigestStrategy)
+  end
+
+  # Base strategy with common functionality
+  class BaseStrategy
+    def initialize: () -> void
+
+    # Returns whether assets are fresh (up-to-date)
+    def fresh?: () -> bool
+
+    # Returns whether assets are stale (need recompilation)
+    def stale?: () -> bool
+
+    # Runs the post-compile hook
+    def after_compile_hook: () -> void
+
+    private
+
+    attr_reader config: Configuration
+
+    def default_watched_paths: () -> Array[String]
+  end
+
+  # Mtime-based compiler strategy
+  class MtimeStrategy < BaseStrategy
+    def fresh?: () -> bool
+    def stale?: () -> bool
+  end
+
+  # Digest-based compiler strategy
+  class DigestStrategy < BaseStrategy
+    def fresh?: () -> bool
+    def stale?: () -> bool
+    def after_compile_hook: () -> void
+  end
+end

data/sig/shakapacker/configuration.rbs

@@ -0,0 +1,140 @@
+# Configuration management for Shakapacker
+#
+# Loads and provides access to settings from config/shakapacker.yml
+class Shakapacker::Configuration
+  # Flag indicating whether Shakapacker is currently being installed
+  def self.installing: () -> bool
+
+  # Sets the installing flag
+  def self.installing=: (bool value) -> bool
+
+  # The application root path
+  attr_reader root_path: Pathname
+
+  # The path to the shakapacker.yml configuration file
+  attr_reader config_path: Pathname
+
+  # The current Rails environment
+  attr_reader env: ActiveSupport::StringInquirer
+
+  # Override for the assets bundler (set via CLI flag)
+  attr_reader bundler_override: String?
+
+  # Creates a new configuration instance
+  def initialize: (
+    root_path: Pathname,
+    config_path: Pathname,
+    env: ActiveSupport::StringInquirer,
+    ?bundler_override: String?
+  ) -> void
+
+  # Returns the dev server configuration hash
+  def dev_server: () -> Hash[String | Symbol, untyped]
+
+  # Returns whether automatic compilation is enabled
+  def compile?: () -> bool
+
+  # Returns whether nested entries are enabled
+  def nested_entries?: () -> bool
+
+  # Returns whether consistent versioning check is enabled
+  def ensure_consistent_versioning?: () -> bool
+
+  # Returns whether Shakapacker should precompile assets
+  def shakapacker_precompile?: () -> bool
+
+  # Returns the absolute path to the source directory
+  def source_path: () -> Pathname
+
+  # Returns additional paths to include in compilation
+  def additional_paths: () -> Array[String]
+
+  # Returns the absolute path to the source entry directory
+  def source_entry_path: () -> Pathname
+
+  # Returns the absolute path to the manifest.json file
+  def manifest_path: () -> Pathname
+
+  # Alias for manifest_path
+  def public_manifest_path: () -> Pathname
+
+  # Returns the absolute path to the public root directory
+  def public_path: () -> Pathname
+
+  # Returns the absolute path to the private output directory
+  def private_output_path: () -> Pathname?
+
+  # Returns the absolute path to the public output directory
+  def public_output_path: () -> Pathname
+
+  # Returns whether manifest caching is enabled
+  def cache_manifest?: () -> bool
+
+  # Returns the absolute path to the compilation cache directory
+  def cache_path: () -> Pathname
+
+  # Returns whether webpack/rspack compilation output should be shown
+  def webpack_compile_output?: () -> bool
+
+  # Returns the compiler strategy for determining staleness
+  def compiler_strategy: () -> String
+
+  # Returns the assets bundler to use (webpack or rspack)
+  def assets_bundler: () -> String
+
+  # Deprecated alias for assets_bundler
+  def bundler: () -> String
+
+  # Returns whether rspack is the configured bundler
+  def rspack?: () -> bool
+
+  # Returns whether webpack is the configured bundler
+  def webpack?: () -> bool
+
+  # Returns the precompile hook command to run after compilation
+  def precompile_hook: () -> String?
+
+  # Returns the JavaScript transpiler to use (babel, swc, or esbuild)
+  def javascript_transpiler: () -> String
+
+  # Deprecated alias for javascript_transpiler
+  def webpack_loader: () -> String
+
+  # Returns the path to the bundler configuration directory
+  def assets_bundler_config_path: () -> String
+
+  # Returns the raw configuration data hash
+  def data: () -> Hash[Symbol, untyped]
+
+  # Fetches a configuration value
+  def fetch: (Symbol key) -> untyped
+
+  # Returns the asset host URL for serving assets
+  def asset_host: () -> String?
+
+  # Returns whether subresource integrity (SRI) is enabled
+  def integrity: () -> (bool | Hash[String | Symbol, untyped])
+
+  # Returns whether HTTP/2 Early Hints are enabled
+  def early_hints: () -> bool
+
+  private
+
+  def default_javascript_transpiler: () -> String
+
+  def validate_transpiler_configuration: (String transpiler) -> void
+
+  def warn_transpiler_mismatch: (String configured, String message) -> void
+
+  def validate_output_paths!: () -> void
+
+  def resolve_paths_for_comparison: () -> [String, String]
+
+  def load: () -> Hash[Symbol, untyped]
+
+  def defaults: () -> HashWithIndifferentAccess
+
+  def relative_path: (String path) -> String
+
+  def log_fallback: (String requested_env, String fallback_env) -> void
+end

data/sig/shakapacker/dev_server.rbs

@@ -0,0 +1,56 @@
+# Development server status and configuration
+#
+# Provides methods to query the status and configuration of the webpack-dev-server
+# or rspack-dev-server.
+class Shakapacker::DevServer
+  # Default environment variable prefix for dev server settings
+  DEFAULT_ENV_PREFIX: String
+
+  # Configure dev server connection timeout (in seconds)
+  def self.connect_timeout: () -> Float
+
+  # Sets the connection timeout
+  def self.connect_timeout=: (Float | Integer timeout) -> Float
+
+  # The Shakapacker configuration
+  attr_reader config: Configuration
+
+  # Creates a new dev server instance
+  def initialize: (Configuration config) -> void
+
+  # Returns whether the dev server is currently running
+  def running?: () -> bool
+
+  # Returns the dev server host
+  def host: () -> String
+
+  # Returns the dev server port
+  def port: () -> Integer
+
+  # Returns the server type (http or https)
+  def server: () -> String
+
+  # Alias for server
+  def protocol: () -> String
+
+  # Returns the host with port (e.g., "localhost:3035")
+  def host_with_port: () -> String
+
+  # Returns whether pretty output is enabled
+  def pretty?: () -> bool
+
+  # Returns whether Hot Module Replacement (HMR) is enabled
+  def hmr?: () -> bool
+
+  # Returns whether CSS should be inlined by the dev server
+  def inline_css?: () -> bool
+
+  # Returns the environment variable prefix for dev server settings
+  def env_prefix: () -> String
+
+  private
+
+  def connect_timeout: () -> Float
+
+  def fetch: (Symbol key) -> untyped
+end

data/sig/shakapacker/env.rbs

@@ -0,0 +1,25 @@
+# Environment inquiry for Shakapacker
+class Shakapacker::Env
+  # Returns the current Rails environment as an ActiveSupport::StringInquirer
+  def self.inquire: (Instance instance) -> ActiveSupport::StringInquirer
+
+  # Creates a new env instance
+  def initialize: (Instance instance) -> void
+
+  # Returns the environment inquiry
+  def inquire: () -> ActiveSupport::StringInquirer
+
+  # Returns the config path
+  def config_path: () -> Pathname
+
+  # Returns the logger
+  def logger: () -> ActiveSupport::TaggedLogging
+
+  private
+
+  def current: () -> ActiveSupport::StringInquirer?
+
+  def fallback_env_warning: () -> void
+
+  def available_environments: () -> (Array[String] | Hash[String, untyped])
+end

data/sig/shakapacker/helper.rbs

@@ -0,0 +1,98 @@
+# View helper methods for rendering asset tags
+module Shakapacker::Helper
+  # Returns the current Shakapacker instance
+  def current_shakapacker_instance: () -> Instance
+
+  # Computes the relative path for a given Shakapacker asset
+  def asset_pack_path: (String name, **untyped options) -> String
+
+  # Computes the absolute path for a given Shakapacker asset
+  def asset_pack_url: (String name, **untyped options) -> String
+
+  # Computes the relative path for a given Shakapacker image
+  def image_pack_path: (String name, **untyped options) -> String
+
+  # Computes the absolute path for a given Shakapacker image
+  def image_pack_url: (String name, **untyped options) -> String
+
+  # Creates an image tag that references the named pack file
+  def image_pack_tag: (String name, **untyped options) -> ActiveSupport::SafeBuffer
+
+  # Creates a link tag for a favicon that references the named pack file
+  def favicon_pack_tag: (String name, **untyped options) -> ActiveSupport::SafeBuffer
+
+  # Creates script tags that reference the js chunks from entrypoints
+  def javascript_pack_tag: (
+    *String names,
+    ?defer: bool,
+    ?async: bool,
+    ?early_hints: (Hash[String | Symbol, String] | String | bool)?,
+    **untyped options
+  ) -> ActiveSupport::SafeBuffer
+
+  # Creates a link tag for preloading that references a given Shakapacker asset
+  def preload_pack_asset: (String name, **untyped options) -> ActiveSupport::SafeBuffer
+
+  # Sends HTTP 103 Early Hints for specified packs
+  def send_pack_early_hints: (Hash[String | Symbol, Hash[String | Symbol, String | bool]] config) -> nil
+
+  # Creates link tags that reference the css chunks from entrypoints
+  def stylesheet_pack_tag: (
+    *String names,
+    ?early_hints: (Hash[String | Symbol, String] | String | bool)?,
+    **untyped options
+  ) -> ActiveSupport::SafeBuffer
+
+  # Appends stylesheet pack names to the queue
+  def append_stylesheet_pack_tag: (*String names) -> nil
+
+  # Appends javascript pack names to the queue
+  def append_javascript_pack_tag: (*String names, ?defer: bool, ?async: bool) -> nil
+
+  # Prepends javascript pack names to the queue
+  def prepend_javascript_pack_tag: (*String names, ?defer: bool, ?async: bool) -> nil
+
+  private
+
+  def update_javascript_pack_tag_queue: (defer: bool, async: bool) { (Symbol) -> void } -> nil
+
+  def javascript_pack_tag_queue: () -> Hash[Symbol, Array[String]]
+
+  def sources_from_manifest_entrypoints: (Array[String | Symbol] names, type: Symbol) -> Array[String]
+
+  def available_sources_from_manifest_entrypoints: (Array[String | Symbol] names, type: Symbol) -> Array[String]
+
+  def resolve_path_to_image: (String name, **untyped options) -> String
+
+  def lookup_integrity: (String | Hash[String, untyped] source) -> String?
+
+  def lookup_source: (String | Hash[String, untyped] source) -> String
+
+  def render_tags: (Array[String] sources, Symbol type, Hash[Symbol, untyped] options) -> nil
+
+  def early_hints_supported?: () -> bool
+
+  def early_hints_enabled?: () -> bool
+
+  def early_hints_debug_enabled?: () -> bool
+
+  def resolve_early_hints_value: ((Hash[String | Symbol, String] | String | bool)? early_hints, Symbol asset_type) -> String
+
+  def normalize_pack_hints: (Array[String] packs, Hash[String | Symbol, String] | String | bool early_hints) -> Hash[String, String]
+
+  def normalize_hint_value: (String | bool | nil value) -> String
+
+  def early_hints_skip_reason: () -> String
+
+  def build_link_header: (String source_path, String | Hash[String, untyped] source, as: String, ?rel: String) -> String
+
+  def early_hints_store: () -> Hash[String, untyped]
+
+  def send_early_hints_internal: (Hash[String, String] config, type: Symbol) -> void
+
+  def flush_early_hints: () -> void
+
+  def send_javascript_early_hints_internal: (Hash[String, String] config) -> void
+
+  def send_stylesheet_early_hints_internal: (Hash[String, String] config) -> void
+end

data/sig/shakapacker/instance.rbs

@@ -0,0 +1,46 @@
+# Represents a single instance of Shakapacker configuration and state
+#
+# An instance encapsulates all the configuration, compilation, and manifest
+# lookup functionality for a specific Rails application.
+class Shakapacker::Instance
+  # The shared logger used by all Shakapacker instances
+  def self.logger: () -> ActiveSupport::TaggedLogging
+
+  # Sets the shared logger used by all Shakapacker instances
+  def self.logger=: (ActiveSupport::TaggedLogging logger) -> ActiveSupport::TaggedLogging
+
+  # The root path of the application
+  attr_reader root_path: Pathname
+
+  # The path to the Shakapacker configuration file
+  attr_reader config_path: Pathname
+
+  # Creates a new Shakapacker instance
+  def initialize: (?root_path: String | Pathname | nil, ?config_path: String | Pathname | nil) -> void
+
+  # Returns the current Rails environment as a StringInquirer
+  def env: () -> ActiveSupport::StringInquirer
+
+  # Returns the configuration object for this instance
+  def config: () -> Configuration
+
+  # Returns the compiler for this instance
+  def compiler: () -> Compiler
+
+  # Returns the development server instance
+  def dev_server: () -> DevServer
+
+  # Returns the manifest for looking up compiled assets
+  def manifest: () -> Manifest
+
+  # Returns the commands instance for build operations
+  def commands: () -> Commands
+
+  # Returns whether CSS should be inlined by the dev server
+  def inlining_css?: () -> bool
+
+  private
+
+  # Returns the compiler strategy for determining staleness
+  def strategy: () -> (MtimeStrategy | DigestStrategy)
+end

data/sig/shakapacker/manifest.rbs

@@ -0,0 +1,55 @@
+# Manifest for looking up compiled asset paths
+#
+# The manifest reads the manifest.json file produced by webpack/rspack during
+# compilation and provides methods to look up the compiled (digested) paths for
+# source files.
+class Shakapacker::Manifest
+  # Raised when an asset cannot be found in the manifest
+  class MissingEntryError < StandardError
+  end
+
+  # Creates a new manifest instance
+  def initialize: (Instance instance) -> void
+
+  # Reloads the manifest data from disk
+  def refresh: () -> Hash[String, untyped]
+
+  # Looks up an entry point with all its chunks (split code)
+  def lookup_pack_with_chunks: (String name, ?Hash[Symbol, untyped] pack_type) -> Array[String]?
+
+  # Like lookup_pack_with_chunks, but raises an error if not found
+  def lookup_pack_with_chunks!: (String name, ?Hash[Symbol, untyped] pack_type) -> Array[String]
+
+  # Looks up the compiled path for a given asset
+  def lookup: (String name, ?Hash[Symbol, untyped] pack_type) -> String?
+
+  # Like lookup, but raises an error if not found
+  def lookup!: (String name, ?Hash[Symbol, untyped] pack_type) -> String
+
+  # Returns the configuration object
+  def config: () -> Configuration
+
+  # Returns the compiler instance
+  def compiler: () -> Compiler
+
+  # Returns the dev server instance
+  def dev_server: () -> DevServer
+
+  private
+
+  def compiling?: () -> bool
+
+  def compile: () -> bool
+
+  def data: () -> Hash[String, untyped]
+
+  def load: () -> Hash[String, untyped]
+
+  def find: (String key) -> (String | Hash[String, untyped] | nil)
+
+  def handle_missing_entry: (String name, Hash[Symbol, untyped] pack_type) -> void
+
+  def manifest_type: (Symbol? type) -> String
+
+  def manifest_name: (String name, String manifest_type) -> String
+end

data/sig/shakapacker/version.rbs

@@ -0,0 +1,4 @@
+module Shakapacker
+  # The current version of Shakapacker
+  VERSION: String
+end

data/sig/shakapacker.rbs

@@ -0,0 +1,66 @@
+# Shakapacker is a Ruby gem that integrates webpack and rspack with Rails applications,
+# providing a modern asset pipeline for JavaScript, CSS, and other web assets.
+#
+# The main Shakapacker module provides singleton-style access to configuration,
+# compilation, and asset manifest functionality.
+module Shakapacker : _Singleton
+  # Default environment when RAILS_ENV is not set
+  DEFAULT_ENV: String
+
+  # Environments that use their RAILS_ENV value for NODE_ENV
+  DEV_TEST_ENVS: Array[String]
+
+  # Returns the shared Shakapacker instance
+  def self.instance: () -> Instance
+
+  # Sets the shared Shakapacker instance
+  def self.instance=: (Instance instance) -> Instance
+
+  # Temporarily overrides NODE_ENV for the duration of the block
+  def self.with_node_env: [T] (String env) { () -> T } -> T
+
+  # Sets NODE_ENV based on RAILS_ENV if not already set
+  def self.ensure_node_env!: () -> String
+
+  # Temporarily redirects Shakapacker logging to STDOUT
+  def self.ensure_log_goes_to_stdout: [T] () { () -> T } -> T
+
+  # Returns the logger instance used by Shakapacker
+  def self.logger: () -> ActiveSupport::TaggedLogging
+
+  # Sets the logger instance used by Shakapacker
+  def self.logger=: (ActiveSupport::TaggedLogging logger) -> ActiveSupport::TaggedLogging
+
+  # Returns the current Rails environment as an ActiveSupport::StringInquirer
+  def self.env: () -> ActiveSupport::StringInquirer
+
+  # Returns whether CSS inlining is enabled
+  def self.inlining_css?: () -> bool
+
+  # Returns the Shakapacker configuration object
+  def self.config: () -> Configuration
+
+  # Returns the compiler instance for compiling assets
+  def self.compiler: () -> Compiler
+
+  # Returns the manifest instance for looking up compiled assets
+  def self.manifest: () -> Manifest
+
+  # Returns the commands instance for build operations
+  def self.commands: () -> Commands
+
+  # Returns the dev server instance for querying server status
+  def self.dev_server: () -> DevServer
+
+  # Creates the default configuration files and directory structure
+  def self.bootstrap: () -> void
+
+  # Removes old compiled packs, keeping the most recent versions
+  def self.clean: (?Integer, ?Integer) -> bool
+
+  # Removes all compiled packs
+  def self.clobber: () -> void
+
+  # Compiles all webpack/rspack packs
+  def self.compile: () -> bool
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.3.4.beta.0
+  version: 9.3.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,6 @@ files:
 - TODO_v9.md
 - __mocks__/nonexistent/package.json
 - __mocks__/sass-loader/package.json
-- bin/shakapacker-config
 - conductor-setup.sh
 - conductor.json
 - config/README.md
@@ -341,6 +354,17 @@ files:
 - scripts/remove-use-strict.js
 - scripts/type-check-no-emit.js
 - shakapacker.gemspec
+- sig/shakapacker.rbs
+- sig/shakapacker/commands.rbs
+- sig/shakapacker/compiler.rbs
+- sig/shakapacker/compiler_strategy.rbs
+- sig/shakapacker/configuration.rbs
+- sig/shakapacker/dev_server.rbs
+- sig/shakapacker/env.rbs
+- sig/shakapacker/helper.rbs
+- sig/shakapacker/instance.rbs
+- sig/shakapacker/manifest.rbs
+- sig/shakapacker/version.rbs
 - test/configExporter/buildValidator.test.js
 - test/configExporter/configFile.test.js
 - test/configExporter/integration.test.js
@@ -389,7 +413,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.4.beta.0
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.4
 rdoc_options: []
 require_paths:
 - lib

data/bin/shakapacker-config

@@ -1,11 +0,0 @@
-#!/usr/bin/env node
-
-// Minimal shim - all logic is in the TypeScript module
-const { run } = require("shakapacker/configExporter")
-
-run(process.argv.slice(2))
-  .then((exitCode) => process.exit(exitCode))
-  .catch((error) => {
-    console.error(error.message)
-    process.exit(1)
-  })