webpacker 1.2 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ccfe0b6654653e31fa2f154132007bbde99b751
-  data.tar.gz: 14f29f16a493bc35b35162feaea491027dd736fa
+  metadata.gz: 8a0e2ae99bad3184ab44d798809fbd0efe458e38
+  data.tar.gz: 0a6a47fa0b5a829e4ff418891310a1cfeb7e2288
 SHA512:
-  metadata.gz: 40170698d19c5b726d2a6407ea14c385d57c4e90feb44b72e42b1bb05f478cb2e8467ec9b727a32be423b74efe3e1aa97c6bd2f667205354b82ab3f66dc32488
-  data.tar.gz: fa16cf6e69c87157b4f0eb310d1a2c3d978dc71469ec42cab00926e55db77aa7706dacf749c4871c21e71baaf49d1fada7c4626d2560699bb8e3e7c49b7621fe
+  metadata.gz: e162e508430b3179b5e0aded52ddf815be5b4f6f67dbf01cd822a18c9f6227773b0f44adfef45a74d9c11e2b73dce64e0209352236f8156602bd08e2009b95b4
+  data.tar.gz: da29a763948aadb84689b1cc94f884e78489d28319a920bfd76e43f8d6ac8b6d61df74db4de707de101c47407fbafe770b29db9e67c1e9d24292042c55bdbdf7

data/.gitignore

@@ -1,2 +1,4 @@
 /.bundle
+/pkg
+/test/test_app/log
 node_modules

data/CHANGELOG.md

@@ -1,16 +1,94 @@
+## [2.0] - 2017-05-24
+
+
+### Fixed
+- Update `.babelrc` to fix compilation issues - [#306](https://github.com/rails/webpacker/issues/306)
+
+- Duplicated asset hosts - [#320](https://github.com/rails/webpacker/issues/320), [#397](https://github.com/rails/webpacker/pull/397)
+
+- Missing asset host when defined as a `Proc` or on `ActionController::Base.asset_host` directly - [#397](https://github.com/rails/webpacker/pull/397)
+
+- Incorrect asset host when running `webpacker:compile` or `bin/webpack` in development mode - [#397](https://github.com/rails/webpacker/pull/397)
+
+- Update `webpacker:compile` task to use `stdout` and `stderr` for better logging - [#395](https://github.com/rails/webpacker/issues/395)
+
+- ARGV support for `webpack-dev-server` - [#286](https://github.com/rails/webpacker/issues/286)
+
+
+### Added
+- [Elm](http://elm-lang.org) support. You can now add Elm support via the following methods:
+  - New app: `rails new <app> --webpack=elm`
+  - Within an existing app: `rails webpacker:install:elm`
+
+- Support for custom `public_output_path` paths independent of `source_entry_path` in `config/webpacker.yml`. `output` is also now relative to `public/`. - [#397](https://github.com/rails/webpacker/pull/397)
+
+    Before (compile to `public/packs`):
+    ```yaml
+      source_entry_path: packs
+      public_output_path: packs
+    ```
+    After (compile to `public/sweet/js`):
+    ```yaml
+      source_entry_path: packs
+      public_output_path: sweet/js
+    ```
+
+- `https` option to use `https` mode, particularly on platforms like - https://community.c9.io/t/running-a-rails-app/1615 or locally - [#176](https://github.com/rails/webpacker/issues/176)
+
+- [Babel] Dynamic import() and Class Fields and Static Properties babel plugin to `.babelrc`
+
+```json
+{
+  "presets": [
+    ["env", {
+      "modules": false,
+      "targets": {
+        "browsers": "> 1%",
+        "uglify": true
+      },
+      "useBuiltIns": true
+    }]
+  ],
+
+  "plugins": [
+    "syntax-dynamic-import",
+    "transform-class-properties", { "spec": true }
+  ]
+}
+```
+
+- Source-map support for production bundle
+
+
+#### Breaking Change
+
+- Consolidate and flatten `paths.yml` and `development.server.yml` config into one file - `config/webpacker.yml` - [#403](https://github.com/rails/webpacker/pull/403). This is a breaking change and requires you to re-install webpacker and cleanup old configuration files.
+
+  ```bash
+  bundle update webpacker
+  bundle exec rails webpacker:install
+
+  # Remove old/unused configuration files
+  rm config/paths.yml
+  rm config/development.server.yml
+  rm config/development.server.js
+  ```
+
+
 ## [1.2] - 2017-04-27
 Some of the changes made requires you to run below commands to install new changes.
 
-```bash
+```
 bundle update webpacker
 bundle exec rails webpacker:install
 ```
 
+
 ### Fixed
 - Support Spring - [#205](https://github.com/rails/webpacker/issues/205)
 
   ```ruby
-    Spring.after_fork {  Webpacker.bootstrap } if defined?(Spring)
+  Spring.after_fork { Webpacker.bootstrap } if defined?(Spring)
   ```
 - Check node version and yarn before installing webpacker - [#217](https://github.com/rails/webpacker/issues/217)
 
@@ -24,31 +102,36 @@ bundle exec rails webpacker:install
 
 - Move babel presets and plugins to .babelrc - [#202](https://github.com/rails/webpacker/issues/202)
 
+
 ### Added
 - A changelog - [#211](https://github.com/rails/webpacker/issues/211)
 - Minimize CSS assets - [#218](https://github.com/rails/webpacker/issues/218)
 - Pack namespacing support - [#201](https://github.com/rails/webpacker/pull/201)
 
-```
-app/javascript/packs/admin/hello_vue.js
-app/javascript/packs/admin/hello.vue
-app/javascript/packs/hello_vue.js
-app/javascript/packs/hello.vue
-```
+  For example:
+  ```
+  app/javascript/packs/admin/hello_vue.js
+  app/javascript/packs/admin/hello.vue
+  app/javascript/packs/hello_vue.js
+  app/javascript/packs/hello.vue
+  ```
 - Add tree-shaking support - [#250](https://github.com/rails/webpacker/pull/250)
 - Add initial test case by @kimquy [#259](https://github.com/rails/webpacker/pull/259)
 - Compile assets before test:controllers and test:system
 
+
 ### Removed
 - Webpack watcher - [#295](https://github.com/rails/webpacker/pull/295)
 
+
 ## [1.1] - 2017-03-24
 
 This release requires you to run below commands to install new features.
 
-```bash
+```
 bundle update webpacker
 bundle exec rails webpacker:install
+
 # if installed react, vue or angular
 bundle exec rails webpacker:install:[react, angular, vue]
 ```
@@ -57,6 +140,7 @@ bundle exec rails webpacker:install:[react, angular, vue]
 - Static assets support - [#153](https://github.com/rails/webpacker/pull/153)
 - Advanced webpack configuration - [#153](https://github.com/rails/webpacker/pull/153)
 
+
 ### Removed
 
 ```rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpacker (1.1)
+    webpacker (1.2)
       activesupport (>= 4.2)
       multi_json (~> 1.2)
       railties (>= 4.2)
@@ -134,4 +134,4 @@ DEPENDENCIES
   webpacker!
 
 BUNDLED WITH
-   1.14.3
+   1.14.6

data/README.md

@@ -1,72 +1,501 @@
 # Webpacker
+
 ![travis-ci status](https://api.travis-ci.org/rails/webpacker.svg?branch=master)
 [![node.js](https://img.shields.io/badge/node-%3E%3D%206.4.0-brightgreen.svg)](https://nodejs.org/en/)
 [![Gem](https://img.shields.io/gem/v/webpacker.svg)](https://github.com/rails/webpacker)
 
-Webpacker makes it easy to use the JavaScript preprocessor and bundler [Webpack 2.x.x+](https://webpack.js.org/)
+Webpacker makes it easy to use the JavaScript pre-processor and bundler
+[Webpack 2.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). It is, however,
-possible to use Webpacker for CSS and images 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.
+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).
+
+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.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Features](#features)
+- [Installation](#installation)
+- [Integrations](#integrations)
+  - [React](#react)
+  - [Angular with TypeScript](#angular-with-typescript)
+  - [Vue](#vue)
+  - [Elm](#elm)
+- [Binstubs](#binstubs)
+  - [Webpack dev server](#webpack-dev-server)
+  - [Webpack](#webpack)
+- [Configuration](#configuration)
+  - [Webpack](#webpack-1)
+  - [Loaders](#loaders)
+  - [Paths](#paths)
+  - [Babel](#babel)
+  - [Post-Processing CSS](#post-processing-css)
+  - [CDN](#cdn)
+  - [HTTPS in development](#https-in-development)
+  - [Hot module replacement](#hot-module-replacement)
+- [Linking Styles, Images and Fonts](#linking-styles-images-and-fonts)
+  - [Within your JS app](#within-your-js-app)
+  - [Inside views](#inside-views)
+  - [From node modules folder](#from-node-modules-folder)
+- [How-tos](#how-tos)
+  - [App structure](#app-structure)
+    - [Namespacing](#namespacing)
+  - [Pass data from view](#pass-data-from-view)
+    - [React](#react-1)
+    - [Vue](#vue-1)
+  - [Add common chunks](#add-common-chunks)
+  - [Module import() vs require()](#module-import-vs-require)
+  - [Add a new npm module](#add-a-new-npm-module)
+  - [Add bootstrap](#add-bootstrap)
+  - [Use Typescript with React](#use-typescript-with-react)
+  - [HTML templates with Typescript](#html-templates-with-typescript)
+  - [CSS modules](#css-modules)
+  - [CSS-Next](#css-next)
+  - [Ignoring swap files](#ignoring-swap-files)
+  - [Link sprocket assets](#link-sprocket-assets)
+    - [Using helpers](#using-helpers)
+    - [Using babel module resolver](#using-babel-module-resolver)
+- [Extending](#extending)
+- [Deployment](#deployment)
+  - [Heroku](#heroku)
+- [Testing](#testing)
+- [Troubleshooting](#troubleshooting)
+- [Wishlist](#wishlist)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-It's designed to work with Rails 5.1+ and makes use of the [Yarn](https://yarnpkg.com) dependency management
-that's been made default from that version forward.
 
 ## Prerequisites
 
 * Ruby 2.2+
 * Rails 4.2+
 * Node.js 6.4.0+
-* Yarn
+* Yarn 0.20.1+
+
+
+## Features
+
+* [Webpack 2](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
+
 
 ## Installation
 
-Webpacker is currently compatible with Rails 4.2+, but there's no guarantee it will still be
-in the future.
+You can either add Webpacker during setup of a new Rails 5.1+ application
+using new `--webpack` option:
 
-You can either make use of Webpacker during setup of a new application with `--webpack`
-or you can add the gem and run `./bin/rails webpacker:install` in an existing application.
+```bash
+# Available Rails 5.1+
+./bin/rails new myapp --webpack
+```
 
-As the rubygems version isn't promised to be kept up to date until the release of Rails 5.1, you may want to include the gem directly from GitHub:
+Or add it to your `Gemfile`, run bundle and `./bin/rails webpacker:install` or `bundle exec rake webpacker:install` (on rails version < 5.0):
 
 ```ruby
-gem 'webpacker', github: 'rails/webpacker'
+# Gemfile
+gem 'webpacker', '~> 2.0'
+
+# OR if you prefer to use master
+gem 'webpacker', git: 'https://github.com/rails/webpacker.git'
+```
+
+**Note:** Use `rake` instead of `rails` if you are using webpacker
+with rails version < 5.0
+
+
+## Integrations
+
+Webpacker by default ships with basic out-of-the-box integration
+for React, Angular, Vue and Elm. You can see a list of available
+commands/tasks by running:
+
+```bash
+./bin/rails webpacker
+```
+
+or in rails version < 5.0
+
+```bash
+./bin/rake webpacker
+```
+
+
+### React
+
+To use Webpacker with [React](https://facebook.github.io/react/), create a
+new Rails 5.1+ app using `--webpack=react` option:
+
+```bash
+# Rails 5.1+
+./bin/rails new myapp --webpack=react
+```
+
+(or run `./bin/rails webpacker:install:react` in a existing Rails app already
+setup with webpacker).
+
+The installer will add all relevant dependencies using yarn, any changes
+to the configuration files and an example React component to your
+project in `app/javascript/packs` so that you can experiment with React right away.
+
+
+### Angular with TypeScript
+
+To use Webpacker with [Angular](https://angularjs.org/), create a
+new Rails 5.1+ app using `--webpack=angular` option:
+
+```bash
+# Rails 5.1+
+./bin/rails new myapp --webpack=angular
+```
+
+(or run `./bin/rails webpacker:install:angular` on a Rails app already
+setup with webpacker).
+
+The installer will add TypeScript and Angular core libraries using yarn plus
+any changes to the configuration files. An example component is written in
+TypeScript will also be added to your project in `app/javascript` so that
+you can experiment with Angular right away.
+
+
+### Vue
+
+To use Webpacker with [Vue](https://vuejs.org/), create a
+new Rails 5.1+ app using `--webpack=vue` option:
+
+```bash
+# Rails 5.1+
+./bin/rails new myapp --webpack=vue
+```
+(or run `./bin/rails webpacker:install:vue` on a Rails app already setup with webpacker).
+
+The installer will add Vue and required libraries using yarn plus
+any changes to the configuration files. An example component will
+also be added to your project in `app/javascript` so that you can
+experiment Vue right away.
+
+
+### Elm
+
+To use Webpacker with [Elm](http://elm-lang.org), create a
+new Rails 5.1+ app using `--webpack=elm` option:
+
+```
+./bin/rails new myapp --webpack=elm
 ```
 
-You can also see a list of available commands by running `./bin/rails webpacker`
+(or run `./bin/rails webpacker:install:elm` on a Rails app already setup with webpacker).
+
+The Elm library and core packages will be added via Yarn and Elm itself.
+An example `Main.elm` app will also be added to your project in `app/javascript`
+so that you can experiment with Elm right away.
+
 
 ## Binstubs
 
 Webpacker ships with two binstubs: `./bin/webpack` and `./bin/webpack-dev-server`.
-They're thin wrappers around the standard webpack.js executable, just to ensure that the right configuration file is loaded depending on your environment.
+Both are thin wrappers around the standard `webpack.js` and `webpack-dev-server.js`
+executable to ensure that the right configuration file and environment variables
+are loaded depending on your environment.
+
+
+### Webpack dev server
+
+In development, you'll need to run `./bin/webpack-dev-server` in a separate terminal
+from `./bin/rails server` to have your `app/javascript/packs/*.js` files compiled
+as you make changes.
+
+`./bin/webpack-dev-server` launches the [Webpack Dev Server](https://webpack.js.org/configuration/dev-server/), which serves your pack files
+on `http://localhost:8080/` by default and supports live code reloading in the development environment. You will need to install additional plugins for Webpack if you want
+features like [Hot Module Replacement](https://webpack.js.org/guides/hmr-react/)
 
-A binstub is also created to install your npm dependencies,
-and can be called via `./bin/yarn`.
+If you'd rather not have to run the two processes separately by hand, you can use [Foreman](https://ddollar.github.io/foreman):
+
+```bash
+gem install foreman
+```
+
+```yml
+# Procfile
+web: bundle exec rails s
+webpacker: ./bin/webpack-dev-server
+```
+
+```bash
+foreman start
+```
+
+You can also pass CLI options supported by [webpack-dev-server](https://webpack.js.org/configuration/dev-server/). Please note that inline options will always take
+precedence over the ones already set in the configuration file.
+
+```bash
+./bin/webpack-dev-server --host 0.0.0.0 --inline true --hot false
+```
+
+
+### Webpack
+
+We recommend using `webpack-dev-server` during development for a better experience,
+however, if you don't want that for some reason you can always use `webpack` binstub with
+watch option, which uses webpack Command Line Interface (CLI). This will use `public_output_path` from `config/webpacker.yml`
+directory to serve your packs using configured rails server.
+
+You can pass cli options available with [Webpack](https://webpack.js.org/api/cli/):
+
+```bash
+./bin/webpack --watch --progress --colours
+```
 
-In development, you'll need to run `./bin/webpack-dev-server` in a separate terminal from `./bin/rails server` to have your `app/javascript/packs/*.js` files compiled as you make changes. If you'd rather not have to run the two processes separately by hand, you can use [Foreman](https://ddollar.github.io/foreman). `./bin/webpack-dev-server` launches the [Webpack Dev Server](https://webpack.js.org/configuration/dev-server/), which serves your pack files on http://localhost:8080/, and provides advanced Webpack features, such as [Hot Module Replacement](https://webpack.js.org/guides/hmr-react/).
 
 ## Configuration
 
-Webpacker gives you a default set of configuration files for development and production. They
-all live together with the shared points in `config/webpack/*.js`. By default, you shouldn't have to
-make any changes for a basic setup out the box. But this is where you do go if you need something
-more advanced.
 
-The configuration for what Webpack is supposed to compile by default rests on the convention that
-every file in `app/javascript/packs/*` should be turned into their own output files (or entry points,
-as Webpack calls it).
+### Webpack
+
+Webpacker gives you a default set of configuration files for test, development and
+production environments. They all live together with the shared
+points in `config/webpack/*.js`.
+
+![screen shot 2017-05-23 at 19 56 18](https://cloud.githubusercontent.com/assets/771039/26371229/0983add2-3ff2-11e7-9dc3-d9c2c1094032.png)
+
+By default, you shouldn't have 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.
+
+
+### Loaders
+
+Webpack enables the use of loaders to preprocess files. This allows you to
+bundle any static resource way beyond JavaScript. All base loaders
+that ships with webpacker are located inside `config/webpack/loaders`.
+
+If you want to add a new loader, for example, to process `json` files via webpack:
+
+```
+yarn add json-loader
+```
+
+And create a `json.js` file inside `loaders` directory:
+
+```js
+module.exports = {
+  test: /\.json$/,
+  use: 'json-loader'
+}
+```
+
+Now if you `import()` any `.json` files inside your javascript
+they will be processed using `json-loader`. Voila!
+
+
+### Paths
+
+By default, webpacker ships with simple conventions for where the javascript
+app files and compiled webpack bundles will go in your rails app,
+but all these options are configurable from `config/webpacker.yml` file.
+
+The configuration for what Webpack is supposed to compile by default rests
+on the convention that every file in `app/javascript/packs/*`**(default)**
+or whatever path you set for `source_entry_path` in the `webpacker.yml` configuration
+is turned into their own output files (or entry points, as Webpack calls it).
+
+Suppose you want to change the source directory from `app/javascript`
+to `frontend` and output to `assets/packs` this is how you would do it:
+
+```yml
+# config/webpacker.yml
+source_path: frontend
+source_entry_path: packs
+public_output_path: assets/packs => public/assets/packs
+```
+
+Similary you can also control and configure `webpack-dev-server` settings from `config/webpacker.yml` file:
+
+```yml
+# config/webpacker.yml
+development:
+  dev_server:
+    host: 0.0.0.0
+    port: 8080
+    https: false
+```
+
+
+### Babel
+
+Webpacker ships with [babel](https://babeljs.io/) - a JavaScript compiler so
+you can use next generation JavaScript, today. The Webpacker installer sets up a
+standard `.babelrc` file in your app root, which will work great in most cases
+because of [babel-env-preset](https://github.com/babel/babel-preset-env).
+
+Following ES6/7 features are supported out of the box:
+
+* Async/await.
+* Object Rest/Spread Properties.
+* Exponentiation Operator.
+* Dynamic import() - useful for route level code-splitting
+* Class Fields and Static Properties.
 
-Let's say you're building a calendar. Your structure could look like this:
+We have also included [babel polyfill](https://babeljs.io/docs/usage/polyfill/)
+that includes a custom regenerator runtime and core-js.
+
+
+### Post-Processing CSS
+
+Webpacker out-of-the-box provides CSS post-processing using
+[postcss-loader](https://github.com/postcss/postcss-loader)
+and the installer sets up a standard `.postcssrc.yml`
+file in your app root with standard plugins.
+
+```yml
+plugins:
+  postcss-smart-import: {}
+  precss: {}
+  autoprefixer: {}
+```
+
+
+### CDN
+
+Webpacker out-of-the-box provides CDN support using your Rails app `config.action_controller.asset_host` setting. If you already have [CDN](http://guides.rubyonrails.org/asset_pipeline.html#cdns) added in your rails app
+you don't need to do anything extra for webpacker, it just works.
+
+### HTTPS in development
+
+You may require the `webpack-dev-server` to serve views over HTTPS in development.
+To do this, set the `https` option for `webpack-dev-server`
+to `true` in `config/webpacker.yml`, then start the dev server as usual
+with `./bin/webpack-dev-server`.
+
+Please note that the `webpack-dev-server` will use a self-signed certificate,
+so your web browser will display a warning upon accessing the page.
+
+
+### Hot module replacement
+
+Webpacker out-of-the-box doesn't ship with HMR just yet. You will need to
+install additional plugins for Webpack if you want to add HMR support.
+
+You can checkout these links on this subject:
+
+- https://webpack.js.org/configuration/dev-server/#devserver-hot
+- https://webpack.js.org/guides/hmr-react/
+
+
+## Linking Styles, Images and Fonts
+
+Static assets like images, fonts and stylesheets support is enabled out-of-box
+and you can link them into your javascript app code and have them
+compiled automatically.
+
+
+### Within your JS app
+
+```sass
+// app/javascript/hello_react/styles/hello-react.sass
+
+.hello-react
+  padding: 20px
+  font-size: 12px
+```
+
+```js
+// React component example
+// app/javascripts/packs/hello_react.jsx
+
+import React from 'react'
+import helloIcon from '../hello_react/images/icon.png'
+import '../hello_react/styles/hello-react.sass'
+
+const Hello = props => (
+  <div className="hello-react">
+    <img src={helloIcon} alt="hello-icon" />
+    <p>Hello {props.name}!</p>
+  </div>
+)
+```
+
+
+### Inside views
+
+Under the hood webpack uses
+[extract-text-webpack-plugin](https://github.com/webpack-contrib/extract-text-webpack-plugin) plugin to extract all the referenced styles within your app and compile it into
+a separate `[pack_name].css` bundle so that in your view you can use the
+`stylesheet_pack_tag` helper,
+
+```erb
+<%= stylesheet_pack_tag 'hello_react' %>
+```
+
+You can also link js/images/styles used within your js app in views using
+`asset_pack_path` helper. This helper is useful in cases where you just want to
+create a `<link rel="prefetch">` or `<img />` for an asset.
+
+```erb
+<%= asset_pack_path 'hello_react.css' %>
+<% # => "/packs/hello_react.css" %>
+
+<img src="<%= asset_pack_path 'calendar.png' %>" />
+<% # => <img src="/packs/calendar.png" /> %>
+```
+
+
+### From node modules folder
+
+You can also import styles from `node_modules` using the following syntax.
+Please note that your styles will always be extracted into `[pack_name].css`:
+
+```sass
+// app/javascript/app-styles.sass
+// ~ to tell webpack that this is not a relative import:
+
+@import '~@material/animation/mdc-animation.scss'
+@import '~boostrap/dist/bootstrap.css'
+```
+
+```js
+// Your main app pack
+// app/javascript/packs/app.js
+
+import '../app-styles'
+```
+
+```erb
+<%# In your views %>
+
+<%= javascript_pack_tag 'app' %>
+<%= stylesheet_pack_tag 'app' %>
+```
+
+
+## How-tos
+
+
+### App structure
+
+Let's say you're building a calendar app. Your JS app structure could look like this:
 
 ```js
 // app/javascript/packs/calendar.js
-require('calendar')
+
+import 'calendar'
 ```
 
 ```
-app/javascript/calendar/index.js // gets loaded by require('calendar')
+app/javascript/calendar/index.js // gets loaded by import 'calendar'
 app/javascript/calendar/components/grid.jsx
 app/javascript/calendar/styles/grid.sass
 app/javascript/calendar/models/month.js
@@ -74,13 +503,17 @@ app/javascript/calendar/models/month.js
 
 ```erb
 <%# app/views/layouts/application.html.erb %>
+
 <%= javascript_pack_tag 'calendar' %>
 <%= stylesheet_pack_tag 'calendar' %>
 ```
 
 But it could also look a million other ways.
 
-**Note:** You can also namespace your packs using directories, similar to a Rails app.
+
+#### Namespacing
+
+You can also namespace your packs using directories similar to a Rails app.
 
 ```
 app/javascript/packs/admin/orders.js
@@ -91,6 +524,7 @@ and reference them in your views like this:
 
 ```erb
 <%# app/views/admin/orders/index.html.erb %>
+
 <%= javascript_pack_tag 'admin/orders' %>
 ```
 
@@ -98,82 +532,504 @@ and
 
 ```erb
 <%# app/views/shop/orders/index.html.erb %>
+
 <%= javascript_pack_tag 'shop/orders' %>
 ```
 
-## Advanced Configuration
 
-By default, webpacker offers simple conventions for where the webpack configs, javascript app files and compiled webpack bundles will go in your rails app,
-but all these options are configurable from `config/webpack/paths.yml` file.
+### Pass data from view
 
-```yml
-# config/webpack/paths.yml
-source: app/javascript
-entry: packs
-output: public
-config: config/webpack
-node_modules: node_modules
+
+#### React
+
+You may consider using [react-rails](https://github.com/reactjs/react-rails) or
+[webpacker-react](https://github.com/renchap/webpacker-react) for more advanced react integration. However here is how you can do it yourself:
+
+```erb
+<%# views/layouts/application.html.erb %>
+
+<%= content_tag :div,
+  id: "hello-react",
+  data: {
+    message: 'Hello!',
+    name: 'David'
+}.to_json do %>
+<% end %>
+```
+
+```js
+// app/javascript/packs/hello_react.js
+
+const Hello = props => (
+  <div className='react-app-wrapper'>
+    <img src={clockIcon} alt="clock" />
+    <h5 className='hello-react'>
+      {props.message} {props.name}!
+    </h5>
+  </div>
+)
+
+// Render component with data
+document.addEventListener('DOMContentLoaded', () => {
+  const node = document.getElementById('hello-react')
+  const data = JSON.parse(node.getAttribute('data'))
+
+  ReactDOM.render(<Hello {...data} />, node)
+})
 ```
 
-*Note:* Behind the scenes, webpacker will use same `entry` directory name inside `output`
-directory to emit bundles. For ex, `public/packs`
 
-Similary, you can also control and configure `webpack-dev-server` settings from
-`config/webpack/development.server.yml` file
+#### Vue
+
+```erb
+<%= content_tag :div,
+  id: "hello-vue",
+  data: {
+    message: "Hello!",
+    name: "David"
+} do %>
+<% end %>
+```
+
+```html
+<div id="hello-vue" data-name="David" data-message="Hello!"></div>
+```
+
+```js
+// Render component with data
+
+document.addEventListener('DOMContentLoaded', () => {
+  const node = document.getElementById('hello-vue')
+  const data = JSON.parse(node.getAttribute('data'))
+
+  const app = new Vue({
+    data: data,
+    el: '#vue-app',
+    template: '<App/>',
+    components: { App }
+  })
+
+  console.log(app)
+})
+```
+
+You can follow same steps for Angular too.
+
+
+### Add common chunks
+
+The CommonsChunkPlugin is an opt-in feature that creates a separate file (known as a chunk), consisting of common modules shared between multiple entry points. By separating common modules from bundles, the resulting chunked file can be loaded once initially, and stored in the cache for later use. This results in page speed optimizations as the browser can quickly serve the shared code from the cache, rather than being forced to load a larger bundle whenever a new page is visited.
+
+Create a `app-config.js` file inside `config/webpack` and in that file add:
+
+```js
+  module.exports = {
+    plugins: [
+      // Creates a common vendor.js with all shared modules
+      new webpack.optimize.CommonsChunkPlugin({
+        name: 'vendor',
+        minChunks: (module) => {
+          // this assumes your vendor imports exist in the node_modules directory
+          return module.context && module.context.indexOf('node_modules') !== -1;
+        }
+      }),
+      // Webpack code chunk - manifest.js
+      new webpack.optimize.CommonsChunkPlugin({
+        name: 'manifest',
+        minChunks: Infinity
+      })
+    ]
+  }
+```
+
+You can add this in `shared.js` too but we are doing this to ensure smoother upgrades.
+
+```js
+// config/webpack/shared.js
+// .... rest of the config
+
+const appConfig = require('./app-config.js')
+
+plugins: appConfig.plugins.concat([
+
+  // ...existing plugins
+
+])
+```
+
+Now, add these files to your `layouts/application.html.erb`:
+
+```erb
+<%= # Head %>
+
+<%= javascript_pack_tag 'manifest' %>
+<%= javascript_pack_tag 'vendor' %>
+
+<%= # If importing any styles from node_modules in your JS app %>
+
+<%= stylesheet_pack_tag 'vendor' %>
+```
+
+
+### Module import() vs require()
+
+While you are free to use `require()` and `module.exports`, we encourage you
+to use `import` and `export` instead since it reads and looks much better.
+
+```js
+import Button from 'react-bootstrap/lib/Button'
+
+// or
+import { Button } from 'react-bootstrap'
+
+class Foo {
+  // code...
+}
+
+export default Foo
+import Foo from './foo'
+```
+
+You can also use named export and import
+
+```js
+export const foo = () => console.log('hello world')
+import { foo } from './foo'
+```
+
+
+### Add a new npm module
+
+To add any new JS module you can use `yarn`:
+
+```bash
+yarn add bootstrap material-ui
+```
+
+
+### Add bootstrap
+
+You can use yarn to add bootstrap or any other modules available on npm:
+
+```bash
+yarn add bootstrap
+```
+
+Import Bootstrap and theme(optional) CSS in your app/javascript/packs/app.js file:
+
+```js
+import 'bootstrap/dist/css/bootstrap.css'
+import 'bootstrap/dist/css/bootstrap-theme.css'
+```
+
+Or in your app/javascript/app.sass file:
+
+```sass
+// ~ to tell that this is not a relative import
+
+@import '~bootstrap/dist/css/bootstrap.css'
+@import '~bootstrap/dist/css/bootstrap-theme.css'
+```
+
+
+### Use Typescript with React
+
+1. Setup react using webpacker [react installer](#react). Then add required depedencies
+for using typescript with React:
+
+```bash
+yarn add ts-loader typescript @types/react @types/react-dom
+
+# You don't need this with typescript
+yarn remove prop-types
+```
+
+2. Add a `tsconfig.json` to project root:
+
+``` json
+{
+  "compilerOptions": {
+    "declaration": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "lib": ["es6", "dom"],
+    "module": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "jsx": "react",
+    "target": "es5"
+  },
+  "exclude": [
+    "**/*.spec.ts",
+    "node_modules",
+    "public"
+  ],
+  "compileOnSave": false
+}
+```
+
+3. Add a new loader `config/webpack/loaders/typescript.js`:
+
+``` js
+module.exports = {
+  test: /.(ts|tsx)$/,
+  loader: 'ts-loader'
+}
+```
+
+4. Finally add `.tsx` to the list of extensions in `config/webpacker.yml`
+and rename your generated `hello_react.js` using react installer
+to `hello_react.tsx` and make it valid typescript and now you can use
+typescript, JSX with React.
+
+
+### Use HTML templates with Typescript and Angular
+
+After you have installed angular using [angular installer](#angular-with-typescript)
+you would need to follow these steps to add HTML templates support:
+
+1. Use `yarn` to add html-loader
+
+```bash
+yarn add html-loader
+```
+
+2. Add html-loader to `config/webpacker/loaders/html.js`
+
+```js
+module.exports = {
+  test: /\.html$/,
+  use: [{
+    loader: 'html-loader',
+    options: {
+      minimize: true,
+      removeAttributeQuotes: false,
+      caseSensitive: true,
+      customAttrSurround: [ [/#/, /(?:)/], [/\*/, /(?:)/], [/\[?\(?/, /(?:)/] ],
+      customAttrAssign: [ /\)?\]?=/ ]
+    }
+  }]
+}
+```
+
+3. Add `.html` to extensions list
 
 ```yml
-# config/webpack/development.server.yml
-enabled: true
-host: localhost
-port: 8080
+  extensions:
+    - .elm
+    - .coffee
+    - .html
+```
+
+4. Setup a custom `d.ts` definition
+
+```ts
+// app/javascript/hello_angular/html.d.ts
+
+declare module "*.html" {
+  const content: string
+  export default content
+}
+```
+
+5. Add a template.html file relative to `app.component.ts`
+
+```html
+<h1>Hello {{name}}</h1>
+```
+
+6. Import template into `app.component.ts`
+
+```ts
+import { Component } from '@angular/core'
+import templateString from './template.html'
+
+@Component({
+  selector: 'hello-angular',
+  template: templateString
+})
+
+export class AppComponent {
+  name = 'Angular!'
+}
 ```
 
-By default, `webpack-dev-server` uses `output` option specified in
-`paths.yml` as `contentBase`.
+That's all. Voila!
 
-## Linking to static assets
 
-Static assets like images, fonts and stylesheets support is enabled out-of-box so, you can link them into your javascript app code and have them compiled automatically.
+### CSS modules
+
+To enable CSS modules, you would need to update `config/webpack/loaders/sass.js`
+file, particularly `css-loader`:
+
+```js
+// Add css-modules
+
+{
+  loader: 'css-loader',
+  options: {
+    minimize: env.NODE_ENV === 'production',
+    modules: true,
+    localIdentName: '[path][name]__[local]--[hash:base64:5]'
+  }
+}
+```
+
+That's all. Now, you can use CSS modules within your JS app:
 
 ```js
-// React component example
-// app/javascripts/packs/hello_react.jsx
 import React from 'react'
-import ReactDOM from 'react-dom'
-import helloIcon from '../hello_react/images/icon.png'
-import '../hello_react/styles/hello-react.sass'
+import styles from './styles.css'
 
 const Hello = props => (
-  <div className="hello-react">
-    <img src={helloIcon} alt="hello-icon" />
-    <p>Hello {props.name}!</p>
+  <div className={styles.wrapper}>
+    <img src={clockIcon} alt="clock" className={styles.img} />
+    <h5 lassName={styles.name}>
+      {props.message} {props.name}!
+    </h5>
   </div>
 )
 ```
 
-under the hood webpack uses [extract-text-webpack-plugin](https://github.com/webpack-contrib/extract-text-webpack-plugin) plugin to extract all the referenced styles and compile it into a separate `[pack_name].css` bundle so that within your view you can use the `stylesheet_pack_tag` helper,
 
-```erb
-<%= stylesheet_pack_tag 'hello_react' %>
+### CSS-Next
+
+If you want to use [css-next](http://cssnext.io/) inside your app, add postcss
+plugin for `css-next`
+
+```bash
+yarn add postcss-cssnext
+```
+
+and update your `.postcssrc.yml`
+
+```
+plugins:
+  postcss-smart-import: {}
+  cssnext: {}
+```
+
+That's all. Now, you can use latest css features, today.
+
+
+### Ignoring swap files
+
+If you are using vim or emacs and want to ignore certain files you can add `ignore-loader`:
+
+```
+yard add ignore-loader
+```
+
+and create a new loader file inside `config/webpack/loaders`:
+
+```js
+// config/webpack/loaders/ignores.js
+// ignores vue~ swap files
+
+module.exports = {
+  test: /.vue~$/,
+  loader: 'ignore-loader'
+}
 ```
 
-## Getting asset path
+And now all files with `.vue~` will be ignored by the webpack compiler.
+
+
+### Link sprocket assets
+
 
-Webpacker provides `asset_pack_path` helper to get the path of any given asset that's been compiled by webpack.
+#### Using helpers
 
-**For ex,** if you want to create a `<link rel="prefetch">` or `<img />`
-for an asset used in your pack code you can reference them like this in your view,
+It's possible to link to assets that have been precompiled by sprockets. Add the `.erb` extension to your javascript file, then you can use Sprockets' asset helpers:
 
 ```erb
-<%= asset_pack_path 'hello_react.css' %>
-<% # => "/packs/hello_react.css" %>
-<img src="<%= asset_pack_path 'calendar.png' %>" />
-<% # => <img src="/packs/calendar.png" /> %>
+<%# app/javascript/my_pack/example.js.erb %>
+
+<% helpers = ActionController::Base.helpers %>
+var railsImagePath = "<%= helpers.image_path('rails.png') %>"
 ```
 
+This is enabled by the `rails-erb-loader` loader rule in `config/loaders/erb.js`.
+
+
+#### Using babel module resolver
+
+You can also use [babel-plugin-module-resolver](https://github.com/tleunen/babel-plugin-module-resolver) to reference assets directly from `app/assets/**`
+
+```bash
+yarn add babel-plugin-module-resolver
+```
+
+Specify the plugin in your `.babelrc` with the custom root or alias. Here's an example:
+
+```json
+{
+  "plugins": [
+    ["module-resolver", {
+      "root": ["./app"],
+      "alias": {
+        "assets": "./assets"
+      }
+    }]
+  ]
+}
+```
+
+And then within your javascript app code:
+
+```js
+// Note: we don't have do any ../../ jazz
+
+import FooImage from 'assets/images/foo-image.png'
+import 'assets/stylesheets/bar.sass'
+```
+
+## Extending
+
+We suggest you don't directly overwrite the provided configuration files
+and extend instead for smoother upgrades. Here is one way to do it:
+
+Create a `app-config.js` file inside `config/webpack`, and in that add:
+
+```js
+module.exports = {
+  production: {
+    plugins: [
+      // ... Add plugins
+    ]
+  },
+
+  development: {
+    output: {
+      // ... Custom output path
+    }
+  }
+}
+```
+
+```js
+// config/webpack/production.js
+
+const { plugins } = require('./app-config.js')
+
+plugins: appConfig.plugins.concat([
+
+  // ...existing plugins
+
+])
+```
+
+But this could be done million other ways.
+
+
 ## Deployment
 
-Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which gets run whenever you run `assets:precompile`. The `javascript_pack_tag` and `stylesheet_pack_tag` helper method will automatically insert the correct HTML tag for compiled pack. Just like the asset pipeline does it. By default the output will look like this in different environments,
+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 you
+can manually trigger `bundle exec rails webpacker:compile` during your app deploy.
+
+The `javascript_pack_tag` and `stylesheet_pack_tag` helper method will automatically insert the correct HTML tag for compiled pack. Just like the asset pipeline does it.
+
+By default the output will look like this in different environments:
 
 ```html
   <!-- In development mode with webpack-dev-server -->
@@ -187,33 +1043,62 @@ Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which
   <link rel="stylesheet" media="screen" href="/packs/calendar-dc02976b5f94b507e3b6.css">
 ```
 
-## Linking to sprockets assets
 
-It's possible to link to assets that have been precompiled by sprockets. Add the `.erb` extension
-to your javascript file, then you can use Sprockets' asset helpers:
+### Heroku
 
-```
-// app/javascript/my_pack/example.js.erb
+Heroku installs yarn and node by default if you deploy a rails app with
+Webpacker so all you would need to do:
 
-<% helpers = ActionController::Base.helpers %>
-var railsImagePath = "<%= helpers.image_path('rails.png') %>";
+```bash
+heroku create shiny-webpacker-app
+heroku addons:create heroku-postgresql:hobby-dev
+git push heroku master
 ```
 
-This is enabled by the `rails-erb-loader` loader rule in `config/webpack/shared.js`.
 
-## Ready for React
+## Testing
+
+Webpacker lazily compiles assets in test env so you can write your tests without any extra
+setup and everything will just work out of the box.
+
+Here is a sample system test case with hello_react example component:
+
+```js
+// Example react component
+
+import React from 'react'
+import ReactDOM from 'react-dom'
+import PropTypes from 'prop-types'
+
+const Hello = props => (
+  <div>Hello David</div>
+)
 
-To use Webpacker with React, just create a new app with `rails new myapp --webpack=react` (or run `rails webpacker:install:react` on a Rails app already setup with webpacker), and all the relevant dependencies
-will be added via yarn and changes to the configuration files made. Now you can create JSX files and
-have them properly compiled automatically.
+document.addEventListener('DOMContentLoaded', () => {
+  ReactDOM.render(
+    <Hello />,
+    document.body.appendChild(document.createElement('div')),
+  )
+})
+```
 
-## Ready for Angular with TypeScript
+```erb
+# views/pages/home.html.erb
 
-To use Webpacker with Angular, just create a new app with `rails new myapp --webpack=angular` (or run `rails webpacker:install:angular` on a Rails app already setup with webpacker). TypeScript support and the Angular core libraries will be added via yarn and changes to the configuration files made. An example component written in TypeScript is also added to your project in `app/javascript` so that you can experiment Angular right away.
+<%= javascript_pack_tag "hello_react" %>
+```
 
-## Ready for Vue
+```rb
+# Tests example react component
+require "application_system_test_case"
+class HomesTest < ApplicationSystemTestCase
+  test "can see the hello message" do
+    visit root_url
+    assert_selector "h5", text: "Hello! David"
+  end
+end
+```
 
-To use Webpacker with Vue, just create a new app with `rails new myapp --webpack=vue` (or run `rails webpacker:install:vue` on a Rails app already setup with webpacker). Vue and its supported libraries will be added via yarn and changes to the configuration files made. An example component is also added to your project in `app/javascript` so that you can experiment Vue right away.
 
 ## Troubleshooting
 
@@ -226,7 +1111,7 @@ An easy solution is to create a postinstall hook - `npm rebuild node-sass` in
 you install any new modules.
 
 * If you get this error `Can't find hello_react.js in manifest.json`
-when loading a view in browser it's because Webpack is still compiling packs.
+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,
 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.
@@ -234,11 +1119,12 @@ Therefore, make sure webpack
 (i.e `./bin/webpack-dev-server`) is running and has
 completed the compilation successfully before loading a view.
 
+
 ## Wishlist
 
-- Improve process for linking to assets compiled by sprockets - shouldn't need to specify
-` <% helpers = ActionController::Base.helpers %>` at the beginning of each file
-- Consider chunking setup
+- HMR - [#188](https://github.com/rails/webpacker/issues/188)
+- Support rails engines - [#348](https://github.com/rails/webpacker/issues/348)
+
 
 ## License
 Webpacker is released under the [MIT License](https://opensource.org/licenses/MIT).