react_on_rails 11.0.5 → 13.4.0

data/docs/guides/configuration.md

@@ -0,0 +1,289 @@
+Here is the full set of config options. This file is `/config/initializers/react_on_rails.rb`
+
+First, you should have a `/config/shakapacker.yml` setup.
+
+Here is the setup when using the recommended `/client` directory for your `node_modules` and source files:
+
+```yaml
+# Note: Base output directory of /public is assumed for static files
+default: &default
+  compile: false
+  # Used in your webpack configuration. Must be created in the
+  # public_output_path folder
+  manifest: manifest.json
+  cache_manifest: false
+
+  # Source path is used to check if webpack compilation needs to be run for `compile: true`
+  source_path: client/app
+
+development:
+  <<: *default
+  # Generated files for development, in /public/webpack/dev
+  public_output_path: webpack/dev
+
+test:
+  <<: *default
+  # Ensure that shakapacker invokes webpack to build files for tests if not using the
+  #   ReactOnRails rspec helper.
+  compile: true
+
+  # Generated files for tests, in /public/webpack/test
+  public_output_path: webpack/test
+
+production:
+  <<: *default
+  # Generated files for production, in /public/webpack/production
+  public_output_path: webpack/production
+  cache_manifest: true
+```
+
+Here's a representative `/config/initializers/react_on_rails.rb` setup when using this `/client` directory
+for all client files, including your sources and node_modules.
+
+
+```ruby
+# frozen_string_literal: true
+
+# NOTE: you typically will leave the commented out configurations set to their defaults.
+# Thus, you only need to pay careful attention to the non-commented settings in this file.
+ReactOnRails.configure do |config|
+  # You can optionally add values to your rails_context. This object is passed
+  # every time a component renders.
+  # See below for an example definition of RenderingExtension
+  config.rendering_extension = RenderingExtension
+  
+  # `trace`: General debugging flag.
+  # The default is true for development, off otherwise.
+  # With true, you get detailed logs of rendering and stack traces if you call setTimout,
+  # setInterval, clearTimout when server rendering.
+  config.trace = Rails.env.development? # default
+
+  # Configure if default DOM IDs have a random value or are fixed.
+  # false ==> Sets the dom id to "#{react_component_name}-react-component"
+  # true ==> Adds "-#{SecureRandom.uuid}" to that ID
+  # If you might use multiple instances of the same React component on a Rails page, then
+  # it is convenient to set this to true or else you have to either manually set the ids to
+  # avoid collisions. Most newer apps will have only one instance of a component on a page,
+  # so this should be false in most cases.
+  # This value can be overridden for a given call to react_component
+  config.random_dom_id = true # default
+
+  # defaults to "" (top level)
+  config.node_modules_location = "client" # If using Shakapacker you should use "".
+
+  # If you're using the standard Shakapacker configuration of webpack, then Shakapacker
+  # will automatically modify or create an assets:precompile task to build your assets. If so,
+  # set this value to nil.  Alternatively, you can specify `config.build_production_command`
+  # to have react_on_rails invoke a command for you during assets:precompile.
+  # The command is either a script or a module containing a class method `call`
+  # In this example, the module BuildProductionCommand would have a class method `call`.
+  config.build_production_command = "RAILS_ENV=production bin/shakapacker"
+
+  # NOTE:
+  # When specifying `build_production_command`, you need to disable `rails/shakapacker` 
+  # configuration by setting `shakapacker_precompile: false` in your `config/shakapacker.yml` file.
+
+  # See bottom for an example of the BuildProductionCommand module.
+  # config.build_production_command = BuildProductionCommand
+  # If you wish to utilize ReactOnRailsPro production bundle caching logic, then use
+  # config.build_production_command = ReactOnRailsPro::AssetsPrecompile
+  # and be sure to check ReactOnRailsPro's configuration documentation!
+
+  ################################################################################
+  ################################################################################
+  # SERVER RENDERING OPTIONS
+  ################################################################################
+  # This is the file used for server rendering of React when using `(prerender: true)`
+  # If you are not using server rendering, you should set this to `nil`.
+  # Note, there is only one server bundle, unlike JavaScript where you want to minimize the size
+  # of the JS sent to the client. For the server rendering, React on Rails creates a pool of
+  # JavaScript execution instances which should handle any component requested.
+  #
+  # While you may configure this to be the same as your client bundle file, this file is typically
+  # different. Note, be sure to include the exact file name with the ".js" if you are not hashing this file.
+  # If you are hashing this file (supposing you are using the same file for client rendering), then
+  # you should include a name that matches your bundle name in your webpack config.
+  config.server_bundle_js_file = "server-bundle.js"
+  
+  # `prerender` means server-side rendering
+  # default is false. This is an option for view helpers `render_component` and `render_component_hash`.
+  # Set to true to change the default value to true. 
+  config.prerender = false
+
+  # THE BELOW OPTIONS FOR SERVER-SIDE RENDERING RARELY NEED CHANGING
+  #
+  # This value only affects server-side rendering when using the webpack-dev-server
+  # If you are hashing the server bundle and you want to use the same bundle for client and server,
+  # you'd set this to `true` so that React on Rails reads the server bundle from the webpack-dev-server.
+  # Normally, you have different bundles for client and server, thus, the default is false.
+  # Furthermore, if you are not hashing the server bundle (not in the manifest.json), then React on Rails
+  # will only look for the server bundle to be created in the typical file location, typically by
+  # a `shakapacker --watch` process.
+  # If true, ensure that in config/shakapacker.yml that you have both dev_server.hmr and
+  # dev_server.inline set to false.
+  config.same_bundle_for_client_and_server = false
+
+  # If set to true, this forces Rails to reload the server bundle if it is modified
+  # Default value is Rails.env.development?
+  # You probably will never change this.
+  config.development_mode = Rails.env.development?
+
+  # For server rendering so that the server-side console replays in the browser console.
+  # This can be set to false so that server side messages are not displayed in the browser.
+  # Default is true. Be cautious about turning this off, as it can make debugging difficult.
+  # Default value is true
+  config.replay_console = true
+
+  # Default is true. Logs server rendering messages to Rails.logger.info. If false, you'll only
+  # see the server rendering messages in the browser console.
+  config.logging_on_server = true
+
+  # Default is true only for development? to raise exception on server if the JS code throws for
+  # server rendering. The reason is that the server logs will show the error and force you to fix
+  # any server rendering issues immediately during development.
+  config.raise_on_prerender_error = Rails.env.development?
+
+  # This configuration allows logic to be applied to client rendered props, such as stripping props that are only used during server rendering.
+  # Add a module with an adjust_props_for_client_side_hydration method that expects the component's name & props hash
+  # See below for an example definition of RenderingPropsExtension
+  config.rendering_props_extension = RenderingPropsExtension
+
+  ################################################################################
+  # Server Renderer Configuration for ExecJS
+  ################################################################################
+  # The default server rendering is ExecJS, by default using Node.js runtime
+  # If you wish to use an alternative Node server rendering for higher performance,
+  # contact justin@shakacode.com for details.
+  #
+  # For ExecJS:
+  # You can configure your pool of JS virtual machines and specify where it should load code:
+  # On MRI, use `node.js` runtime for the best performance
+  # (see https://github.com/shakacode/react_on_rails/issues/1438)
+  # Also see https://github.com/shakacode/react_on_rails/issues/1457#issuecomment-1165026717 if using `mini_racer`
+  # On MRI, you'll get a deadlock with `pool_size` > 1
+  # If you're using JRuby, you can increase `pool_size` to have real multi-threaded rendering.
+  config.server_renderer_pool_size = 1 # increase if you're on JRuby
+  config.server_renderer_timeout = 20 # seconds
+
+  ################################################################################
+  ################################################################################
+  # FILE SYSTEM BASED COMPONENT REGISTRY
+  # `render_component` and `render_component_hash` view helper methods can
+  # auto-load the bundle for the generated component, to avoid having to specify the
+  # bundle manually for each view with the component.
+  ################################################################################
+  # components_subdirectory is the name of the subdirectory matched to detect and register components automatically
+  # The default is nil. You can enable the feature by updating it in the next line.
+  config.components_subdirectory = nil
+  # Change to a value like this example to enable this feature 
+  # config.components_subdirectory = "ror_components"
+
+  # Default is false.
+  # The default can be overidden as an option in calls to view helpers
+  # `render_component` and `render_component_hash`. You may set to true to change the default to auto loading.
+  config.auto_load_bundle = false
+
+  # Default is false
+  # Set this to true & instead of trying to import the generated server components into your existing
+  # server bundle entrypoint, the PacksGenerator will create a server bundle entrypoint using
+  # config.server_bundle_js_file for the filename.
+  config.make_generated_server_bundle_the_entrypoint = false
+
+  # Default is true, which matches Webpacker/Shakapacker's defer default for `append_javascript_pack`
+  # Set this to false to have `defer: false` added to your `append_javascript_pack` calls for generated entrypoints.
+  config.defer_generated_component_packs = true
+
+  ################################################################################
+  # I18N OPTIONS
+  ################################################################################
+  # Replace the following line to the location where you keep translation.js & default.js for use
+  # by the npm packages react-intl. Be sure this directory exists!
+  # config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")
+  #
+  # If not using the i18n feature, then leave this section commented out or set the value
+  # of config.i18n_dir to nil.
+  #
+  # Replace the following line to the location where you keep your client i18n yml files
+  # that will source for automatic generation on translations.js & default.js
+  # By default(without this option) all yaml files from Rails.root.join("config", "locales")
+  # and installed gems are loaded
+  config.i18n_yml_dir = Rails.root.join("config", "locales")
+
+  # Possible output formats are js and json
+  # The default format is json
+  config.i18n_output_format = 'json'
+
+  ################################################################################
+  ################################################################################
+  # TEST CONFIGURATION OPTIONS
+  # Below options are used with the use of this test helper:
+  # ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
+  #
+  # NOTE:
+  # Instead of using this test helper, you may ensure fresh test files using Shakapacker via:
+  # 1. Have `config/webpack/test.js` exporting an array of objects to configure both client and server bundles.
+  # 2. Set the compile option to true in config/shakapacker.yml for env test
+  ################################################################################
+
+  # If you are using this in your spec_helper.rb (or rails_helper.rb):
+  #
+  # ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
+  #
+  # with rspec then this controls what yarn command is run
+  # to automatically refresh your webpack assets on every test run.
+  #
+  config.build_test_command = "RAILS_ENV=test bin/shakapacker"
+
+  # CONFIGURE YOUR SOURCE FILES
+  # The test helper needs to know where your JavaScript files exist. The value is configured
+  # by your config/shakapacker.yml source_path:
+  # source_path: client/app # if using recommended /client directory
+  #
+  # Define the files we need to check for webpack compilation when running tests.
+  # The default is `%w( manifest.json )` as will be sufficient for most shakapacker builds.
+  # However, if you are generating a server bundle that is NOT hashed (present in manifest.json),
+  # then include the file in this list like this:
+  config.webpack_generated_files = %w( server-bundle.js manifest.json )
+  # Note, be sure NOT to include your server-bundle.js if it is hashed, or else React on Rails will
+  # think the server-bundle.js is missing every time for test runs.
+end
+```
+
+Example of a ReactOnRailsConfig module for `client_props_extension`:
+
+```ruby
+module RenderingPropsExtension
+  # The modify_props method will be called by ReactOnRails::ReactComponent::RenderOptions if config.client_props_extension is defined
+  def self.adjust_props_for_client_side_hydration(component_name, props)
+    component_name == 'HelloWorld' ? props.except(:server_side_only) : props
+  end
+end
+```
+
+Example of a ReactOnRailsConfig module for `production_build_command`:
+
+```ruby
+module BuildProductionCommand
+  include FileUtils
+  # The call method will be called during assets:precompile
+  def self.call
+    sh "bin/shakapacker"
+  end
+end
+```
+
+Example of a RenderingExtension for custom values in the `rails_context`:
+
+```ruby
+module RenderingExtension
+
+  # Return a Hash that contains custom values from the view context that will get merged with
+  # the standard rails_context values and passed to all calls to Render-Functions used by the
+  # react_component and redux_store view helpers
+  def self.custom_context(view_context)
+    {
+     somethingUseful: view_context.session[:something_useful]
+    }
+  end
+end
+```

data/docs/guides/deployment.md

@@ -0,0 +1,5 @@
+# Deployment
+
+Shakapacker puts the necessary precompile steps automatically in the rake precompile step.
+
+See the [Heroku Deployment](https://www.shakacode.com/react-on-rails/docs/deployment/heroku-deployment/) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.

data/docs/guides/file-system-based-automated-bundle-generation.md

@@ -0,0 +1,197 @@
+# File-System-Based Automated Bundle Generation
+
+To use the automated bundle generation feature introduced in React on Rails v13.1.0, please upgrade to use [Shakapacker v6.5.1](https://github.com/shakacode/shakapacker/tree/v6.5.1) at least. If you are currently using Webpacker, please follow the migration steps available [v6 upgrade](https://github.com/shakacode/shakapacker/blob/master/docs/v6_upgrade.md). Then upgrade to Shakapacker 7 using [v7 upgrade](https://github.com/shakacode/shakapacker/blob/master/docs/v7_upgrade.md) guide.
+
+## Configuration
+
+### Enable nested_entries for Shakapacker
+To use the automated bundle generation feature, set `nested_entries: true` in the `shakapacker.yml` file like this.
+The generated files will go in a nested directory.
+
+```yml
+default:
+  ...
+  nested_entries: true
+```
+
+For more details, see [Configuration and Code](https://github.com/shakacode/shakapacker#configuration-and-code) section in [shakapacker](https://github.com/shakacode/shakapacker/).
+
+### Configure Components Subdirectory
+`components_subdirectory`  is the name of the matched directories containing components that will be automatically registered for use by the view helpers.
+For example, configure `config/initializers/react_on_rails` to set the name for `components_subdirectory`.·
+
+```rb
+config.components_subdirectory = "ror_components"
+```
+
+Now all React components inside the directories called `ror_components` will automatically be registered for usage with [`react_component`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component) and [`react_component_hash`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component_hash) helper methods provided by React on Rails.
+
+### Configure `auto_load_bundle` Option
+
+For automated component registry, [`react_component`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component) and [`react_component_hash`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component_hash) view helper method tries to load generated bundle for component from the generated directory automatically per `auto_load_bundle` option. `auto_load_bundle` option in `config/initializers/react_on_rails` configures the default value that will be passed to component helpers. The default is `false`, and the parameter can be passed explicitly for each call.
+
+You can change the value in `config/initializers/react_on_rails` by updating it as follows:
+
+```rb
+config.auto_load_bundle = true
+```
+
+### Update `.gitignore` file
+React on Rails automatically generates pack files for components to be registered in the `packs/generated` directory. To avoid committing generated files into the version control system, please update `.gitignore` to have
+
+```gitignore
+# Generated React on Rails packs
+app/javascript/packs/generated
+```
+
+*Note: the directory might be different depending on the `source_entry_path` in `config/shakapacker.yml`.*
+
+## Usage
+
+### Basic usage
+
+#### Background
+If the `shakapacker.yml` file is configured as instructed [here](https://github.com/shakacode/shakapacker#configuration-and-code), with the following configurations
+
+```yml
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  nested_entries: true
+# And more
+```
+
+the directory structure will look like this
+
+```
+app/javascript:
+  └── packs:               # sets up webpack entries
+  │   └── application.js   # references FooComponentOne.jsx, BarComponentOne.jsx and BarComponentTwo.jsx in `../src`
+  └── src:                 # any directory name is fine. Referenced files need to be under source_path
+  │   └── Foo
+  │   │   └── ...
+  │   │   └── FooComponentOne.jsx
+  │   └── Bar
+  │   │   └── ...
+  │   │   └── BarComponentOne.jsx
+  │   │   └── BarComponentTwo.jsx
+  └── stylesheets:
+  │   └── my_styles.css
+  └── images:
+      └── logo.svg
+```
+
+Previously, many applications would use one pack (webpack entrypoint) for many components. In this example, the`application.js` file manually registers server components, `FooComponentOne`, `BarComponentOne` and `BarComponentTwo`.
+
+```jsx
+import ReactOnRails from 'react-on-rails';
+import FooComponentOne from '../src/Foo/FooComponentOne';
+import BarComponentOne from '../src/Foo/BarComponentOne';
+import BarComponentTwo from '../src/Foo/BarComponentTwo';
+
+ReactOnRails.register({ FooComponentOne, BarComponentOne, BarComponentTwo });
+```
+
+Your layout would contain:
+
+```erb
+  <%= javascript_pack_tag 'application' %>
+  <%= stylesheet_pack_tag 'application' %>
+```
+
+Now suppose you want to use bundle splitting to minimize unnecessary javascript loaded on each page, you would put each of your components in the `packs` directory.
+
+```
+app/javascript:
+  └── packs:                   # sets up webpack entries
+  │   └── FooComponentOne.jsx  # Internally uses ReactOnRails.register
+  │   └── BarComponentOne.jsx  # Internally uses ReactOnRails.register
+  │   └── BarComponentTwo.jsx  # Internally uses ReactOnRails.register
+  └── src:                     # any directory name is fine. Referenced files need to be under source_path
+  │   └── Foo
+  │   │   └── ...
+  │   └── Bar
+  │   │   └── ...
+  └── stylesheets:
+  │   └── my_styles.css
+  └── images:
+      └── logo.svg
+```
+
+The tricky part is to figure out which bundles to load on any Rails view. [Shakapacker's `append_stylesheet_pack_tag` and `append_javascript_pack_tag` view helpers](https://github.com/shakacode/shakapacker#view-helper-append_javascript_pack_tag-and-append_stylesheet_pack_tag) enables Rails views to specify needed bundles for use by layout's call to `javascript_pack_tag` and `stylesheet_pack_tag`.
+
+#### Solution
+
+File-system-based automated pack generation simplifies this process with a new option for the view helpers.
+
+For example, if you wanted to utilize our file-system based entrypoint generation for `FooComponentOne` & `BarComponentOne`, but not `BarComponentTwo` (for whatever reason), then...
+
+1. Remove generated entrypoints from parameters passed directly to `javascript_pack_tag` and `stylesheet_pack_tag`.
+2. Remove generated entrypoints from parameters passed directly to `append_javascript_pack_tag` and `append_stylesheet_pack_tag`.
+
+    Your layout would now contain:
+
+    ```erb
+    <%= javascript_pack_tag('BarComponentTwo') %>
+    <%= stylesheet_pack_tag('BarComponentTwo') %>
+    ```
+
+3. Create a directory structure where the components that you want to be auto-generated are within `ReactOnRails.configuration.components_subdirectory`, which should be a subdirectory of `Shakapacker.config.source_path`:
+
+    ```
+    app/javascript:
+      └── packs:
+      │   └── BarComponentTwo.jsx  # Internally uses ReactOnRails.register
+      └── src:
+      │   └── Foo
+      │   │ └── ...
+      │   │ └── ror_components          # configured as `components_subdirectory`
+      │   │   └── FooComponentOne.jsx
+      │   └── Bar
+      │   │ └── ...
+      │   │ └── ror_components          # configured as `components_subdirectory`
+      │   │   │ └── BarComponentOne.jsx
+      │   │ └── something_else
+      │   │   │ └── BarComponentTwo.jsx
+    ```
+
+4. You no longer need to register the React components within the `ReactOnRails.configuration.components_subdirectory` nor directly add their bundles. For example you can have a Rails view using three components:
+
+    ```erb
+    <% append_javascript_pack('BarComponentTwo') %>
+    <%= react_component("FooComponentOne", {}, auto_load_bundle: true) %>
+    <%= react_component("BarComponentOne", {}, auto_load_bundle: true) %>
+    <%= react_component("BarComponentTwo", {}) %>
+    ```
+
+    If a component uses multiple HTML strings for server rendering, the [`react_component_hash`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component_hash) view helper can be used on the Rails view, as illustrated below.
+
+    ```erb
+    <% foo_component_one_data = react_component_hash("FooComponentOne",
+                                                prerender: true,
+                                                auto_load_bundle: true
+                                                props: {}
+                                              ) %>
+    <% content_for :title do %>
+      <%= foo_component_one_data['title'] %>
+    <% end %>
+    <%= foo_component_one_data["componentHtml"] %>
+    ```
+
+    The default value of the `auto_load_bundle` parameter can be specified by setting `config.auto_load_bundle` in `config/initializers/react_on_rails.rb` and thus removed from each call to `react_component`.
+
+### Server Rendering and Client Rendering Components
+
+If server rendering is enabled, the component will be registered for usage both in server and client rendering. In order to have separate definitions for client and server rendering, name the component files as `ComponentName.server.jsx` and `ComponentName.client.jsx`. The `ComponentName.server.jsx` file will be used for server rendering and the `ComponentName.client.jsx` file for client rendering. If you don't want the component rendered on the server, you should only have the `ComponentName.client.jsx` file.
+
+Once generated, all server entrypoints will be imported into a file named `[ReactOnRails.configuration.server_bundle_js_file]-generated.js`, which in turn will be imported into a source file named the same as `ReactOnRails.configuration.server_bundle_js_file`. If your server bundling logic is such that your server bundle source entrypoint is not named the same as your `ReactOnRails.configuration.server_bundle_js_file` & changing it would be difficult, please let us know.
+
+*Note: If specifying separate definitions for client and server rendering, please make sure to delete the generalized `ComponentName.jsx` file.*
+
+### Using Automated Bundle Generation Feature with already defined packs
+
+As of version 13.3.4, bundles inside of directories that match `config.components_subdirectory` will be automatically added as entrypoints, while bundles outside of those directories will have to be manually added to the Shakapacker.config.source_entry_path or Webpack's `entry` rules.
+
+

data/docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md

@@ -0,0 +1,104 @@
+# HMR and Hot Reloading with the webpack-dev-server
+
+The `webpack-dev-server` provides:
+
+1. Speedy compilation of client side assets
+2. Optional HMR which means that the page will reload automatically when after
+   compilation completes. Note, some developers do not like this, as you'll
+   abruptly lose any tweaks within the Chrome development tools.
+3. Optional hot-reloading. The older react-hot-loader has been deprecated in 
+   favor of [fast-refresh](https://reactnative.dev/docs/fast-refresh).
+   For use with webpack, see **Client Side rendering and HMR using react-refresh-webpack-plugin** section bellow or visit [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin) for additional details.
+
+If you are ***not*** using server-side rendering (***not*** using `prerender: true`),
+then you can follow all the regular docs for using the `bin/shakapacker-dev-server` 
+during development.
+
+# Server Side Rendering with the Default shakacode/shakapacker bin/shakapacker-dev-server
+
+If you are using server-side rendering, then you have a couple options. The
+recommended technique is to have a different webpack configuration for server
+rendering.  
+
+## If you use the same Webpack setup for your server and client bundles 
+If you do use the `webpack-dev-server` for prerendering, be sure to set the
+`config/initializers/react_on_rails.rb` setting of 
+
+```
+  config.same_bundle_for_client_and_server = true
+```
+
+`dev_server.hmr` maps to [devServer.hot](https://webpack.js.org/configuration/dev-server/#devserverhot).
+This must be false if you're using the webpack-dev-server for client and server bundles.
+ 
+`dev_server.inline` maps to [devServer.inline](https://webpack.js.org/configuration/dev-server/#devserverinline).
+This must also be false.
+
+If you don't configure these two to false, you'll see errors like:
+
+* `"ReferenceError: window is not defined" (if hmr is true)`
+* `"TypeError: Cannot read property 'prototype' of undefined" (if inline is true)`
+
+# Client Side rendering with HMR using react-refresh-webpack-plugin
+## Basic installation
+To enable HMR functionality you have to use `./bin/shakapacker-dev-server`
+1. In `config/shakapacker.yml` set **hmr** and **inline** `dev_server` properties to true. 
+    ```
+    dev_server:
+      https: false
+      host: localhost
+      port: 3035
+      public: localhost:3035
+      hmr: true
+      # Inline should be set to true if using HMR
+      inline: true
+    ```
+
+2. Add react refresh packages:
+    ` yarn add @pmmmwh/react-refresh-webpack-plugin react-refresh -D`
+
+3. HMR is for use with the `webpack-dev-server`, so we only add this for the `webpack-dev-server`.
+   ```
+   const { devServer } = require('shakapacker')
+
+   const isWebpackDevServer = process.env.WEBPACK_DEV_SERVER
+
+   //plugins
+   if (isWebpackDevServer) {
+     environment.plugins.append(
+       'ReactRefreshWebpackPlugin',
+       new ReactRefreshWebpackPlugin({
+         overlay: {
+           sockPort: devServer.port
+         }
+       })
+     )
+   }
+    ```
+    We added overlay.sockedPort option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in `config/shakapacker.yml`. Thats way we make sockjs works properly and suppress error in browser console `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`. 
+
+4. Add react-refresh plugin in `babel.config.js`
+```
+  module.export = function(api) {
+    return {
+      plugins: [process.env.WEBPACK_DEV_SERVER && 'react-refresh/babel'].filter(Boolean)
+    }
+  }
+```
+That's it :).
+Now Browser should reflect .js along with .css changes without reloading.
+
+If by some reason plugin doesn't work you could revert changes and left only devServer hmr/inline to true affecting only css files.
+
+These plugins are working and tested with 
+   - babel 7
+   - webpacker 5
+   - bootstrap 4
+   - jest 26
+   - core-js 3
+   - node 12.10.0
+   - react-refresh-webpack-plugin@0.4.1
+   - react-refresh 0.8.3 
+   - react_on_rails 11.1.4 
+   
+   configuration.

data/docs/guides/how-react-on-rails-works.md

@@ -0,0 +1,44 @@
+# How React on Rails Works (with Shakapcker)
+
+*Note, older versions of React on Rails pushed the Webpack bundles through the Asset Pipeline. This older method has *many* disadvantages, such as broken sourcemaps, performance issues, etc. If you need help migrating to the current way of bypassing the Asset Pipeline, [email Justin](mailto:justin@shakacode.com).*
+
+Webpack is used to generate JavaScript and CSS "bundles" directly to your `/public` directory. [Shakapacker](https://github.com/shakacode/shakapacker) provides view helpers to access the Webpack-generated (and fingerprinted) JS and CSS. These files totally skip the Rails asset pipeline. You are responsible for properly configuring your Webpack output. You will either use the standard Webpack configuration (*recommended*) or the `shakapacker` setup for Webpack.
+
+Ensure these generated bundle files are in your `.gitignore`, as you never want to add the large compiled bundles to git.
+
+Inside your Rails views, you can now use the `react_component` helper method provided by React on Rails. You can pass props directly to the react component helper.
+
+Optionally, you can also initialize a Redux store with the view or controller helper `redux_store` so that the redux store can be shared amongst multiple React components.
+
+## Client-Side Rendering vs. Server-Side Rendering
+
+In most cases, you should use the `prerender: false` (default behavior) with the provided `react_component` helper method to render the React component from your Rails views. In some cases, such as when SEO is vital, or many users will not have JavaScript enabled, you can enable server-rendering by passing `prerender: true` to your helper, or you can simply change the default in `config/initializers/react_on_rails`.
+
+Now the server will interpret your JavaScript. The default is to use [ExecJS](https://github.com/rails/execjs) and pass the resulting HTML to the client. If you want to maximize the performance of your server rendering, then you want to use React on Rails Pro which uses NodeJS to do the server rendering. See the [docs for React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
+
+## HTML Source Code
+
+If you open the HTML source of any web page using React on Rails, you'll see the 3 parts of React on Rails rendering:
+
+1. The wrapper div `<div id="HelloWorld-react-component-0">` specifies the div where to place the React rendering. It encloses the server-rendered HTML for the React component. If server rendering is not used (prerender: false), then the major difference is that the HTML rendered for the React component only contains the outer div: `<div id="HelloWorld-react-component-0"/>`. The first specification of the React component is just the same.
+1. A script tag containing the properties of the React component, such as the registered name and any props. A JavaScript function runs after the page loads, using this data to build and initialize your React components.
+1. Additional JavaScript is placed to console-log any messages, such as server rendering errors. Note: these server-side logs can be configured only to be sent to the server logs.
+
+You can see all this on the source for [reactrails.com](https://www.reactrails.com/)
+
+## Building the Bundles
+
+Each time you change your client code, you will need to re-generate the bundles (the webpack-created JavaScript files included in application.js). The included example Foreman `Procfile.dev` files will take care of this for you by starting a webpack process with the watch flag. This will watch your JavaScript code files for changes. Alternatively, the `shakapacker` library also can ensure that your bundles are built.
+
+For example, you might create a [Procfile.dev](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/Procfile.dev).
+
+On production deployments that use asset precompilation, such as Heroku deployments, `shakapacker`, by default, will automatically run webpack to build your JavaScript bundles, running the command `bin/shakapacker` in your app.
+
+However, if you want to run a custom command to run webpack to build your bundles, then you will:
+1. Define `config.build_production_command` in your [config/initializers/react_on_rails.rb](https://www.shakacode.com/react-on-rails/docs/guides/configuration/)
+
+Then React on Rails modifies the `assets:precompile` task to run your `build_production_command`.
+
+If you have used the provided generator, these bundles will automatically be added to your `.gitignore` to prevent extraneous noise from re-generated code in your pull requests. You will want to do this manually if you do not use the provided generator.
+
+You can stop React on Rails from modifying or creating the `assets:precompile` task, by setting a `REACT_ON_RAILS_PRECOMPILE` environment variable to `no`, `false`, `n` or `f`.