webpacker 5.0.1 → 6.0.0.beta

data/README.md

@@ -1,11 +1,15 @@
 # Webpacker
 
-[![Build Status](https://travis-ci.org/rails/webpacker.svg?branch=master)](https://travis-ci.org/rails/webpacker)
-[![node.js](https://img.shields.io/badge/node-%3E%3D%2010.13.0-brightgreen.svg)](https://www.npmjs.com/package/@rails/webpacker)
+[![Ruby specs](https://github.com/rails/webpacker/workflows/Ruby%20specs/badge.svg)](https://github.com/rails/webpacker/actions)
+[![Jest specs](https://github.com/rails/webpacker/workflows/Jest%20specs/badge.svg)](https://github.com/rails/webpacker/actions)
+[![Rubocop](https://github.com/rails/webpacker/workflows/Rubocop/badge.svg)](https://github.com/rails/webpacker/actions)
+[![JS lint](https://github.com/rails/webpacker/workflows/JS%20lint/badge.svg)](https://github.com/rails/webpacker/actions)
+
+[![node.js](https://img.shields.io/badge/node-%3E%3D%2010.17.0-brightgreen.svg)](https://www.npmjs.com/package/@rails/webpacker)
 [![Gem](https://img.shields.io/gem/v/webpacker.svg)](https://rubygems.org/gems/webpacker)
 
 Webpacker makes it easy to use the JavaScript pre-processor and bundler
-[webpack 4.x.x+](https://webpack.js.org/)
+[webpack 5.x.x+](https://webpack.js.org/)
 to manage application-like JavaScript in Rails. It coexists with the asset pipeline,
 as the primary purpose for webpack is app-like JavaScript, not images, CSS, or
 even JavaScript Sprinkles (that all continues to live in app/assets).
@@ -13,7 +17,7 @@ even JavaScript Sprinkles (that all continues to live in app/assets).
 However, it is possible to use Webpacker for CSS, images and fonts assets as well,
 in which case you may not even need the asset pipeline. This is mostly relevant when exclusively using component-based JavaScript frameworks.
 
-**NOTE:** The master branch now hosts the code for v5.x.x. Please refer to [4-x-stable](https://github.com/rails/webpacker/tree/4-x-stable) branch for 4.x documentation.
+**NOTE:** The master branch now hosts the code for v6.x.x. Please refer to [5-x-stable](https://github.com/rails/webpacker/tree/5-x-stable) branch for 5.x documentation.
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -28,16 +32,6 @@ in which case you may not even need the asset pipeline. This is mostly relevant
   - [Webpack Configuration](#webpack-configuration)
   - [Custom Rails environments](#custom-rails-environments)
   - [Upgrading](#upgrading)
-  - [Yarn Integrity](#yarn-integrity)
-- [Integrations](#integrations)
-  - [React](./docs/integrations.md#react)
-  - [Angular with TypeScript](./docs/integrations.md#angular-with-typescript)
-  - [Vue](./docs/integrations.md#vue)
-  - [Elm](./docs/integrations.md#elm)
-  - [Stimulus](./docs/integrations.md#stimulus)
-  - [Svelte](./docs/integrations.md#svelte)
-  - [CoffeeScript](./docs/integrations.md#coffeescript)
-  - [Erb](./docs/integrations.md#erb)
 - [Paths](#paths)
   - [Resolved](#resolved)
   - [Watched](#watched)
@@ -52,23 +46,28 @@ in which case you may not even need the asset pipeline. This is mostly relevant
 
 - Ruby 2.4+
 - Rails 5.2+
-- Node.js 10.13.0+
+- Node.js 10.22.1+ || 12+ || 14+
 - Yarn 1.x+
 
 ## Features
 
-- [webpack 4.x.x](https://webpack.js.org/)
+- [webpack 5.x.x](https://webpack.js.org/)
 - ES6 with [babel](https://babeljs.io/)
 - Automatic code splitting using multiple entry points
-- Stylesheets - Sass and CSS
-- Images and fonts
-- PostCSS - Auto-Prefixer
 - Asset compression, source-maps, and minification
 - CDN support
-- React, Angular, Elm and Vue support out-of-the-box
 - Rails view helpers
 - Extensible and configurable
 
+  ### Optional support\*
+
+  _requires extra packages to be installed_
+
+  - Stylesheets - SASS, LESS and CSS, PostCSS
+  - Coffeescript
+  - Typescript
+  - React
+
 ## Installation
 
 You can either add Webpacker during setup of a new Rails 5.1+ application
@@ -83,12 +82,11 @@ Or add it to your `Gemfile`:
 
 ```ruby
 # Gemfile
-gem 'webpacker', '~> 4.x'
+gem 'webpacker', '~> 6.x'
 
 # OR if you prefer to use master
 gem 'webpacker', git: 'https://github.com/rails/webpacker.git'
 yarn add https://github.com/rails/webpacker.git
-yarn add core-js regenerator-runtime
 ```
 
 Finally, run the following to install Webpacker:
@@ -107,6 +105,12 @@ Optional: To fix ["unmet peer dependency" warnings](https://github.com/rails/web
 yarn upgrade
 ```
 
+When `package.json` and/or `yarn.lock` changes, such as when pulling down changes to your local environment in a team settings, be sure to keep your NPM packages up-to-date:
+
+```bash
+yarn install
+```
+
 ### Usage
 
 Once installed, you can start writing modern ES6-flavored JavaScript apps right away:
@@ -116,25 +120,20 @@ app/javascript:
   ├── packs:
   │   # only webpack entry files here
   │   └── application.js
-  └── src:
   │   └── application.css
+  └── src:
+  │   └── my_component.js
+  └── stylesheets:
+  │   └── my_styles.css
   └── images:
       └── logo.svg
 ```
 
-In `/packs/application.js`, include this at the top of the file:
-
-```js
-import 'core-js/stable'
-import 'regenerator-runtime/runtime'
-```
-
-You can then link the JavaScript pack in Rails views using the `javascript_pack_tag` helper.
-If you have styles imported in your pack file, you can link them by using `stylesheet_pack_tag`:
+You can then link the JavaScript pack in Rails views using the `javascript_packs_with_chunks_tag` helper. If you have styles imported in your pack file, you can link them by using `stylesheet_packs_with_chunks_tag`:
 
 ```erb
-<%= javascript_pack_tag 'application' %>
-<%= stylesheet_pack_tag 'application' %>
+<%= javascript_packs_with_chunks_tag 'application' %>
+<%= stylesheet_packs_with_chunks_tag 'application' %>
 ```
 
 If you want to link a static asset for `<link rel="prefetch">` or `<img />` tag, you
@@ -145,31 +144,6 @@ can use the `asset_pack_path` helper:
 <img src="<%= asset_pack_path 'images/logo.svg' %>" />
 ```
 
-If you are using new webpack 4 split chunks API, then consider using `javascript_packs_with_chunks_tag` helper, which creates html
-tags for a pack and all the dependent chunks.
-
-```erb
-<%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %>
-
-<script src="/packs/vendor-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/calendar~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/map~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/map-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-```
-
-**Important:** Pass all your pack names when using `javascript_packs_with_chunks_tag`
-helper otherwise you will get duplicated chunks on the page.
-
-```erb
-<%# DO %>
-<%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
-
-<%# DON'T %>
-<%= javascript_packs_with_chunks_tag 'calendar' %>
-<%= javascript_packs_with_chunks_tag 'map' %>
-```
-
 **Note:** In order for your styles or static assets files to be available in your view,
 you would need to link them in your "pack" or entry file.
 
@@ -235,7 +209,201 @@ WEBPACKER_DEV_SERVER_HOST=0.0.0.0 ./bin/webpack-dev-server
 
 ### Webpack Configuration
 
-See [docs/webpack](docs/webpack.md) for modifying webpack configuration and loaders.
+Webpacker gives you a default set of configuration files for test, development and
+production environments in `config/webpack/*.js`. You can configure each individual
+environment in their respective files or configure them all in the base
+`config/webpack/environment.js` file.
+
+By default, you don't need to make any changes to `config/webpack/*.js`
+files since it's all standard production-ready configuration. However,
+if you do need to customize or add a new loader, this is where you would go.
+
+Here is how you can modify webpack configuration:
+
+You might add separate files to keep your code more organized.
+
+```js
+// config/webpack/custom.js
+module.exports = {
+  resolve: {
+    alias: {
+      jquery: 'jquery/src/jquery',
+      vue: 'vue/dist/vue.js',
+      React: 'react',
+      ReactDOM: 'react-dom',
+      vue_resource: 'vue-resource/dist/vue-resource'
+    }
+  }
+}
+```
+
+Then `require` this file in your `config/webpack/base.js`:
+
+```js
+// config/webpack/base.js
+const { webpackConfig, merge } = require('@rails/webpacker')
+const customConfig = require('./custom')
+
+module.exports = merge(webpackConfig, customConfig)
+```
+
+If you need access to configs within Webpacker's configuration,
+you can import them like so:
+
+```js
+// config/webpack/base.js
+const { webpackConfig } = require('@rails/webpacker')
+
+console.log(webpackConfig.output_path)
+console.log(webpackConfig.source_path)
+```
+
+### Integrations
+
+Webpacker out of the box supports JS and static assets (fonts, images etc.)
+compilation. To enable support for Coffeescript or Typescript install
+relevant packages,
+
+**Coffeescript**
+
+```
+yarn add coffeescript coffee-loader
+```
+
+**Typescript**
+
+```
+yarn add typescript @babel/preset-typescript
+```
+
+Add tsconfig.json
+
+```json
+{
+  "compilerOptions": {
+    "declaration": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "lib": ["es6", "dom"],
+    "module": "es6",
+    "moduleResolution": "node",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/*", "app/javascript/*"]
+    },
+    "sourceMap": true,
+    "target": "es5",
+    "noEmit": true
+  },
+  "exclude": ["**/*.spec.ts", "node_modules", "vendor", "public"],
+  "compileOnSave": false
+}
+```
+
+#### CSS
+
+To enable CSS support in your application, add following packages,
+
+```
+yarn add css-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+```
+
+optionally, add css extension to webpack config for easy resolution
+
+```js
+// config/webpack/base.js
+const { webpackConfig, merge } = require('@rails/webpacker')
+const customConfig = {
+  resolve: {
+    extensions: ['.css']
+  }
+}
+
+module.exports = merge(webpackConfig, customConfig)
+```
+
+To enable postcss, sass or less support, add css support first and
+then add the relevant pre-processors:
+
+#### Postcss
+
+```
+yarn add postcss-loader
+```
+
+#### Sass
+
+```
+yarn add sass-loader
+```
+
+#### Less
+
+```
+yarn add less-loader
+```
+
+#### React
+
+React is supported and you just need to add relevant packages,
+
+```
+yarn add react react-dom @babel/preset-react
+```
+
+if you are using typescript, update your `tsconfig.json`
+
+```json
+{
+  "compilerOptions": {
+    "declaration": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "lib": ["es6", "dom"],
+    "module": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "target": "es5",
+    "jsx": "react",
+    "noEmit": true
+  },
+  "exclude": ["**/*.spec.ts", "node_modules", "vendor", "public"],
+  "compileOnSave": false
+}
+```
+
+#### Other frameworks
+
+Please follow webpack integration guide for relevant framework or library,
+
+1. Svelte - https://github.com/sveltejs/svelte-loader#install
+2. Angular - https://v2.angular.io/docs/ts/latest/guide/webpack.html#!#configure-webpack
+3. Vue - https://vue-loader.vuejs.org/guide/
+
+For example to add Vue support,
+
+```js
+// config/webpack/rules/vue.js
+const VueLoaderPlugin = require('vue-loader/lib/plugin')
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.vue$/,
+        loader: 'vue-loader'
+      }
+    ]
+  },
+  plugins: [new VueLoaderPlugin()]
+}
+
+// config/webpack/base.js
+const { webpackConfig, merge } = require('@rails/webpacker')
+const vueConfig = require('./rules/vue')
+
+module.exports = merge(webpackConfig, vueConfig)
+```
 
 ### Custom Rails environments
 
@@ -292,7 +460,7 @@ You can run following commands to upgrade Webpacker to the latest stable version
 
 ```bash
 bundle update webpacker
-rails webpacker:binstubs
+rails webpacker:install
 yarn upgrade @rails/webpacker --latest
 yarn upgrade webpack-dev-server --latest
 
@@ -300,44 +468,6 @@ yarn upgrade webpack-dev-server --latest
 yarn add @rails/webpacker@next
 ```
 
-### Yarn Integrity
-
-By default, in development, webpacker runs a yarn integrity check to ensure that all local JavaScript packages are up-to-date. This is similar to what bundler does currently in Rails, but for JavaScript packages. If your system is out of date, then Rails will not initialize. You will be asked to upgrade your local JavaScript packages by running `yarn install`.
-
-To turn off this option, you will need to change the default setting in `config/webpacker.yml`:
-
-```yaml
-# config/webpacker.yml
-development:
-  ...
-  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
-  check_yarn_integrity: false
-```
-
-You may also turn on this feature by adding the config option for any Rails environment in `config/webpacker.yml`:
-
-```yaml
-check_yarn_integrity: true
-```
-
-## Integrations
-
-Webpacker ships with basic out-of-the-box integration. You can see a list of available commands/tasks by running `bundle exec rails webpacker`.
-
-Included install integrations:
-
-- [React](./docs/integrations.md#React)
-- [Angular with TypeScript](./docs/integrations.md#Angular-with-TypeScript)
-- [Vue](./docs/integrations.md#Vue)
-- [Elm](./docs/integrations.md#Elm)
-- [Svelte](./docs/integrations.md#Svelte)
-- [Stimulus](./docs/integrations.md#Stimulus)
-- [CoffeeScript](./docs/integrations.md#CoffeeScript)
-- [Typescript](./docs/integrations.md)
-- [Erb](./docs/integrations.md#Erb)
-
-See [Integrations](./docs/integrations.md) for further details.
-
 ## Paths
 
 By default, Webpacker ships with simple conventions for where the JavaScript
@@ -373,16 +503,16 @@ development:
 
 If you have `hmr` turned to true, then the `stylesheet_pack_tag` generates no output, as you will want to configure your styles to be inlined in your JavaScript for hot reloading. During production and testing, the `stylesheet_pack_tag` will create the appropriate HTML tags.
 
-### Resolved
+### Additional paths
 
 If you are adding Webpacker to an existing app that has most of the assets inside
 `app/assets` or inside an engine, and you want to share that
-with webpack modules, you can use the `resolved_paths`
+with webpack modules, you can use the `additional_paths`
 option available in `config/webpacker.yml`. This lets you
 add additional paths that webpack should lookup when resolving modules:
 
 ```yml
-resolved_paths: ['app/assets']
+additional_paths: ['app/assets/**/*', 'vendor/assets/**/*.css', 'Gemfile']
 ```
 
 You can then import these items inside your modules like so:
@@ -397,41 +527,11 @@ import 'images/rails.png'
 will make the compilation slow, consider adding specific paths instead of
 whole parent directory if you just need to reference one or two modules
 
-### Watched
-
-By default, the lazy compilation is cached until a file is changed under your
-tracked paths. You can configure which paths are tracked
-by adding new paths to `watched_paths` array. This is much like Rails' `autoload_paths`:
-
-```rb
-# config/initializers/webpacker.rb
-# or config/application.rb
-Webpacker::Compiler.watched_paths << 'bower_components'
-```
-
 ## Deployment
 
 Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which gets run whenever you run `assets:precompile`. If you are not using Sprockets, `webpacker:compile` is automatically aliased to `assets:precompile`. Similar to sprockets both rake tasks will compile packs in production mode but will use `RAILS_ENV` to load configuration from `config/webpacker.yml` (if available).
 
-## Docs
-
-- [Development](https://github.com/rails/webpacker#development)
-  - [Webpack](./docs/webpack.md)
-  - [Webpack-dev-server](./docs/webpack-dev-server.md)
-  - [Environment Variables](./docs/env.md)
-  - [Folder Structure](./docs/folder-structure.md)
-  - [Assets](./docs/assets.md) - [CSS, Sass and SCSS](./docs/css.md) - [ES6](./docs/es6.md)
-    - [Props](./docs/props.md)
-    - [Typescript](./docs/typescript.md)
-  - [Yarn](./docs/yarn.md)
-  - [Misc](./docs/misc.md)
-- [Deployment](./docs/deployment.md)
-  - [Docker](./docs/docker.md)
-  - [Using in Rails engines](./docs/engines.md)
-  - [Webpacker on Cloud9](./docs/cloud9.md)
-- [Testing](./docs/testing.md)
-- [Troubleshooting](./docs/troubleshooting.md)
-- [v3 to v4 Upgrade Guide](./docs/v4-upgrade.md)
+When compiling assets for production on a remote server, such as a continuous integration environment, it's recommended to use `yarn install --frozen-lockfile` to install NPM packages on the remote host to ensure that the installed packages match the `yarn.lock` file.
 
 ## Contributing