shakapacker 6.1.0.beta.0 → 6.2.0

data/docs/v6_upgrade.md

@@ -1,48 +1,69 @@
-# Upgrading from Webpacker 5 to 6
+# Upgrading from Webpacker v5 to Shakapacker v6
 
-There are several substantial changes in Webpacker 6 that you need to manually account for when coming from Webpacker 5. This guide will help you through it.
+There are several substantial changes in Shakapacker v6 that you need to manually account for when coming from Webpacker 5. This guide will help you through it.
 
-## Webpacker has become a slimmer wrapper around Webpack
+## Webpacker/Shakapacker has become a slimmer wrapper around Webpack
 
 By default, Webpacker 6 is focused on compiling and bundling JavaScript. This pairs with the existing asset pipeline in Rails that's setup to transpile CSS and static images using [Sprockets](https://github.com/rails/sprockets). For most developers, that's the recommended combination. But if you'd like to use Webpacker for CSS and static assets as well, please see [integrations](https://github.com/shakacode/shakapacker#integrations) for more information.
 
-Webpacker used to configure Webpack indirectly, which lead to a [complicated secondary configuration process](https://github.com/rails/webpacker/blob/5-x-stable/docs/webpack.md). This was done in order to provide default configurations for the most popular frameworks, but ended up creating more complexity than it cured. So now Webpacker delegates all configuration directly to Webpack's default configuration setup.
+Webpacker used to configure Webpack indirectly, which lead to a [complicated secondary configuration process](https://github.com/rails/webpacker/blob/5-x-stable/docs/webpack.md). This was done in order to provide default configurations for the most popular frameworks, but ended up creating more complexity than it cured. So now Webpacker delegates all configuration directly to Webpack's default configuration setup. Additionally, all major dependencies, like `webpack` and `babel` are now **peer** dependencies, so you are free to upgrade those.
 
-This means you have to configure integration with frameworks yourself, but webpack-merge helps with this. See this example for [Vue](https://github.com/shakacode/shakapacker#other-frameworks) and scroll to the bottom for [more examples](#examples-of-v5-to-v6).
+While you have to configure integration with frameworks yourself, [`webpack-merge`](https://github.com/survivejs/webpack-merge) helps with this. See this example for [Vue](https://github.com/shakacode/shakapacker#other-frameworks) and scroll to the bottom for [more examples](#examples-of-v5-to-v6).
 
-## webpacker v6.0.0.rc.6 to shakapacker
+## webpacker v6.0.0.rc.6 to shakapacker v6.0.0
 See an example migration here: [PR 27](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/pull/27).
-          
-### Update
-1. Peer dependencies. Run `yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/runtime babel-loader compression-webpack-plugin terser-webpack-plugin webpack webpack-assets-manifest webpack-cli webpack-merge webpack-sources webpack-dev-server`
+
+### Update Steps to v6.0.0 from v6.0.0.rc.6
+_If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
+
+1. Change the gem name from `webpacker` to `shakapacker` and the NPM package from `@rails/webpacker` to `shakapacker`.
+1. Install the peer dependencies. Run `yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/runtime babel-loader compression-webpack-plugin terser-webpack-plugin webpack webpack-assets-manifest webpack-cli webpack-merge webpack-sources webpack-dev-server`
 1. Update any scripts that called `bin/webpack` or `bin/webpack-dev-server` to `bin/webpacker` or `bin/webpacker-dev-server`
-1. Update your webpack config for a single config file, `config/webpack/webpack.config.js`. 
-1. Update `babel.config.js` if you need JSX support. 
+1. Update your webpack config for a single config file, `config/webpack/webpack.config.js`. If you want to use the prior style of having a separate file for each NODE_ENV, you can use this shim for `config/webpack/webpack.config.js`. WARNING, previously, if you did not set `NODE_ENV`, `NODE_ENV` defaulted to `development`. Thus, you might expect `config/webpack/development.js` to run, but you'll instead be using the `config/webpack/RAILS_ENV.js`
+   ```js
+   const { env, webpackConfig } = require('shakapacker')
+   const { existsSync } = require('fs')
+   const { resolve } = require('path')
+
+   const envSpecificConfig = () => {
+     const path = resolve(__dirname, `${env.nodeEnv}.js`)
+     if (existsSync(path)) {
+       console.log(`Loading ENV specific webpack configuration file ${path}`)
+       return require(path)
+     } else {                       
+       // Probably an error if the file for the NODE_ENV does not exist
+       throw new Error(`Got Error with NODE_ENV = ${env.nodeEnv}`);
+     }
+   }
+
+   module.exports = envSpecificConfig()
+   ```
+1. Update `babel.config.js` if you need JSX support. See [Customizing Babel Config](./customizing_babel_config.md)
 
-## How to upgrade to Webpacker v6 from v5
+## How to upgrade to Webpacker v6.0.0.rc.6 from v5
 1. Ensure you have a clean working git branch. You will be overwriting all your files and reverting the changes that you don't want.
 
 1. Consider changing from the v5 default for `source_entry_path` in `webpacker.yml`.
-  ```yml
-    source_path: app/javascript
-    source_entry_path: packs
-  ```
-  consider changing to the v6 default:
-  ```yml
-    source_path: app/javascript
-    source_entry_path: /
-  ```
-  Then consider moving your `app/javascript/packs/*` (including `application.js`) to `app/javascript/` and updating 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 within the source_path.
+   ```yml
+     source_path: app/javascript
+     source_entry_path: packs
+   ```
+   consider changing to the v6 default:
+   ```yml
+     source_path: app/javascript
+     source_entry_path: /
+   ```
+   Then consider moving your `app/javascript/packs/*` (including `application.js`) to `app/javascript/` and updating 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 within the source_path.
 
 1. **Ensure no nested directories in your `source_entry_path`.** Check if you had any entry point files in child directories of your `source_entry_path`. Files for entry points in child directories are not supported by shakacode/shakapacker v6. Move those files to the top level, adjusting any imports in those files.
 
-  The new v6 configuration does not allow nesting, so as to allow placing the entry points at in the root directory of JavaScript. You can find this change [here](https://github.com/rails/webpacker/commit/5de0fbc1e16d3db0c93202fb39f5b4d80582c682#diff-7af8667a3e36201db57c02b68dd8651883d7bfc00dc9653661be11cd31feeccdL19).
+   The new v6 configuration does not allow nesting, so as to allow placing the entry points at in the root directory of JavaScript. You can find this change [here](https://github.com/rails/webpacker/commit/5de0fbc1e16d3db0c93202fb39f5b4d80582c682#diff-7af8667a3e36201db57c02b68dd8651883d7bfc00dc9653661be11cd31feeccdL19).
 
 1. Upgrade the Webpacker Ruby gem and the NPM package
 
-   Note: [Check the gem page to verify the latest version](https://rubygems.org/gems/shakapacker), and make sure to install identical version numbers of `shakapacker` gem and package. (Gems use a period and packages use a dot between the main version number and the beta version.)
+   Note: [Check the gem page to verify the latest version](https://rubygems.org/gems/shakapacker), and make sure to install identical version numbers of `shakapacker` gem and package. (Gems use a hyphen and packages use a dot between the main version number and the beta version.)
 
    Example going to a specific version:
 
@@ -59,35 +80,15 @@ See an example migration here: [PR 27](https://github.com/shakacode/react_on_rai
    yarn add shakapacker@6.0.0-rc.13 --exact
    ```
 
-  ```bash
-  bundle exec rails webpacker:install
-  ```
-
-  Overwrite all files and check what changed.
-
-  Note, the webpacker:install will install the peer dependencies:
-  ```bash
-  yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/runtime babel-loader compression-webpack-plugin terser-webpack-plugin webpack webpack-assets-manifest webpack-cli webpack-merge webpack-sources webpack-dev-server
-  ```
-
-1. There is now a single default configuration file of `config/webpack/webpack.config.js`. Previously, the config file was set
-  to `config/webpack/#{NODE_ENV}.js`. In the `config/webpack/` directory, you can either refactor your code in `test.js`, `development.js`, and `production.js` to a single file, `webpack.config.js` or you can replace the contents of `config/webpack/config.webpack.js` to conditionally load the old file based on the NODE_ENV with this snippet:
-   ```js
-   const { env, webpackConfig } = require('shakapacker')
-   const { existsSync } = require('fs')
-   const { resolve } = require('path')
+   ```bash
+   bundle exec rails webpacker:install
+   ```
 
-   const envSpecificConfig = () => {
-     const path = resolve(__dirname, `${env.nodeEnv}.js`)
-     if (existsSync(path)) {
-       console.log(`Loading ENV specific webpack configuration file ${path}`)
-       return require(path)
-     } else {
-       return webpackConfig
-     }
-   }
+   Overwrite all files and check what changed.
 
-   module.exports = envSpecificConfig()
+   Note, the webpacker:install will install the peer dependencies:
+   ```bash
+   yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/runtime babel-loader compression-webpack-plugin terser-webpack-plugin webpack webpack-assets-manifest webpack-cli webpack-merge webpack-sources webpack-dev-server
    ```
 
 1. Review the new default's changes to `webpacker.yml`. Consider each suggested change carefully, especially the change to have your `source_entry_path` be at the top level of your `source_path`.
@@ -115,51 +116,66 @@ See an example migration here: [PR 27](https://github.com/shakacode/react_on_rai
 
 1. If you are using any integrations like `css`, `postcss`, `React` or `TypeScript`. Please see https://github.com/shakacode/shakapacker#integrations section on how they work in v6.
 
-1. Import `environment` changed to `webpackConfig`. For example, the new code looks like:
+1. `config/webpack/environment.js` was changed to `config/webpack/base.js` and exports a native webpack config so no need to call `toWebpackConfig`.
+   Use `merge` to make changes:
+   
    ```js
-   // config/webpack/webpack.config.js
-   const { webpackConfig, merge } = require('shakapacker')
-   const customConfig = require('./custom')
-
-   module.exports = merge(webpackConfig, customConfig)
+   // config/webpack/base.js
+   const { webpackConfig, merge } = require('@rails/webpacker');
+   const customConfig = {
+     module: {
+       rules: [
+         {
+           test: require.resolve('jquery'),
+           loader: 'expose-loader',
+           options: {
+             exposes: ['$', 'jQuery']
+           }
+         }
+       ]
+     }
+   };
+   
+   module.exports = merge(webpackConfig, customConfig);
    ```
-
+ 
 1. Copy over custom browserlist config from `.browserslistrc` if it exists into the `"browserslist"` key in `package.json` and remove `.browserslistrc`.
 
 1. Remove `babel.config.js` if you never changed it. Configure your `package.json` to use the default:
-  ```json
-  "babel": {
-    "presets": [
-      "./node_modules/shakapacker/package/babel/preset.js"
-    ]
-  }
-  ```
-  See customization example the [Customizing Babel Config](./docs/customizing_babel_config.md) for React configuration.
+   ```json
+   "babel": {
+     "presets": [
+       "./node_modules/@rails/webpacker/package/babel/preset.js"
+     ]
+   }
+   ```
+   See customization example the [Customizing Babel Config](./docs/customizing_babel_config.md) for React configuration.
 
 1. `extensions` was removed from the `webpacker.yml` file. Move custom extensions to your configuration by merging an object like this. For more details, see docs for [Webpack Configuration](https://github.com/shakacode/shakapacker/blob/master/README.md#webpack-configuration)
 
-    ```js
-    {
-      resolve: {
-        extensions: ['.ts', '.tsx', '.vue', '.css']
-      }
-    }
-    ```
-1. In `webpacker.yml`, check if you had `watched_paths`. That is not `additional_paths`.
+   ```js
+   {
+     resolve: {
+       extensions: ['.ts', '.tsx', '.vue', '.css']
+     }
+   }
+   ```
+1. In `webpacker.yml`, check if you had `watched_paths`. That is now `additional_paths`.
 
 1. Some dependencies were removed in [PR 3056](https://github.com/rails/webpacker/pull/3056). If you see the error: `Error: Cannot find module 'babel-plugin-macros'`, or similar, then you need to `yarn add <dependency>` where <dependency> might include: `babel-plugin-macros`, `case-sensitive-paths-webpack-plugin`, `core-js`, `regenerator-runtime`. Or you might want to remove your dependency on those.
 
 1. Review the new default's changes to `webpacker.yml` and `config/webpack`. Consider each suggested change carefully, especially the change to have your `source_entry_path` be at the top level of your `source_path`.
 
-1. Make sure that you can run `bin/webpacker` without errors.
+1. Make sure that you can run `bin/webpack` without errors.
 
 1. Try running `RAILS_ENV=production bin/rails assets:precompile`. If all goes well, don't forget to clean the generated assets with `bin/rails assets:clobber`.
 
 1. Run `yarn add webpack-dev-server` if those are not already in your dev dependencies. Make sure you're using v4+.
 
-1. Update any scripts that called `/bin/webpack` or `bin/webpack-dev-server` to `/bin/webpacker` or `bin/webpacker-dev-server`
+1. In `bin/webpack` and `bin/webpack-dev-server`, The default NODE_ENV, if not set, will be the RAILS_ENV. Previously, NODE_ENV would default to development if not set. Thus, the old bin stubs would use the webpack config corresponding to `config/webpack/development.js`. After the change, if `RAILS_ENV` is `test`, then `NODE_ENV` is `test`. The final 6.0 release changes to using a single `webpack.config.js`.
+
+1. Now, follow the steps above to get to shakapacker v6 from webpacker v6.0.0.rc.6
 
-1. Try your app!
 
 ## Examples of v5 to v6
 

data/gemfiles/Gemfile-rails.7.0.x

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec path: "../"
+
+gem "rails", '~>7.0.0'
+gem "arel", github: "rails/arel"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/lib/install/config/webpacker.yml

@@ -8,6 +8,9 @@ default: &default
   cache_path: tmp/webpacker
   webpack_compile_output: true
 
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
   # Additional paths webpack should look up modules
   # ['app/assets', 'engine/foo/app/assets']
   additional_paths: []
@@ -15,9 +18,12 @@ default: &default
   # Reload manifest.json on all requests so we reload latest compiled packs
   cache_manifest: false
 
-  # Select loader to use, available options are 'babel' (default) or 'swc'
+  # Select loader to use, available options are 'babel' (default), 'swc' or 'esbuild'
   webpack_loader: 'babel'
 
+  # Set to true to enable check for matching versions of shakapacker gem and NPM package - will raise an error if there is a mismatch or wildcard versioning is used
+  ensure_consistent_versioning: false
+
 development:
   <<: *default
   compile: true
@@ -29,6 +35,14 @@ development:
     port: 3035
     # Hot Module Replacement updates modules while the application is running without a full reload
     hmr: false
+    # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
+    # that you add style-loader to your project dependencies.
+    #
+    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
+    # In that case, style-loader is not needed as a dependency.
+    #
+    # mini-extract-css-plugin is a required dependency in both cases.
+    inline_css: true
     # Defaults to the inverse of hmr. Uncomment to manually set this.
     # live_reload: true
     client:

data/lib/install/template.rb

@@ -58,10 +58,10 @@ results = []
 Dir.chdir(Rails.root) do
   if Webpacker::VERSION.match?(/^[0-9]+\.[0-9]+\.[0-9]+$/)
     say "Installing shakapacker@#{Webpacker::VERSION}"
-    results << run("yarn add shakapacker@#{Webpacker::VERSION}")
+    results << run("yarn add shakapacker@#{Webpacker::VERSION} --exact")
   else
     say "Installing shakapacker@next"
-    results << run("yarn add shakapacker@next")
+    results << run("yarn add shakapacker@next --exact")
   end
 
   package_json = File.read("#{__dir__}/../../package.json")

data/lib/webpacker/commands.rb

@@ -16,7 +16,7 @@ class Webpacker::Commands
   #   age=600.
   #
   def clean(count = 2, age = 3600)
-    if config.public_output_path.exist? && config.public_manifest_path.exist?
+    if config.public_output_path.exist? && config.manifest_path.exist?
       packs
         .map do |paths|
           paths.map { |path| [Time.now - File.mtime(path), path] }
@@ -57,7 +57,7 @@ class Webpacker::Commands
   private
     def packs
       all_files       = Dir.glob("#{config.public_output_path}/**/*")
-      manifest_config = Dir.glob("#{config.public_manifest_path}*")
+      manifest_config = Dir.glob("#{config.manifest_path}*")
 
       packs = all_files - manifest_config - current_version
       packs.reject { |file| File.directory?(file) }.group_by do |path|

data/lib/webpacker/compiler.rb

@@ -47,7 +47,7 @@ class Webpacker::Compiler
     attr_reader :webpacker
 
     def last_compilation_digest
-      compilation_digest_path.read if compilation_digest_path.exist? && config.public_manifest_path.exist?
+      compilation_digest_path.read if compilation_digest_path.exist? && config.manifest_path.exist?
     rescue Errno::ENOENT, Errno::ENOTDIR
     end
 

data/lib/webpacker/configuration.rb

@@ -23,6 +23,10 @@ class Webpacker::Configuration
     fetch(:compile)
   end
 
+  def ensure_consistent_versioning?
+    fetch(:ensure_consistent_versioning)
+  end
+
   def source_path
     root_path.join(fetch(:source_path))
   end
@@ -35,6 +39,14 @@ class Webpacker::Configuration
     source_path.join(fetch(:source_entry_path))
   end
 
+  def manifest_path
+    if data.has_key?(:manifest_path)
+      root_path.join(fetch(:manifest_path))
+    else
+      public_output_path.join("manifest.json")
+    end
+  end
+
   def public_path
     root_path.join(fetch(:public_root_path))
   end
@@ -43,10 +55,6 @@ class Webpacker::Configuration
     public_path.join(fetch(:public_output_path))
   end
 
-  def public_manifest_path
-    public_output_path.join("manifest.json")
-  end
-
   def cache_manifest?
     fetch(:cache_manifest)
   end

data/lib/webpacker/dev_server.rb

@@ -1,9 +1,9 @@
 class Webpacker::DevServer
   DEFAULT_ENV_PREFIX = "WEBPACKER_DEV_SERVER".freeze
 
-  # Configure dev server connection timeout (in seconds), default: 0.01
+  # Configure dev server connection timeout (in seconds), default: 0.1
   # Webpacker.dev_server.connect_timeout = 1
-  cattr_accessor(:connect_timeout) { 0.01 }
+  cattr_accessor(:connect_timeout) { 0.1 }
 
   attr_reader :config
 
@@ -55,6 +55,15 @@ class Webpacker::DevServer
     fetch(:hmr)
   end
 
+  def inline_css?
+    case fetch(:inline_css)
+    when false, "false"
+      false
+    else
+      true
+    end
+  end
+
   def env_prefix
     config.dev_server.fetch(:env_prefix, DEFAULT_ENV_PREFIX)
   end

data/lib/webpacker/helper.rb

@@ -148,13 +148,6 @@ module Webpacker::Helper
   #   <%= stylesheet_pack_tag 'calendar' %>
   #   <%= stylesheet_pack_tag 'map' %>
   def stylesheet_pack_tag(*names, **options)
-    if @stylesheet_pack_tag_loaded
-      raise "To prevent duplicated chunks on the page, you should call stylesheet_pack_tag only once on the page. " \
-      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide"
-    end
-
-    @stylesheet_pack_tag_loaded = true
-
     return "" if Webpacker.inlining_css?
 
     stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)

data/lib/webpacker/instance.rb

@@ -36,6 +36,6 @@ class Webpacker::Instance
   end
 
   def inlining_css?
-    dev_server.hmr? && dev_server.running?
+    dev_server.inline_css? && dev_server.hmr? && dev_server.running?
   end
 end

data/lib/webpacker/manifest.rb

@@ -80,8 +80,8 @@ class Webpacker::Manifest
     end
 
     def load
-      if config.public_manifest_path.exist?
-        JSON.parse config.public_manifest_path.read
+      if config.manifest_path.exist?
+        JSON.parse config.manifest_path.read
       else
         {}
       end
@@ -104,7 +104,7 @@ class Webpacker::Manifest
 
     def missing_file_from_manifest_error(bundle_name)
       <<-MSG
-Webpacker can't find #{bundle_name} in #{config.public_manifest_path}. Possible causes:
+Webpacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
 1. You forgot to install node packages (try `yarn install`) or are running an incompatible version of Node
 2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/webpacker.yml`
 3. You have set compile: false (see `config/webpacker.yml`) for this environment

data/lib/webpacker/railtie.rb

@@ -2,11 +2,18 @@ require "rails/railtie"
 
 require "webpacker/helper"
 require "webpacker/dev_server_proxy"
+require "webpacker/version_checker"
 
 class Webpacker::Engine < ::Rails::Engine
   # Allows Webpacker config values to be set via Rails env config files
   config.webpacker = ActiveSupport::OrderedOptions.new
 
+  initializer "webpacker.version_checker" do
+    if File.exist?(Webpacker::VersionChecker::NodePackageVersion.package_json_path)
+      Webpacker::VersionChecker.build.raise_if_gem_and_node_package_versions_differ
+    end
+  end
+
   initializer "webpacker.proxy" do |app|
     if (Webpacker.config.dev_server.present? rescue nil)
       app.middleware.insert_before 0,

data/lib/webpacker/version.rb

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

data/lib/webpacker/version_checker.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+require "webpacker/version"
+
+module Webpacker
+  class VersionChecker
+    attr_reader :node_package_version
+
+    MAJOR_MINOR_PATCH_VERSION_REGEX = /(\d+)\.(\d+)\.(\d+)/.freeze
+
+    def self.build
+      new(NodePackageVersion.build)
+    end
+
+    def initialize(node_package_version)
+      @node_package_version = node_package_version
+    end
+
+    def raise_if_gem_and_node_package_versions_differ
+      # Skip check if package is not in package.json or listed from relative path, git repo or github URL
+      return if node_package_version.skip_processing?
+
+      node_major_minor_patch = node_package_version.major_minor_patch
+      gem_major_minor_patch = gem_major_minor_patch_version
+      versions_match = node_major_minor_patch[0] == gem_major_minor_patch[0] &&
+                       node_major_minor_patch[1] == gem_major_minor_patch[1] &&
+                       node_major_minor_patch[2] == gem_major_minor_patch[2]
+
+      uses_wildcard = node_package_version.semver_wildcard?
+
+      if !Webpacker.config.ensure_consistent_versioning? && (uses_wildcard || !versions_match)
+        check_failed = if uses_wildcard
+          "Semver wildcard detected"
+        else
+          "Version mismatch detected"
+        end
+
+        warn <<-MSG.strip_heredoc
+          Webpacker::VersionChecker - #{check_failed}
+
+          You are currently not checking for consistent versions of shakapacker gem and npm package. A version mismatch or usage of semantic versioning wildcard (~ or ^) has been detected.
+
+          Version mismatch can lead to incorrect behavior and bugs. You should ensure that both the gem and npm package dependencies are locked to the same version.
+
+          You can enable the version check by setting `ensure_consistent_versioning: true` in your `webpacker.yml` file.
+
+          Checking for gem and npm package versions mismatch or wildcard will be enabled by default in the next major version of shakapacker.
+        MSG
+
+        return
+      end
+
+      raise_differing_versions_warning unless versions_match
+
+      raise_node_semver_version_warning if uses_wildcard
+    end
+
+    private
+
+      def common_error_msg
+        <<-MSG.strip_heredoc
+         Detected: #{node_package_version.raw}
+              gem: #{gem_version}
+         Ensure the installed version of the gem is the same as the version of
+         your installed node package. Do not use >= or ~> in your Gemfile for shakapacker.
+         Do not use ^ or ~ in your package.json for shakapacker.
+         Run `yarn add shakapacker --exact` in the directory containing folder node_modules.
+      MSG
+      end
+
+      def raise_differing_versions_warning
+        msg = "**ERROR** Webpacker: Webpacker gem and node package versions do not match\n#{common_error_msg}"
+        raise msg
+      end
+
+      def raise_node_semver_version_warning
+        msg = "**ERROR** Webpacker: Your node package version for shakapacker contains a "\
+              "^ or ~\n#{common_error_msg}"
+        raise msg
+      end
+
+      def gem_version
+        Webpacker::VERSION
+      end
+
+      def gem_major_minor_patch_version
+        match = gem_version.match(MAJOR_MINOR_PATCH_VERSION_REGEX)
+        [match[1], match[2], match[3]]
+      end
+
+      class NodePackageVersion
+        attr_reader :package_json
+
+        def self.build
+          new(package_json_path)
+        end
+
+        def self.package_json_path
+          Rails.root.join("package.json")
+        end
+
+        def initialize(package_json)
+          @package_json = package_json
+        end
+
+        def raw
+          parsed_package_contents = JSON.parse(package_json_contents)
+          parsed_package_contents.dig("dependencies", "shakapacker").to_s
+        end
+
+        def semver_wildcard?
+          raw.match(/[~^]/).present?
+        end
+
+        def skip_processing?
+          !package_specified? || relative_path? || git_url? || github_url?
+        end
+
+        def major_minor_patch
+          return if skip_processing?
+
+          match = raw.match(MAJOR_MINOR_PATCH_VERSION_REGEX)
+          unless match
+            raise "Cannot parse version number '#{raw}' (wildcard versions are not supported)"
+          end
+
+          [match[1], match[2], match[3]]
+        end
+
+        private
+
+          def package_specified?
+            raw.present?
+          end
+
+          def relative_path?
+            raw.match(%r{(\.\.|\Afile:///)}).present?
+          end
+
+          def git_url?
+            raw.match(%r{^git}).present?
+          end
+
+          def github_url?
+            raw.match(%r{^([\w-]+\/[\w-]+)}).present?
+          end
+
+          def package_json_contents
+            @package_json_contents ||= File.read(package_json)
+          end
+      end
+  end
+end

data/package/__tests__/config.js

@@ -1,6 +1,7 @@
 /* global test expect, describe */
 
 const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
+const { resolve } = require('path')
 
 chdirTestApp()
 
@@ -31,4 +32,14 @@ describe('Config', () => {
       'app/elm'
     ])
   })
+
+  test('should default manifestPath to the public dir', () => {
+    expect(config.manifestPath).toEqual(resolve('public/packs/manifest.json'))
+  })
+
+  test('should allow overriding manifestPath', () => {
+    process.env.WEBPACKER_CONFIG = 'config/webpacker_manifest_path.yml'
+    const config = require('../config')
+    expect(config.manifestPath).toEqual(resolve('app/packs/manifest.json'))
+  })
 })

data/package/config.js

@@ -29,4 +29,10 @@ const getPublicPath = () => {
 config.publicPath = getPublicPath()
 config.publicPathWithoutCDN = `/${config.public_output_path}/`
 
+if (config.manifest_path) {
+  config.manifestPath = resolve(config.manifest_path)
+} else {
+  config.manifestPath = resolve(config.outputPath, 'manifest.json')
+}
+
 module.exports = config