shakapacker 7.0.1 → 7.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4aaa412d5721d91a27e137f18413f5c3782c8a922911b35fa712f776d04e31b
-  data.tar.gz: afabe31c503c8bfabe21d52fa0e401c9f4b80696a274013058ef417f0b419c26
+  metadata.gz: c9451e388d4f6c2419456201c10b56e5f24ef5a1b6abaf82fb950187f16c4cbb
+  data.tar.gz: 9082cdaec1dffb060c1a903a3589373170741d0744b65c41d6d901669b77d614
 SHA512:
-  metadata.gz: 0b2367ca20d0cb3da0ff8265ad22551bf288706d76afa84ace8700d091a99b6c201bf11d44116481bd1e89336ea154972314f3a2117cb14ad6dd3bd2152012d9
-  data.tar.gz: f1cbdf73ce49838513d888ccc86c20185331bc4d0e7934ff88d7ee7d2c4a89efed8e98253c511351ce32bec9faefc0d73c899e07a268fb977cacd772788b841d
+  metadata.gz: bc8eb8a8b9b52b4a1a9c2a1bcb4ae6e24f59484ea97f660e030a5660b5c6b4d8b077f8e784fbf6f1bf032e5d89b0c26b7d5b421b8c2692747aafb9820e46971b
+  data.tar.gz: c3a7d20636ee49637516df81a72813f34f82dceb88ecd1dbc276071f6d44ce756326094d9b31feaf93d8d83325687af37eaead127b3f00e8cf25e9d65764be6f

data/.github/workflows/dummy.yml

@@ -1,6 +1,6 @@
 name: Dummy specs
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:

data/.github/workflows/generator.yml

@@ -1,6 +1,6 @@
 name: Generator specs
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:

data/.github/workflows/jest.yml

@@ -1,6 +1,6 @@
 name: Jest specs
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   jest:

data/.github/workflows/js-lint.yml

@@ -1,6 +1,6 @@
 name: JS lint
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   lint:

data/.github/workflows/rubocop.yml

@@ -1,6 +1,6 @@
 name: Rubocop
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   rubocop:

data/.github/workflows/ruby-backward-compatibility.yml

@@ -1,6 +1,6 @@
 name: Ruby specs - Backward compatibility
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:
@@ -15,7 +15,7 @@ jobs:
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
           # Uncomment the following line only to ensure compatibility with the
-          # upcomming Rails versions, maybe before a release.
+          # upcoming Rails versions, maybe before a release.
           #- gemfiles/Gemfile-rails-edge
         exclude:
           - ruby: 2.6

data/.github/workflows/ruby.yml

@@ -1,6 +1,6 @@
 name: Ruby specs
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:

data/CHANGELOG.md

@@ -9,9 +9,19 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+## [v7.0.3] - July 7, 2023
+### Fixed
+- Fixed commands execution for projects with space in absolute path [PR 322](https://github.com/shakacode/shakapacker/pull/322) by [kukicola](https://github.com/kukicola).
+
+## [v7.0.2] - July 3, 2023
+### Fixed
+- Fixed creation of assets:precompile if it is missing [PR 325](https://github.com/shakacode/shakapacker/pull/325) by [ahangarha](https://github.com/ahangarha).
+
+## [v7.0.1] - June 27, 2023
 ### Fixed
 - Fixed the condition for showing warning for setting `useContentHash` to `false` in the production environment. [PR 320](https://github.com/shakacode/shakapacker/pull/320) by [ahangarha](https://github.com/ahangarha).
 
+## [v7.0.0] - June 23, 2023
 ### Breaking changes
 - Removes defaults passed to `@babel/preset-typescript`. [PR 273](https://github.com/shakacode/shakapacker/pull/273) by [tomdracz](https://github.com/tomdracz).
 
@@ -257,7 +267,11 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 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/v6.6.0...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.0.3...master
+[v7.0.3]: https://github.com/shakacode/shakapacker/compare/v7.0.2...v7.0.3
+[v7.0.2]: https://github.com/shakacode/shakapacker/compare/v7.0.1...v7.0.2
+[v7.0.1]: https://github.com/shakacode/shakapacker/compare/v7.0.0...v7.0.1
+[v7.0.0]: https://github.com/shakacode/shakapacker/compare/v6.6.0...v7.0.0
 [v6.6.0]: https://github.com/shakacode/shakapacker/compare/v6.5.6...v6.6.0
 [v6.5.6]: https://github.com/shakacode/shakapacker/compare/v6.5.5...v6.5.6
 [v6.5.5]: https://github.com/shakacode/shakapacker/compare/v6.5.4...v6.5.5

data/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Thank you for your interest in contributing to Shakapacker! We welcome all contr
 - [Testing the generator](#testing-the-generator)
 
 ## Reporting Issues
-If you encounter any issues with the project, please first check the exisiting issues (including closed ones). If the issues is not reported before, please opening an issue on our GitHub repository. Please provide a clear and detailed description of the issue, including steps to reproduce it. Creating a demo repository to demonstrate the issue would be ideal (and in some cases necessary).
+If you encounter any issues with the project, please first check the existing issues (including closed ones). If the issues is not reported before, please opening an issue on our GitHub repository. Please provide a clear and detailed description of the issue, including steps to reproduce it. Creating a demo repository to demonstrate the issue would be ideal (and in some cases necessary).
 
 If looking to contribute to the project by fixing existing issues, we recommend looking at issues, particularly with the "[help wanted](https://github.com/shakacode/shakapacker/issues?q=is%3Aissue+label%3A%22help+wanted%22)" label.
 
@@ -41,7 +41,7 @@ We welcome pull requests that fix bugs, add new features, or improve existing on
       # In Rails app for testing
       yalc link shakapacker
 
-      # After every chagnes in shakapacker, run the folloing in Shakapacker directory
+      # After every change in shakapacker, run the following in Shakapacker directory
       yalc push # or yalc publish --push
       ```
 3. Run the following commands to set up the development environment.
@@ -101,7 +101,7 @@ bundle exec rake run_spec:gem
 ```
 
 #### 4.4 Run only Shakapacker gem specs for backward compatibility
-These specs are to check Shakapcker v7 backward compatibility with v6.x
+These specs are to check Shakapacker v7 backward compatibility with v6.x
 
 ```
 bundle exec rake run_spec:gem_bc
@@ -125,4 +125,3 @@ To ensure that your installer works as expected, either you can run `bundle exec
 3. Run `bundle exec rails shakapacker:install` to confirm that you got the right changes.
 
  **Note:** Ensure that you use bundle exec otherwise the installed shakapacker gem will run and not the one you are working on.
-

data/README.md

@@ -15,13 +15,13 @@ _Official, actively maintained successor to [rails/webpacker](https://github.com
 [![Gem](https://img.shields.io/gem/v/shakapacker.svg)](https://rubygems.org/gems/shakapacker)
 [![npm version](https://badge.fury.io/js/shakapacker.svg)](https://badge.fury.io/js/shakapacker)
 
-Shakpacker makes it easy to use the JavaScript pre-processor and bundler [Webpack v5+](https://webpack.js.org/)
+Shakapacker makes it easy to use the JavaScript pre-processor and bundler [Webpack v5+](https://webpack.js.org/)
 to manage frontend JavaScript in Rails. It can coexist with the asset pipeline,
 leaving Webpack responsible solely for frontend JavaScript, or can be used exclusively, making it also responsible for images, fonts, and CSS.
 
 Check out 6.1.1+ for [SWC](https://swc.rs/) and [esbuild-loader](https://github.com/privatenumber/esbuild-loader) support! They are faster than Babel!
 
-See a comparison of [Shakapacker with jsbundling-rails](https://github.com/rails/jsbundling-rails/blob/main/docs/comparison_with_webpacker.md). For a in-depth discussion of choosing between `shakapacker` and `jsbundling-rails`, see the discussion [Webpacker alternatives - which path should we go to? #8783](https://github.com/decidim/decidim/discussions/8783) and the resulting PR [Switch away from Webpacker to Shakapacker #10389](https://github.com/decidim/decidim/pull/10389).
+See a comparison of [Shakapacker with jsbundling-rails](https://github.com/rails/jsbundling-rails/blob/main/docs/comparison_with_webpacker.md). For an in-depth discussion of choosing between `shakapacker` and `jsbundling-rails`, see the discussion [Webpacker alternatives - which path should we go to? #8783](https://github.com/decidim/decidim/discussions/8783) and the resulting PR [Switch away from Webpacker to Shakapacker #10389](https://github.com/decidim/decidim/pull/10389).
 
 For discussions, see our [Slack Channel](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
 
@@ -214,7 +214,7 @@ public/packs                # webpack output
 
 Webpack intelligently includes only necessary files. In this example, the file `packs/application.js` would reference `../src/my_component.js`
 
-`nested_entries` allows you to have webpack entry points nested in subdirectories. This defaults to false so you don't accidentally create entry points for an entire tree of files. In other words, with `nested_entries: false`, you can have your entire `source_path` used for your source (using the `source_entry_path: /`) and you place files at the top level that you want as entry points. `nested_entries: true` allows you to have entries that are in subdirectories. This is useful if you have entries that are generated, so you can have a `generated` subdirectory and easily separate generated files from the rest of your codebase.
+`nested_entries` allows you to have webpack entry points nested in subdirectories. This defaults to true as of shakapacker v7. With `nested_entries: false`, you can have your entire `source_path` used for your source (using the `source_entry_path: /`) and you place files at the top level that you want as entry points. `nested_entries: true` allows you to have entries that are in subdirectories. This is useful if you have entries that are generated, so you can have a `generated` subdirectory and easily separate generated files from the rest of your codebase.
 
 To enable/disable the usage of contentHash in any node environment (specified using the `NODE_ENV` environment variable), add/modify `useContentHash` with a boolean value in `config/shakapacker.yml`. This feature is disabled for all environments except production by default. You may not disable the content hash for a `NODE_ENV` of production as that would break the browser caching of assets. Notice that despite the possibility of enabling this option for the development environment, [it is not recommended](https://webpack.js.org/guides/build-performance/#avoid-production-specific-tooling).
 
@@ -893,6 +893,11 @@ The following companies support our Open Source projects, and ShakaCode uses the
     <img alt="ScoutAPM" src="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png" height="120px">
   </picture>
 </a>
+<a href="https://controlplane.com">
+  <picture>
+    <img alt="Control Plane" src="https://github.com/shakacode/.github/assets/20628911/90babd87-62c4-4de3-baa4-3d78ef4bec25" height="120px">
+  </picture>
+</a>
 <br />
 <a href="https://www.browserstack.com">
   <picture>

data/docs/deployment.md

@@ -94,7 +94,7 @@ If you are using a CDN setup, Shakapacker does NOT use the `ASSET_HOST` environm
 
 ### Assets compiling on every deployment even if JavaScript and CSS files are not changed
 
-Make sure you have your public outputh path (default `public/packs`), the shakapacker cache path (default `tmp/shakapacker`) and `node_modules` in `:linked_dirs`
+Make sure you have your public output path (default `public/packs`), the shakapacker cache path (default `tmp/shakapacker`) and `node_modules` in `:linked_dirs`
 
 ```ruby
 append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "tmp/shakapacker", "public/packs", ".bundle", "node_modules"

data/docs/react.md

@@ -1,6 +1,6 @@
 # React Integration
 
-These steps describe how to create a Rails/React app, using Shakapacker as the bundler.
+These steps describe creating a Rails/React app, using Shakapacker as the bundler.
 
 Before starting, ensure that you have Yarn installed, for example:
 
@@ -45,7 +45,7 @@ And that's it. You can now create a React app using `app/javascript/application.
 
 With HMR enabled, Shakapacker will automatically update only that part of the page that changed when it detects changes in your project files. This has the nice advantage of preserving your app’s state.
 
-To enable HMR in a React app, proceed as follows:.
+To enable HMR in a React app, proceed as follows:
 
 In `config/shakapacker.yml` set `hmr` is set to `true`.
 
@@ -262,7 +262,7 @@ module.exports = function (api) {
 }
 ```
 
-9. Start the Rails server and the webpack-dev-server in separate console windows:
+9. Start the Rails server and the `shakapacker-dev-server` in separate console windows:
 ```shell
 rails s
 ./bin/shakapacker-dev-server
@@ -272,4 +272,4 @@ rails s
 
 11. Edit either the React component at `app/javascript/App.js` or the CSS file at `app/javascript/App.css` and observe the HMR goodness.
 
-Note that HMR will not work if you edit `app/javascript/application.js` and you experience a full refresh with a warning in the console. For more info on this, see here: https://github.com/pmmmwh/react-refresh-webpack-plugin/issues/177
+Note that HMR will not work if you edit `app/javascript/application.js` and experience a full refresh with a warning in the console. For more info on this, see here: https://github.com/pmmmwh/react-refresh-webpack-plugin/issues/177

data/docs/using_esbuild_loader.md

@@ -8,7 +8,7 @@ If you face any issues, please report them at https://github.com/shakacode/shaka
 
 [esbuild](https://esbuild.github.io/) is a Go-based bundler tool that can offer [significant improvement](https://esbuild.github.io/faq/#benchmark-details) over other similar tools.
 
-While esbuild is a complete bundler, through the usage of [esbuild-loader](https://github.com/privatenumber/esbuild-loader), you can still leverage esbuild's speedy transpilation and minifcation in your Webpack-based configs.
+While esbuild is a complete bundler, through the usage of [esbuild-loader](https://github.com/privatenumber/esbuild-loader), you can still leverage esbuild's speedy transpilation and minification in your Webpack-based configs.
 
 Please note, that unlike Babel or SWC loader, esbuild-loader has got no support for things like:
 - React Hot Module reload

data/docs/v6_upgrade.md

@@ -97,7 +97,7 @@ _If you're on webpacker v5, follow [how to upgrade to webpacker v6.0.0.rc.6 from
    ```
    If you prefer this configuration, then you will move your `app/javascript/packs/*` (including `application.js`) to `app/javascript/` and update the configuration file.
 
-   Note, moving your files is optional, as you can stil keep your entries in a separate directory, called something like `packs`, or `entries`. This directory is defined with the `source_path`.
+   Note, moving your files is optional, as you can still keep your entries in a separate directory, called something like `packs`, or `entries`. This directory is defined with the `source_path`.
 
 1. Update `webpack-dev-server` to the current version, greater than 4.2, updating `package.json`.
 

data/docs/v7_upgrade.md

@@ -1,48 +1,51 @@
 # Upgrading from Shakapacker v6 to v7
 
-There will be several substantial and breaking changes in Shakapacker v7 that you need to manually account for when coming from Shakapacker v6.
+There are several breaking changes in Shakapacker v7 that you need to manually account for when coming from Shakapacker v6.
 
-## Usages of 'webpacker' should now be 'shakapacker'
+## Usages of `webpacker` should now be `shakapacker`
 
 Shakapacker v6 kept the 'webpacker' spelling. As a result, many config filenames, environment variables, rake tasks, etc., used the 'webpacker' spelling. Shakapacker 7 requires renaming to the 'shakapacker' spelling.
 
 Shakapacker v7 provides a high degree of backward compatibility for spelling changes. It displays deprecation messages in the terminal to help the developers have a smooth experience in making the required transition to the new requirements.
 
-Please note that Shakapacker v8 will remove any backward compatibility for spelling.
+Just so you know, Shakapacker v8 will remove any backward compatibility for spelling.
 
 ### Upgrade Steps
 
 **Note:** At each step of changing the version, ensure that you update both gem and npm versions to the same "exact" version (like `x.y.z` and not `^x.y.z` or `>= x.y.z`).
 
-1. Upgrade Shakapacker to the latest 6.x version and ensure no issues running your application. 
+1. Upgrade Shakapacker to the latest 6.x version and make sure there are no issues running your application. 
 2. Upgrade Shakapacker to version 7.
 3. Run `rake shakapacker:binstubs` to get the new files in place. Then delete the `bin/webpacker` and `bin/webpacker-dev-server` ones.
 4. Change spelling from Webpacker to Shakapacker in the code
    - Change `webpacker_precompile` entry to `shakapacker_precompile` if it exists in the config file.
-   - Rename Ruby constant `Webpacker` to `Shakapacker` doing a global search and replace in your code. You might not be using it.
+   - Rename Ruby constant `Webpacker` to `Shakapacker` by doing a global search and replace in your code. You might not be using it.
      - Rename`Shakapacker.config.webpacker_precompile?` method, replace it with `Shakapacker.config.shakapacker_precompile?`
    - `--debug-webpacker` is now `--debug-shakapacker` for your shakapacker binstubs.
 5. Rename files
     - Rename `config/webpacker.yml` to `config/shakapacker.yml`.
     - Rename environment variables from `WEBPACKER_XYZ` to `SHAKAPACKER_XYZ`.
-6. Where you have used webpackConfig, you now need to invoke it as it is a function. Alternatively, you can rename the import to globalMutableWebpackConfig which retains the v6 behavior.
-7. You may need to upgrade dependencies in package.json. You should use `yarn upgrade-interactive`. Note, some upgrades introduce issues. Some will fix issues. You may need to try a few different versions of a dependency to find one that works.
+6. Where you have used webpackConfig, you must create a new instance with `generateWebpackConfig`. Alternatively, you can rename the import to globalMutableWebpackConfig, which retains the v6 behavior of a global, mutable object.
+7. You may need to upgrade dependencies in package.json. You should use `yarn upgrade-interactive`.
 
+## Stop stripping top-level dirs for static assets
+
+When generating file paths for static assets, a top-level directory will no longer be stripped. This will necessitate the update of file name references in asset helpers. For example, the file sourced from `app/javascript/images/image.png` will now be output to `static/images/image.png`, and needs to be referenced as `image_pack_tag("images/image.jpg")` or `image_pack_tag("static/images/image.jpg")`. Nested directories are supported.
 
 ## The `webpackConfig` property is changed
 
 The `webpackConfig` property in the `shakapacker` module has been changed. The shakapacker module has two options:
-1. `generatedWebpackConfig`: a function that returns an immutable webpack configuration object, which ensures that any modifications made to it will not affect any other usage of the webpack configuration. 
-2. `globalMutableWebpackConfig`: if a project still requires the old mutable object. You can rename your imports of `webpackConfig` with `globalMutableWebpackConfig`.
+1. `generateWebpackConfig`: a function that returns a new webpack configuration object, which ensures that any modifications made to it will not affect any other usage of the webpack configuration.
+2. `globalMutableWebpackConfig`: if a project still desires the old mutable object. You can rename your imports of `webpackConfig` with `globalMutableWebpackConfig`.
 
-### Example Upgrade
+## Example Upgrade
 If you started with:
 
 ```js
 const { webpackConfig } = require('shakapacker')
 ```
 
-Swtich to:
+Switch to:
 
 ```js
 const { generateWebpackConfig } = require('shakapacker')

data/lib/shakapacker/compiler.rb

@@ -82,7 +82,7 @@ class Shakapacker::Compiler
 
       stdout, stderr, status = Open3.capture3(
         webpack_env,
-        "#{optionalRubyRunner} #{bin_shakapacker_path}",
+        "#{optionalRubyRunner} '#{bin_shakapacker_path}'",
         chdir: File.expand_path(config.root_path)
       )
 

data/lib/shakapacker/utils/misc.rb

@@ -29,7 +29,7 @@ module Shakapacker
 
       # Executes a string or an array of strings in a shell in the given directory in an unbundled environment
       def self.sh_in_dir(dir, *shell_commands)
-        shell_commands.flatten.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+        shell_commands.flatten.each { |shell_command| sh %(cd '#{dir}' && #{shell_command.strip}) }
       end
     end
   end

data/lib/shakapacker/version.rb

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

data/lib/tasks/shakapacker/binstubs.rake

@@ -7,9 +7,9 @@ namespace :shakapacker do
     prefix = task.name.split(/#|shakapacker:binstubs/).first
 
     if Rails::VERSION::MAJOR >= 5
-      exec "#{RbConfig.ruby} #{bin_path}/rails #{prefix}app:template LOCATION='#{binstubs_template_path}'"
+      exec "#{RbConfig.ruby} '#{bin_path}/rails' #{prefix}app:template LOCATION='#{binstubs_template_path}'"
     else
-      exec "#{RbConfig.ruby} #{bin_path}/rake #{prefix}rails:template LOCATION='#{binstubs_template_path}'"
+      exec "#{RbConfig.ruby} '#{bin_path}/rake' #{prefix}rails:template LOCATION='#{binstubs_template_path}'"
     end
   end
 end

data/lib/tasks/shakapacker/check_binstubs.rake

@@ -1,12 +1,17 @@
 namespace :shakapacker do
   desc "Verifies that bin/shakapacker is present"
   task :check_binstubs do
-    verify_file_existance("bin/shakapacker", "bin/webpacker")
-    verify_file_existance("bin/shakapacker-dev-server", "bin/webpacker-dev-server")
+    verify_file_existence("bin/shakapacker", "bin/webpacker")
+    verify_file_existence("bin/shakapacker-dev-server", "bin/webpacker-dev-server")
   end
 end
 
 def verify_file_existance(main_file, alternative_file)
+  puts "verify_file_existance is deprecated - use verify_file_existence instead"
+  verify_file_existence(main_file, alternative_file)
+end
+
+def verify_file_existence(main_file, alternative_file)
   unless File.exist?(Rails.root.join(main_file))
     if File.exist?(Rails.root.join(alternative_file))
       Shakapacker.puts_deprecation_message(

data/lib/tasks/shakapacker/compile.rake

@@ -22,5 +22,7 @@ end
 if Shakapacker.config.shakapacker_precompile?
   if Rake::Task.task_defined?("assets:precompile")
     invoke_shakapacker_compile_in_assets_precompile_task
+  else
+    Rake::Task.define_task("assets:precompile" => ["shakapacker:compile"])
   end
 end

data/lib/tasks/shakapacker/install.rake

@@ -9,9 +9,9 @@ namespace :shakapacker do
     prefix = task.name.split(/#|shakapacker:install/).first
 
     if Rails::VERSION::MAJOR >= 5
-      exec "#{RbConfig.ruby} #{bin_path}/rails #{prefix}app:template LOCATION='#{install_template_path}'"
+      exec "#{RbConfig.ruby} '#{bin_path}/rails' #{prefix}app:template LOCATION='#{install_template_path}'"
     else
-      exec "#{RbConfig.ruby} #{bin_path}/rake #{prefix}rails:template LOCATION='#{install_template_path}'"
+      exec "#{RbConfig.ruby} '#{bin_path}/rake' #{prefix}rails:template LOCATION='#{install_template_path}'"
     end
   end
 end

data/package/environments/__tests__/base-bc.js

@@ -1,6 +1,6 @@
 /* global test expect, describe, afterAll, beforeEach */
 
-// environment.js expects to find config/webapacker.yml and resolved modules from
+// environment.js expects to find config/webpacker.yml and resolved modules from
 // the root of a Rails project
 
 const { resetEnv, chdirWebpackerTestApp } = require('../../utils/helpers')

data/package/environments/__tests__/development.js

@@ -16,10 +16,10 @@ describe('Development specific config', () => {
     test('sets filename to use contentHash', () => {
       const config = require("../../config");
       config.useContentHash = true
-      const environmnetConfig = require('../development')
+      const environmentConfig = require('../development')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name]-[contenthash].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name]-[contenthash].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name]-[contenthash].chunk.js'
       )
     })
@@ -29,10 +29,10 @@ describe('Development specific config', () => {
     test('sets filename without using contentHash', () => {
       const config = require("../../config");
       config.useContentHash = false
-      const environmnetConfig = require('../development')
+      const environmentConfig = require('../development')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name].chunk.js'
       )
     })
@@ -42,10 +42,10 @@ describe('Development specific config', () => {
     test('sets filename without using contentHash', () => {
       const config = require("../../config");
       delete config.useContentHash
-      const environmnetConfig = require('../development')
+      const environmentConfig = require('../development')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name].chunk.js'
       )
     })

data/package/environments/__tests__/production.js

@@ -16,10 +16,10 @@ describe('Production specific config', () => {
     test('sets filename to use contentHash', () => {
       const config = require("../../config");
       config.useContentHash = true
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name]-[contenthash].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name]-[contenthash].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name]-[contenthash].chunk.js'
       )
     })
@@ -28,7 +28,7 @@ describe('Production specific config', () => {
       const consoleWarnSpy = jest.spyOn(console, 'warn');
       const config = require("../../config");
       config.useContentHash = true
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
       expect(consoleWarnSpy).not.toHaveBeenCalledWith(
         expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)
@@ -42,10 +42,10 @@ describe('Production specific config', () => {
     test('sets filename to use contentHash', () => {
       const config = require("../../config");
       config.useContentHash = false
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name]-[contenthash].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name]-[contenthash].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name]-[contenthash].chunk.js'
       )
     })
@@ -54,7 +54,7 @@ describe('Production specific config', () => {
       const consoleWarnSpy = jest.spyOn(console, 'warn');
       const config = require("../../config");
       config.useContentHash = false
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
       expect(consoleWarnSpy).toHaveBeenCalledWith(
         expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)
@@ -68,10 +68,10 @@ describe('Production specific config', () => {
     test('sets filename to use contentHash', () => {
       const config = require("../../config");
       delete config.useContentHash
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
-      expect(environmnetConfig.output.filename).toEqual('js/[name]-[contenthash].js')
-      expect(environmnetConfig.output.chunkFilename).toEqual(
+      expect(environmentConfig.output.filename).toEqual('js/[name]-[contenthash].js')
+      expect(environmentConfig.output.chunkFilename).toEqual(
         'js/[name]-[contenthash].chunk.js'
       )
     })
@@ -80,7 +80,7 @@ describe('Production specific config', () => {
       const consoleWarnSpy = jest.spyOn(console, 'warn');
       const config = require("../../config");
       delete config.useContentHash
-      const environmnetConfig = require('../production')
+      const environmentConfig = require('../production')
 
       expect(consoleWarnSpy).not.toHaveBeenCalledWith(
         expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)

data/package/index.d.ts

@@ -0,0 +1,61 @@
+declare module 'shakapacker' {
+  import { Configuration } from 'webpack'
+
+  export interface Config {
+    source_path: string
+    source_entry_path: string
+    nested_entries: boolean
+    css_extract_ignore_order_warnings: boolean
+    public_root_path: string
+    public_output_path: string
+    cache_path: string
+    webpack_compile_output: boolean
+    shakapacker_precompile: boolean
+    additional_paths: string[]
+    cache_manifest: boolean
+    webpack_loader: string
+    ensure_consistent_versioning: boolean
+    compiler_strategy: string
+    useContentHash: boolean
+    compile: boolean,
+    outputPath: string
+    publicPath: string
+    publicPathWithoutCDN: string
+    manifestPath: string
+  }
+
+  export interface Env {
+    railsEnv: string
+    nodeEnv: string
+    isProduction: boolean
+    isDevelopment: boolean
+    runningWebpackDevServer: boolean
+  }
+
+  export const config: Config
+  export const devServer: Record<string, unknown>
+  export function generateWebpackConfig(): Configuration
+  export const globalMutableWebpackConfig: Configuration
+  export const baseConfig: Configuration
+  export const env: Env
+  export const rules: Record<string, unknown>
+  export function moduleExists(packageName: string): boolean
+  export function canProcess<T = unknown>(rule: string, fn: (modulePath: string) => T): T | null
+  export const inliningCss: boolean
+  export * from 'webpack-merge'
+}
+
+declare module 'shakapacker/package/babel/preset.js' {
+  import { ConfigAPI, PluginItem, TransformOptions } from '@babel/core'
+
+  interface RequiredTransformOptions {
+    plugins: PluginItem[]
+    presets: PluginItem[]
+  }
+
+  const defaultConfigFunc: (
+    api: ConfigAPI
+  ) => TransformOptions & RequiredTransformOptions
+
+  export = defaultConfigFunc
+}

data/package.json

@@ -1,8 +1,9 @@
 {
   "name": "shakapacker",
-  "version": "7.0.1",
+  "version": "7.0.3",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
+  "types": "package/index.d.ts",
   "files": [
     "package",
     "lib/install/config/shakapacker.yml"
@@ -12,6 +13,8 @@
     "yarn": ">=1 <4"
   },
   "peerDependencies": {
+    "@types/babel__core": "^7.0.0",
+    "@types/webpack": "^5.0.0",
     "@babel/core": "^7.17.9",
     "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
@@ -25,6 +28,14 @@
     "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },
+  "peerDependenciesMeta": {
+    "@types/babel__core": {
+      "optional": true
+    },
+    "@types/webpack": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "glob": "^7.2.0",
     "js-yaml": "^4.1.0",

data/rakelib/release.rake

@@ -25,7 +25,7 @@ Note, accept defaults for npmjs options. Script will pause to get 2FA tokens.
 
 Example: `rake release[2.1.0,false]`")
 task :create_release, %i[gem_version dry_run] do |_t, args|
-  # Check if there are uncommited changes
+  # Check if there are uncommitted changes
   Shakapacker::Utils::Misc.uncommitted_changes?(RaisingMessageHandler.new)
   args_hash = args.to_hash
 

data/spec/backward_compatibility_specs/compiler_spec.rb

@@ -26,7 +26,7 @@ describe "Webpacker::Compiler" do
     allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: true)
-    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
 
     expect(Webpacker.compiler.compile).to be true
     expect(mocked_strategy).to have_received(:after_compile_hook)
@@ -40,7 +40,7 @@ describe "Webpacker::Compiler" do
     allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: false)
-    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
 
     expect(Webpacker.compiler.compile).to be false
     expect(mocked_strategy).to have_received(:after_compile_hook)

data/spec/backward_compatibility_specs/configuration_spec.rb

@@ -56,7 +56,7 @@ describe "Webpacker::Configuration" do
         expect(config.cache_manifest?).to be true
       end
 
-      it "returns false in developemnt environemnt" do
+      it "returns false in development environment" do
         with_rails_env("development") do
           expect(Webpacker.config.cache_manifest?).to be false
         end
@@ -74,13 +74,13 @@ describe "Webpacker::Configuration" do
         expect(config.compile?).to be false
       end
 
-      it "returns true in developemnt environemnt" do
+      it "returns true in development environment" do
         with_rails_env("development") do
           expect(Webpacker.config.compile?).to be true
         end
       end
 
-      it "returns true in test environemnt" do
+      it "returns true in test environment" do
         with_rails_env("test") do
           expect(Webpacker.config.compile?).to be true
         end
@@ -190,7 +190,7 @@ describe "Webpacker::Configuration" do
     end
   end
 
-  context "with webpacker config file containing manifext_path entry" do
+  context "with webpacker config file containing manifest_path entry" do
     config = Webpacker::Configuration.new(
       root_path: ROOT_PATH,
       config_path: Pathname.new(File.expand_path("./webpacker_test_app/config/webpacker_manifest_path.yml", __dir__)),

data/spec/generator_specs/generator_spec.rb

@@ -33,7 +33,7 @@ describe "Generator" do
   describe "shakapacker:install" do
     context "in a normal Rails project" do
       before :all do
-        sh_in_dir(SPEC_PATH, "cp -r #{BASE_RAILS_APP_PATH} #{TEMP_RAILS_APP_PATH}")
+        sh_in_dir(SPEC_PATH, "cp -r '#{BASE_RAILS_APP_PATH}' '#{TEMP_RAILS_APP_PATH}'")
 
         Bundler.with_unbundled_env do
           sh_in_dir(TEMP_RAILS_APP_PATH, "FORCE=true bundle exec rails shakapacker:install")
@@ -65,8 +65,8 @@ describe "Generator" do
         ]
 
         Dir.chdir(path_in_the_app("config/webpack")) do
-          exisiting_files_in_config_webpack_dir = Dir.glob("*")
-          expect(exisiting_files_in_config_webpack_dir).to eq expected_files
+          existing_files_in_config_webpack_dir = Dir.glob("*")
+          expect(existing_files_in_config_webpack_dir).to eq expected_files
         end
       end
 
@@ -94,12 +94,12 @@ describe "Generator" do
         expect(actual_content).to match '<%= javascript_pack_tag "application" %>'
       end
 
-      it "updates `bin/setup" do
+      it "updates `bin/setup`" do
         setup_file_content = read(path_in_the_app("bin/setup"))
         expect(setup_file_content).to match %r(^\s*system!\(['"]bin/yarn['"]\))
       end
 
-      it "adds relevant shakapacker version in package.json depending on gem version," do
+      it "adds relevant shakapacker version in package.json depending on gem version" do
         npm_version = Shakapacker::Utils::VersionSyntaxConverter.new.rubygem_to_npm(Shakapacker::VERSION)
 
         actual_content = read(path_in_the_app("package.json"))

data/spec/shakapacker/compiler_spec.rb

@@ -26,7 +26,7 @@ describe "Shakapacker::Compiler" do
     allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: true)
-    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
 
     expect(Shakapacker.compiler.compile).to be true
     expect(mocked_strategy).to have_received(:after_compile_hook)
@@ -40,7 +40,7 @@ describe "Shakapacker::Compiler" do
     allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: false)
-    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
 
     expect(Shakapacker.compiler.compile).to be false
     expect(mocked_strategy).to have_received(:after_compile_hook)

data/spec/shakapacker/configuration_spec.rb

@@ -56,7 +56,7 @@ describe "Shakapacker::Configuration" do
         expect(config.cache_manifest?).to be true
       end
 
-      it "returns false in developemnt environemnt" do
+      it "returns false in development environment" do
         with_rails_env("development") do
           expect(Shakapacker.config.cache_manifest?).to be false
         end
@@ -74,13 +74,13 @@ describe "Shakapacker::Configuration" do
         expect(config.compile?).to be false
       end
 
-      it "returns true in developemnt environemnt" do
+      it "returns true in development environment" do
         with_rails_env("development") do
           expect(Shakapacker.config.compile?).to be true
         end
       end
 
-      it "returns true in test environemnt" do
+      it "returns true in test environment" do
         with_rails_env("test") do
           expect(Shakapacker.config.compile?).to be true
         end
@@ -189,7 +189,7 @@ describe "Shakapacker::Configuration" do
     end
   end
 
-  context "with shakapacker config file containing manifext_path entry" do
+  context "with shakapacker config file containing manifest_path entry" do
     config = Shakapacker::Configuration.new(
       root_path: ROOT_PATH,
       config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_manifest_path.yml", __dir__)),

data/spec/shakapacker/rake_tasks_spec.rb

@@ -44,7 +44,7 @@ describe "RakeTasks" do
       Dir.chdir(TEST_APP_PATH)
     end
 
-    context "with existing `./bin/shapapacker` and `./bin/shapapacker-dev-server`" do
+    context "with existing `./bin/shakapacker` and `./bin/shakapacker-dev-server`" do
       it "passes" do
         expect { system("bundle exec rake shakapacker:check_binstubs") }.to output("").to_stdout_from_any_process
       end

data/spec/shakapacker/version_checker_spec.rb

@@ -451,19 +451,19 @@ describe "VersionChecker::NodePackageVersion" do
     context "from exact semantic version" do
       let(:node_package_version_from_semver_exact) { node_package_version(fixture_version: "semver_exact") }
 
-      it "#raw retruns version" do
+      it "#raw returns version" do
         expect(node_package_version_from_semver_exact.raw).to eq "6.0.0"
       end
 
-      it "#major_minor_patch retruns version array" do
+      it "#major_minor_patch returns version array" do
         expect(node_package_version_from_semver_exact.major_minor_patch).to eq ["6", "0", "0"]
       end
 
-      it "#skip_processing? retruns false" do
+      it "#skip_processing? returns false" do
         expect(node_package_version_from_semver_exact.skip_processing?).to be false
       end
 
-      it "#semver_wildcard? retruns false" do
+      it "#semver_wildcard? returns false" do
         expect(node_package_version_from_semver_exact.semver_wildcard?).to be false
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.0.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -251,6 +251,7 @@ files:
 - package/environments/production.js
 - package/environments/test.js
 - package/esbuild/index.js
+- package/index.d.ts
 - package/index.js
 - package/rules/__tests__/__utils__/webpack.js
 - package/rules/__tests__/babel.js
@@ -528,7 +529,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.0.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.0.3
 post_install_message:
 rdoc_options: []
 require_paths: