shakapacker 6.6.0 → 7.0.0.rc.0

data/docs/developing_webpacker.md

@@ -1,4 +1,4 @@
-# Developing Webpacker
+# Developing Shakapacker
 
 It's a little trickier for Rails developers to work on the JS code of a project like shakacode/shakapacker. So here are some tips!
 
@@ -7,16 +7,16 @@ For example, for React on Rails Changes, I'm using [shakacode/react_on_rails_tut
 This directory is the `TEST_APP_DIR`.
 
 ## Fork shakacode/shakapacker
-Let's call the shakacode/shakapacker directory `WEBPACKER_DIR` which has shakacode/shakapacker's `package.json`.
+Let's call the shakacode/shakapacker directory `SHAKAPACKER_DIR` which has shakacode/shakapacker's `package.json`.
 
 ## Changing the Package
 ### Setup with Yalc
 Use [`yalc`](https://github.com/wclr/yalc) unless you like yak shaving weird errors.
-1. In `WEBPACKER_DIR`, run `yalc publish`
+1. In `SHAKAPACKER_DIR`, run `yalc publish`
 2. In `TEST_APP_DIR`, run `yalc link shakapacker`
 
 ## Update the Package Code
-1. Make some JS change in WEBPACKER_DIR
+1. Make some JS change in SHAKAPACKER_DIR
 2. Run `yalc push` and your changes will be pushed to your `TEST_APP_DIR`'s node_modules.
 3. You may need to run `yarn` in `TEST_APP_DIR` if you added or removed dependencies of shakacode/shakapacker.
 
@@ -25,5 +25,5 @@ Use [`yalc`](https://github.com/wclr/yalc) unless you like yak shaving weird err
 For the Ruby part, just change the gem reference `TEST_APP_DIR`, like:
 
 ```ruby
-gem "webpacker", path: "../../forks/webpacker"
+gem "shakapacker", path: "../../forks/shakapacker"
 ```

data/docs/react.md

@@ -47,7 +47,7 @@ With HMR enabled, Shakapacker will automatically update only that part of the pa
 
 To enable HMR in a React app, proceed as follows:.
 
-In `config/webpacker.yml` set `hmr` is set to `true`.
+In `config/shakapacker.yml` set `hmr` is set to `true`.
 
 Install the [react-refresh](https://www.npmjs.com/package/react-refresh) package, as well as [@pmmmwh/react-refresh-webpack-plugin](https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin):
 
@@ -58,10 +58,12 @@ yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
 Alter `config/webpack/webpack.config.js` like so:
 
 ```js
-const { webpackConfig, inliningCss } = require('shakapacker');
+const { generateWebpackConfig, inliningCss } = require('shakapacker');
 const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
 const isDevelopment = process.env.NODE_ENV !== 'production';
 
+const webpackConfig = generateWebpackConfig();
+
 if (isDevelopment && inliningCss) {
   webpackConfig.plugins.push(
     new ReactRefreshWebpackPlugin({
@@ -139,7 +141,7 @@ rails new myapp --skip-javascript
 cd myapp
 bundle add shakapacker --strict
 ./bin/bundle install
-./bin/rails webpacker:install
+./bin/rails shakapacker:install
 yarn add react react-dom @babel/preset-react
 yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
 ```
@@ -182,7 +184,7 @@ export default HelloMessage;
 h1 { color: blue; }
 ```
 
-7. Enable HMR in config/webpacker.yml:
+7. Enable HMR in config/shakapacker.yml:
 ```shell
 hmr: true
 ```
@@ -196,10 +198,12 @@ yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
 9. Alter `config/webpack/webpack.config.js` like so:
 
 ```js
-const { webpackConfig, inliningCss } = require('shakapacker');
+const { generateWebpackConfig, inliningCss } = require('shakapacker');
 const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
 const isDevelopment = process.env.NODE_ENV !== 'production';
 
+const webpackConfig = generateWebpackConfig();
+
 if (isDevelopment && inliningCss) {
   webpackConfig.plugins.push(
     new ReactRefreshWebpackPlugin({
@@ -261,7 +265,7 @@ module.exports = function (api) {
 9. Start the Rails server and the webpack-dev-server in separate console windows:
 ```shell
 rails s
-./bin/webpacker-dev-server
+./bin/shakapacker-dev-server
 ```
 
 10. Hit: <http://localhost:3000/site/index>

data/docs/style_loader_vs_mini_css.md

@@ -2,10 +2,10 @@
 
 You have two options for serving CSS in development:
 
-1. You can opt to serve CSS via style-loader (as was traditionally done in a Webpack setup), where CSS is written by Javascript served by Webpacker into a `<style>` tag, or
+1. You can opt to serve CSS via style-loader (as was traditionally done in a Webpack setup), where CSS is written by Javascript served by Shakapacker into a `<style>` tag, or
 2. You can opt to serve CSS as a full CSS file via mini-css-extract-plugin, which uses a standard `<link>` tag to load a fully separate CSS file.
 
-Both options support HMR. The default is style-loader. If you want to use mini-css-extract-plugin in development, set `inline_css: false` in the development dev_server section of your webpacker.yml:
+Both options support HMR. The default is style-loader. If you want to use mini-css-extract-plugin in development, set `inline_css: false` in the development dev_server section of your shakapacker.yml:
 
 ```yml
 development:

data/docs/troubleshooting.md

@@ -5,7 +5,7 @@
 1. Read the error message carefully. The error message will tell you the precise key value
    that is not matching what Webpack expects.
 
-2. Put a `debugger` statement in your Webpack configuration and run `bin/webpacker --debug-webpacker`.
+2. Put a `debugger` statement in your Webpack configuration and run `bin/shakapacker --debug-shakapacker`.
    If you have a node debugger installed, you'll see the Chrome debugger for your webpack
    config. For example, install the Chrome extension
    [NiM](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj) and
@@ -13,9 +13,9 @@
    For more details on debugging, see the official
    [Webpack docs on debugging](https://webpack.js.org/contribute/debugging/#devtools)
 
-3. Any arguments that you add to bin/webpacker get sent to webpack. For example, you can pass `--debug` to switch loaders to debug mode. See [webpack CLI debug options](https://webpack.js.org/api/cli/#debug-options) for more information on the available options.
+3. Any arguments that you add to bin/shakapacker get sent to webpack. For example, you can pass `--debug` to switch loaders to debug mode. See [webpack CLI debug options](https://webpack.js.org/api/cli/#debug-options) for more information on the available options.
 
-4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-webpacker`
+4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-shakapacker`
 
 ## Incorrect peer dependencies
 The latest version of Shakapacker uses peer dependencies to make upgrading easier. However, there's a catch.
@@ -38,12 +38,12 @@ So, be sure to investigate warnings from `yarn install`!
 ## ENOENT: no such file or directory - node-sass
 
 If you get the error `ENOENT: no such file or directory - node-sass` on deploy with
-`assets:precompile` or `bundle exec rails webpacker:compile` you may need to
+`assets:precompile` or `bundle exec rails shakapacker:compile` you may need to
 move Sass to production `dependencies`.
 
 Move any packages that related to Sass (e.g. `node-sass` or `sass-loader`) from
 `devDependencies` to `dependencies` in `package.json`. This is because
-webpacker is running on a production system with the Rails workflow to build
+shakapacker is running on a production system with the Rails workflow to build
 the assets. Particularly on hosting providers that try to detect and do the right
 thing, like Heroku.
 
@@ -64,11 +64,11 @@ In `package.json`:
 
 * If you get this error `Can't find hello_react.js in manifest.json`
 when loading a view in the browser it's because webpack is still compiling packs.
-Webpacker uses a `manifest.json` file to keep track of packs in all environments,
+Shakapacker uses a `manifest.json` file to keep track of packs in all environments,
 however since this file is generated after packs are compiled by webpack. So,
 if you load a view in browser whilst webpack is compiling you will get this error.
 Therefore, make sure webpack
-(i.e `./bin/webpacker-dev-server`) is running and has
+(i.e `./bin/shakapacker-dev-server`) is running and has
 completed the compilation successfully before loading a view.
 
 
@@ -85,7 +85,7 @@ completed the compilation successfully before loading a view.
 
 ## webpack or webpack-dev-server not found
 
-* This could happen if `webpacker:install` step is skipped. Please run `bundle exec rails webpacker:install` to fix the issue.
+* This could happen if `shakapacker:install` step is skipped. Please run `bundle exec rails shakapacker:install` to fix the issue.
 
 * If you encounter the above error on heroku after upgrading from Rails 4.x to 5.1.x, then the problem might be related to missing `yarn` binstub. Please run following commands to update/add binstubs:
 
@@ -97,7 +97,7 @@ bundle config --delete bin
 ## Running webpack on Windows
 
 If you are running webpack on Windows, your command shell may not be able to interpret the preferred interpreter
-for the scripts generated in `bin/webpacker` and `bin/webpacker-dev-server`. Instead you'll want to run the scripts
+for the scripts generated in `bin/shakapacker` and `bin/shakapacker-dev-server`. Instead you'll want to run the scripts
 manually with Ruby:
 
 ```
@@ -107,7 +107,7 @@ C:\path>ruby bin\webpack-dev-server
 
 ## Invalid configuration object. webpack has been initialised using a configuration object that does not match the API schema.
 
-If you receive this error when running `$ ./bin/webpacker-dev-server` ensure your configuration is correct; most likely the path to your "packs" folder is incorrect if you modified from the original "source_path" defined in `config/webpacker.yml`.
+If you receive this error when running `$ ./bin/shakapacker-dev-server` ensure your configuration is correct; most likely the path to your "packs" folder is incorrect if you modified from the original "source_path" defined in `config/shakapacker.yml`.
 
 ## Running Elm on Continuous Integration (CI) services such as CircleCI, CodeShip, Travis CI
 
@@ -132,7 +132,7 @@ chmod +x $HOME/your_rails_app/node_modules/.bin/elm-make
 ```
 
 ## Rake assets:precompile fails. ExecJS::RuntimeError
-This error occurs because you are trying to minify by `terser` a pack that's already been minified by Webpacker. To avoid this conflict and prevent appearing of `ExecJS::RuntimeError` error, you will need to disable uglifier from Rails config:
+This error occurs because you are trying to minify by `terser` a pack that's already been minified by Shakapacker. To avoid this conflict and prevent appearing of `ExecJS::RuntimeError` error, you will need to disable uglifier from Rails config:
 
 ```ruby
 # In production.rb
@@ -150,7 +150,9 @@ To silent these warnings, please update `config/webpack/webpack.config.js`:
 ```js
 const webpack = require('webpack')
 const { resolve } = require('path')
-const { webpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig, merge } = require('shakapacker')
+
+const webpackConfig = generateWebpackConfig();
 
 module.exports = merge(webpackConfig, {
   plugins: [
@@ -164,10 +166,10 @@ module.exports = merge(webpackConfig, {
 
 ### Compilation Fails Silently
 
-If compiling is not producing output files and there are no error messages to help troubleshoot. Setting the `webpack_compile_output` configuration variable to `true` in webpacker.yml may add some helpful error information to your log file (Rails `log/development.log` or `log/production.log`)
+If compiling is not producing output files and there are no error messages to help troubleshoot. Setting the `webpack_compile_output` configuration variable to `true` in shakapacker.yml may add some helpful error information to your log file (Rails `log/development.log` or `log/production.log`)
 
 ```yml
-# webpacker.yml
+# shakapacker.yml
 default: &default
   source_path: app/javascript
   source_entry_path: packs
@@ -188,7 +190,7 @@ Thus ProvidePlugin manages build-time dependencies to global symbols whereas the
 
 For instance, with [jQuery](https://jquery.com/):
 ```diff
-// app/packs/entrypoints/application.js
+// app/javascript/entrypoints/application.js
 
 - import jQuery from 'jquery'
 - window.jQuery = jQuery
@@ -199,7 +201,9 @@ Instead do:
 // config/webpack/webpack.config.js
 
 const webpack = require('webpack')
-const { webpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig, merge } = require('shakapacker')
+
+const webpackConfig = generateWebpackConfig();
 
 module.exports = merge(webpackConfig, {
   plugins: [
@@ -218,11 +222,11 @@ using Heroku's Pipeline promote feature). You might find that your production
 application is using your staging `config.asset_host` host when using
 `javascript_pack_tag`.
 
-This can be fixed by setting the environment variable `WEBPACKER_ASSET_HOST` to
+This can be fixed by setting the environment variable `SHAKAPACKER_ASSET_HOST` to
 an empty string where your assets are compiled. On Heroku this is done under
 *Settings* -> *Config Vars*.
 
-This way webpacker won't hard-code the CDN host into the manifest file used by
+This way shakapacker won't hard-code the CDN host into the manifest file used by
 `javascript_pack_tag`, but instead fetch the CDN host at runtime, resolving the
 issue.
 

data/docs/using_esbuild_loader.md

@@ -27,7 +27,7 @@ To use esbuild as your transpiler today. You need to do two things:
 yarn add esbuild esbuild-loader
 ```
 
-2. Add or change `webpacker_loader` value in your default `webpacker.yml` config to `esbuild`
+2. Add or change `shakapacker_loader` value in your default `shakapacker.yml` config to `esbuild`
 The default configuration of babel is done by using `package.json` to use the file within the `shakapacker` package.
 
 ```yml
@@ -36,7 +36,7 @@ default: &default
   source_entry_path: /
   public_root_path: public
   public_output_path: packs
-  cache_path: tmp/webpacker
+  cache_path: tmp/shakapacker
   webpack_compile_output: true
 
   # Additional paths webpack should look up modules
@@ -59,9 +59,11 @@ o do so, you need to modify your webpack configuration and use `ESBuildMinifyPlu
 Example:
 
 ```js
-const { webpackConfig: baseWebpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig, merge } = require('shakapacker')
 const { ESBuildMinifyPlugin } = require('esbuild-loader')
 
+const baseWebpackConfig = generateWebpackConfig()
+
 const options = {
   optimization: {
     minimizer: [

data/docs/using_swc_loader.md

@@ -22,7 +22,7 @@ In order to use SWC as your compiler today. You need to do two things:
 yarn add @swc/core swc-loader
 ```
 
-2. Add or change `webpack_loader` value in your default `webpacker.yml` config to `swc`
+2. Add or change `webpack_loader` value in your default `shakapacker.yml` config to `swc`
 The default configuration of babel is done by using `package.json` to use the file within the `shakapacker` package.
 
 ```yml
@@ -31,7 +31,7 @@ default: &default
   source_entry_path: /
   public_root_path: public
   public_output_path: packs
-  cache_path: tmp/webpacker
+  cache_path: tmp/shakapacker
   webpack_compile_output: true
 
   # Additional paths webpack should look up modules

data/docs/v6_upgrade.md

@@ -25,8 +25,7 @@ _If you're on webpacker v5, follow [how to upgrade to webpacker v6.0.0.rc.6 from
 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`. You may have old versions of libraries. Run `yarn install` and check for warnings like `warning " > shakapacker@6.1.1" has incorrect peer dependency "compression-webpack-plugin@^9.0.0"` and `file-loader@1.1.11" has incorrect peer dependency "webpack@^2.0.0 || ^3.0.0 || ^4.0.0"`. In other words, warnings like these are **serious** and will cause considerable confusion if not respected.
 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`. 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 the configuration file that corresponds to your `RAILS_ENV`. If your `RAILS_ENV` is `test`, you'd be running `config/webpack/test.js`.
- 
-  ```js
+   ```js
    // name this file config/webpack/webpack.config.js
    const { env, webpackConfig } = require('shakapacker')
    const { existsSync } = require('fs')
@@ -46,6 +45,7 @@ _If you're on webpacker v5, follow [how to upgrade to webpacker v6.0.0.rc.6 from
    module.exports = envSpecificConfig()
    ```
 1. Update `babel.config.js` if you need JSX support. See [Customizing Babel Config](./customizing_babel_config.md)
+1. If you are using the view helper called `asset_pack_path`, change "media/" in path to "static/" or consider using the `image_pack_path`.
 
 ## 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.

data/docs/v7_upgrade.md

@@ -0,0 +1,56 @@
+# 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.
+
+## 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.
+
+### 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. 
+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`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.
+
+
+## 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`.
+
+### Example Upgrade
+If you started with:
+
+```js
+const { webpackConfig } = require('shakapacker')
+```
+
+Swtich to:
+
+```js
+const { generateWebpackConfig } = require('shakapacker')
+const webpackConfig = generateWebpackConfig()
+```
+
+or use `globalMutableWebpackConfig` if the project desires to use a globally mutable object.
+
+```js
+const { globalMutableWebpackConfig: webpackConfig } = require('shakapacker')
+```

data/lib/install/bin/shakapacker

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= "development"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "bundler/setup"
+require "shakapacker"
+require "shakapacker/webpack_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Shakapacker::WebpackRunner.run(ARGV)
+end

data/lib/install/bin/shakapacker-dev-server

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= "development"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "bundler/setup"
+require "shakapacker"
+require "shakapacker/dev_server_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Shakapacker::DevServerRunner.run(ARGV)
+end

data/lib/install/config/{webpacker.yml → shakapacker.yml}

@@ -1,15 +1,16 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   source_path: app/javascript
 
   # You can have a subdirectory of the source_path, like 'packs' (recommended).
   # Alternatively, you can use '/' to use the whole source_path directory.
-  source_entry_path: /
+  # Notice that this is a relative path to source_path
+  source_entry_path: packs
 
   # If nested_entries is true, then we'll pick up subdirectories within the source_entry_path.
   # You cannot set this option to true if you set source_entry_path to '/'
-  nested_entries: false
+  nested_entries: true
 
   #  While using a File-System-based automated bundle generation feature, miscellaneous warnings suggesting css order
   #  conflicts may arise due to the mini-css-extract-plugin. For projects where css ordering has been mitigated through
@@ -19,10 +20,10 @@ default: &default
 
   public_root_path: public
   public_output_path: packs
-  cache_path: tmp/webpacker
+  cache_path: tmp/shakapacker
   webpack_compile_output: true
   # See https://github.com/shakacode/shakapacker#deployment
-  webpacker_precompile: true
+  shakapacker_precompile: true
 
   # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
   # manifest_path: public/packs/manifest.json
@@ -51,7 +52,11 @@ development:
   # Reference: https://webpack.js.org/configuration/dev-server/
   # Keys not described there are documented inline and in https://github.com/shakacode/shakapacker/
   dev_server:
-    https: false
+    # For running dev server with https, set `server: https`.
+    # You may use `https: true` instead but notice that it is deprecated in favor of `server: https`
+    # Ensure only one of these entries is set.
+    # server: https
+
     host: localhost
     port: 3035
     # Hot Module Replacement updates modules while the application is running without a full reload
@@ -78,8 +83,8 @@ development:
     # Should we use gzip compression?
     compress: true
     # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
-    allowed_hosts: 'all'
-    # Shows progress and colorizes output of bin/webpacker[-dev-server]
+    allowed_hosts: 'auto'
+    # Shows progress and colorizes output of bin/shakapacker[-dev-server]
     pretty: true
     headers:
       'Access-Control-Allow-Origin': '*'

data/lib/install/template.rb

@@ -1,11 +1,11 @@
-# Install Webpacker
-copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
+# Install Shakapacker
+copy_file "#{__dir__}/config/shakapacker.yml", "config/shakapacker.yml"
 copy_file "#{__dir__}/package.json", "package.json"
 
 say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack"
 
-if Dir.exist?(Webpacker.config.source_path)
+if Dir.exist?(Shakapacker.config.source_path)
   say "The packs app source directory already exists"
 else
   say "Creating packs app source directory"
@@ -68,9 +68,9 @@ end
 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} --exact")
+  if Shakapacker::VERSION.match?(/^[0-9]+\.[0-9]+\.[0-9]+$/)
+    say "Installing shakapacker@#{Shakapacker::VERSION}"
+    results << run("yarn add shakapacker@#{Shakapacker::VERSION} --exact")
   else
     say "Installing shakapacker@next"
     results << run("yarn add shakapacker@next --exact")
@@ -91,6 +91,6 @@ Dir.chdir(Rails.root) do
 end
 
 unless results.all?
-  say "Webpacker installation failed 😭 See above for details.", :red
+  say "Shakapacker installation failed 😭 See above for details.", :red
   exit 1
 end

data/lib/{webpacker → shakapacker}/base_strategy.rb

@@ -1,7 +1,7 @@
-module Webpacker
+module Shakapacker
   class BaseStrategy
     def initialize
-      @config = Webpacker.config
+      @config = Shakapacker.config
     end
 
     def after_compile_hook

data/lib/{webpacker → shakapacker}/commands.rb

@@ -1,8 +1,8 @@
-class Webpacker::Commands
-  delegate :config, :compiler, :manifest, :logger, to: :@webpacker
+class Shakapacker::Commands
+  delegate :config, :compiler, :manifest, :logger, to: :@instance
 
-  def initialize(webpacker)
-    @webpacker = webpacker
+  def initialize(instance)
+    @instance = instance
   end
 
   # Cleanup old assets in the compile directory. By default it will

data/lib/{webpacker → shakapacker}/compiler.rb

@@ -1,16 +1,17 @@
 require "open3"
-require "webpacker/compiler_strategy"
+require "shakapacker/compiler_strategy"
+require "fileutils"
 
-class Webpacker::Compiler
+class Shakapacker::Compiler
   # Additional environment variables that the compiler is being run with
-  # Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
+  # Shakapacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
   cattr_accessor(:env) { {} }
 
-  delegate :config, :logger, :strategy, to: :webpacker
+  delegate :config, :logger, :strategy, to: :instance
   delegate :fresh?, :stale?, :after_compile_hook, to: :strategy
 
-  def initialize(webpacker)
-    @webpacker = webpacker
+  def initialize(instance)
+    @instance = instance
   end
 
   def compile
@@ -32,7 +33,7 @@ class Webpacker::Compiler
   end
 
   private
-    attr_reader :webpacker
+    attr_reader :instance
 
     def acquire_ipc_lock
       open_lock_file do |lf|
@@ -55,15 +56,24 @@ class Webpacker::Compiler
     end
 
     def open_lock_file
-      lock_file_name = File.join(Dir.tmpdir, "shakapacker.lock")
-      File.open(lock_file_name, File::CREAT) do |lf|
+      create_lock_file_dir unless File.exist?(lock_file_path)
+
+      File.open(lock_file_path, File::CREAT) do |lf|
         return yield lf
       end
     end
 
+    def create_lock_file_dir
+      dirname = File.dirname(lock_file_path)
+      FileUtils.mkdir_p(dirname)
+    end
+
+    def lock_file_path
+      config.root_path.join("tmp/shakapacker.lock")
+    end
+
     def optionalRubyRunner
-      bin_webpack_path = config.root_path.join("bin/webpacker")
-      first_line = File.readlines(bin_webpack_path).first.chomp
+      first_line = File.readlines(bin_shakapacker_path).first.chomp
       /ruby/.match?(first_line) ? RbConfig.ruby : ""
     end
 
@@ -72,7 +82,7 @@ class Webpacker::Compiler
 
       stdout, stderr, status = Open3.capture3(
         webpack_env,
-        "#{optionalRubyRunner} ./bin/webpacker",
+        "#{optionalRubyRunner} #{bin_shakapacker_path}",
         chdir: File.expand_path(config.root_path)
       )
 
@@ -94,8 +104,26 @@ class Webpacker::Compiler
     def webpack_env
       return env unless defined?(ActionController::Base)
 
-      env.merge("WEBPACKER_ASSET_HOST"        => ENV.fetch("WEBPACKER_ASSET_HOST", ActionController::Base.helpers.compute_asset_host),
-                "WEBPACKER_RELATIVE_URL_ROOT" => ENV.fetch("WEBPACKER_RELATIVE_URL_ROOT", ActionController::Base.relative_url_root),
-                "WEBPACKER_CONFIG" => webpacker.config_path.to_s)
+      Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
+
+      env.merge("SHAKAPACKER_ASSET_HOST"        => ENV.fetch("SHAKAPACKER_ASSET_HOST", ActionController::Base.helpers.compute_asset_host),
+                "SHAKAPACKER_RELATIVE_URL_ROOT" => ENV.fetch("SHAKAPACKER_RELATIVE_URL_ROOT", ActionController::Base.relative_url_root),
+                "SHAKAPACKER_CONFIG" => instance.config_path.to_s)
+    end
+
+    def bin_shakapacker_path
+      if File.exist?(config.root_path.join("bin/shakapacker"))
+        config.root_path.join("bin/shakapacker")
+      elsif File.exist?(config.root_path.join("bin/webpacker"))
+        Shakapacker.puts_deprecation_message(
+          Shakapacker.short_deprecation_message(
+            "bin/webpacker",
+            "bin/shakapacker"
+          )
+        )
+        config.root_path.join("bin/webpacker")
+      else
+        config.root_path.join("bin/shakapacker")
+      end
     end
 end

data/lib/{webpacker → shakapacker}/compiler_strategy.rb

@@ -1,16 +1,16 @@
-require "webpacker/mtime_strategy"
-require "webpacker/digest_strategy"
+require "shakapacker/mtime_strategy"
+require "shakapacker/digest_strategy"
 
-module Webpacker
+module Shakapacker
   class CompilerStrategy
     def self.from_config
-      strategy_from_config = Webpacker.config.compiler_strategy
+      strategy_from_config = Shakapacker.config.compiler_strategy
 
       case strategy_from_config
       when "mtime"
-        Webpacker::MtimeStrategy.new
+        Shakapacker::MtimeStrategy.new
       when "digest"
-        Webpacker::DigestStrategy.new
+        Shakapacker::DigestStrategy.new
       else
         raise "Unknown strategy '#{strategy_from_config}'. " \
               "Available options are 'mtime' and 'digest'."