webpacker 3.0.2 → 3.1.0

data/docs/docker.md

@@ -0,0 +1,49 @@
+# Docker
+
+To setup webpacker with a dockerized Rails application is trivial.
+
+First, add a new service for webpacker in docker-compose.yml:
+
+```Dockerfile
+version: '3'
+services:
+  webpacker:
+    build: .
+    env_file:
+      - '.env.docker'
+    command: bundle exec webpack-dev-server
+    volumes:
+      - .:/webpacker-example-app
+    ports:
+      - '3035:3035'
+```
+
+add nodejs and yarn as dependencies in Dockerfile,
+
+```dockerfile
+FROM ruby:2.4.1
+RUN apt-get update -qq
+
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+RUN curl -sL https://deb.nodesource.com/setup_8.x | bash
+RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
+
+RUN apt-get install -y nodejs
+RUN apt-get update && apt-get install yarn
+
+# Rest of the commands....
+```
+
+and create an env file to load environment variables from:
+
+```env
+NODE_ENV=development
+RAILS_ENV=development
+WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
+```
+
+Lastly, rebuild your container:
+
+```bash
+docker-compose up --build
+```

data/docs/env.md

@@ -2,12 +2,12 @@
 
 
 Environment variables are supported out of the box in Webpacker. For example if
-you run the Webpack dev server like so:
+you run the webpack dev server like so:
 ```
 FOO=hello BAR=world ./bin/webpack-dev-server
 ```
 
-You can then reference these variables in your javascript app code with
+You can then reference these variables in your JavaScript app code with
 `process.env`:
 
 ```js
@@ -18,11 +18,11 @@ You may want to store configuration in environment variables via `.env` files,
 similar to the [dotenv Ruby gem](https://github.com/bkeepers/dotenv).
 
 In development, if you use [Foreman](http://ddollar.github.io/foreman) or [Invoker](http://invoker.codemancers.com)
-to launch the Webpack server, both of these tools have basic support for a
+to launch the webpack server, both of these tools have basic support for a
 `.env` file (Invoker also supports `.env.local`), so no further configuration
 is needed.
 
-However, if you run the Webpack server without Foreman/Invoker, or if you
+However, if you run the webpack server without Foreman/Invoker, or if you
 want more control over what `.env` files to load, you can use the
 [dotenv npm package](https://github.com/motdotla/dotenv). Here is what you could
 do to support a "Ruby-like" dotenv:
@@ -58,7 +58,7 @@ module.exports = environment
 confusing behavior, in that Foreman/Invoker variables take precedence over
 npm dotenv variables.
 
-If you'd like to pass custom variables to the on demand compiler, use `Webpack::Compiler.env` attribute.
+If you'd like to pass custom variables to the on demand compiler, use `Webpacker::Compiler.env` attribute.
 
 ```rb
 Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'

data/docs/folder-structure.md

@@ -1,9 +1,9 @@
 # Folder Structure
 
 
-## Packs a.k.a Webpack entries
+## Packs a.k.a webpack entries
 
-"Packs" is a special directory made only for Webpack entry files so don't put anything
+"Packs" is a special directory made only for webpack entry files so don't put anything
 here that you don't want to link in your views.
 
 

data/docs/testing.md

@@ -28,21 +28,13 @@ Webpacker does not setup `Karma` by default, so you've to manually install it al
 }
 ```
 
-It is beneficial to use the same webpack configuration file (generated by webpacker) in Karma configuration to avoid redundancy. Following line tells Karma not to write transpiled source files onto filesystem while testing to avoid `Error: EACCES: permission denied, mkdir '/_karma_webpack_' ` error.
+It is beneficial to use the same webpack configuration file (generated by webpacker) in Karma configuration to avoid redundancy. Following line tells Karma not to write transpiled source files onto filesystem while testing to avoid `Error: EACCES: permission denied, mkdir '/_karma_webpack_' ` error. Then inject a new rule a.k.a. loader in the existing ones (needed only if you have installed `istanbul-instrumenter-loader`) to generate a coverage report under `/coverage` directory.
 
 ```js
 // config/webpack/test.js
-const { environment } = require('@rails/webpacker')
+const environment = require('./environment')
 environment.plugins.get('Manifest').opts.writeToFileEmit = process.env.NODE_ENV !== 'test'
-module.exports = environment
-```
-
-Finally, update `karma.conf.js` to read the same `test.js` file. Then inject a new rule a.k.a. loader in the existing ones (needed only if you have installed `istanbul-instrumenter-loader`) to generate a coverage report under `/coverage` directory. Rest of the things are mandatory (few marked as optional wherever appropriate).
-
-```js
-// karma.conf.js
-const webpackConfig = require('./config/webpack/test.js')
-webpackConfig.module.rules.push({
+environment.loaders.set('istanbul-instrumenter', {
   test: /\.ts$/,
   enforce: "post",
   loader: "istanbul-instrumenter-loader",
@@ -51,7 +43,14 @@ webpackConfig.module.rules.push({
   },
   exclude: ["node_modules", /\.test\.ts$/]
 }) /* optional */
+module.exports = environment.toWebpackConfig()
+```
+
+Finally, update `karma.conf.js` to read the same `test.js` file mentioned above. Rest of the things are mandatory (few marked as optional wherever appropriate).
 
+```js
+// karma.conf.js
+const webpackConfig = require('./config/webpack/test.js')
 module.exports = function(config) {
   config.set({
     basePath: "",
@@ -65,29 +64,10 @@ module.exports = function(config) {
       "karma-coverage-istanbul-reporter" /* optional */,
       "karma-spec-reporter" /* optional */
     ],
-    files: (function () {
-      let files = [ "/* add spec files */" ]
-      for (let entry in webpackConfig.entry) {
-        files.push({
-          pattern: webpackConfig.entry[entry],
-          watched: true,
-          included: false,
-          served: true
-        })
-      }
-      return files;
-    })(),
+    files: [ "/* add spec files */" ],
     exclude: [],
     webpack: webpackConfig,
-    preprocessors: (function() {
-      let preprocessors = {
-        "/* add spec files */" : ["webpack"]
-      }
-      for (let entry in webpackConfig.entry) {
-        preprocessors[webpackConfig.entry[entry]] = ["webpack"]
-      }
-      return preprocessors;
-    })(),
+    preprocessors: {"/* add spec files */" : ["webpack"]},
     mime: { "text/x-typescript": ["ts"] },
     reporters: ["progress", "coverage-istanbul" /* optional */],
     coverageIstanbulReporter: {
@@ -112,7 +92,7 @@ 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
+// Example React component
 
 import React from 'react'
 import ReactDOM from 'react-dom'
@@ -137,7 +117,7 @@ document.addEventListener('DOMContentLoaded', () => {
 ```
 
 ```rb
-# Tests example react component
+# Tests example React component
 require "application_system_test_case"
 class HomesTest < ApplicationSystemTestCase
   test "can see the hello message" do

data/docs/troubleshooting.md

@@ -15,7 +15,7 @@ you install any new modules.
 ## Can't find hello_react.js in manifest.json
 
 * If you get this error `Can't find hello_react.js in manifest.json`
-when loading a view in the browser it's because Webpack is still compiling packs.
+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.
@@ -48,9 +48,9 @@ bundle config --delete bin
 ```
 
 
-## Running Webpack on Windows
+## Running webpack on Windows
 
-If you are running Webpack on Windows, your command shell may not be able to interpret the preferred interpreter
+If you are running webpack on Windows, your command shell may not be able to interpret the preferred interpreter
 for the scripts generated in `bin/webpack` and `bin/webpack-dev-server`. Instead you'll want to run the scripts
 manually with Ruby:
 
@@ -60,6 +60,42 @@ C:\path>ruby bin\webpack-dev-server
 ```
 
 
-## Invalid configuration object. Webpack has been initialised using a configuration object that does not match the API schema.
+## Invalid configuration object. webpack has been initialised using a configuration object that does not match the API schema.
 
 If you receive this error when running `$ ./bin/webpack-dev-server` ensure your configuration is correct; most likely the path to your "packs" folder is incorrect if you modified from the original "source_path" defined in `config/webpacker.yml`.
+
+## Running Elm on Continuous Integration (CI) services such as CircleCI, CodeShip, Travis CI
+
+If your tests are timing out or erroring on CI it is likely that you are experiencing the slow Elm compilation issue described here: [elm-compiler issue #1473](https://github.com/elm-lang/elm-compiler/issues/1473)
+
+The issue is related to CPU count exposed by the underlying service. The basic solution involves using [libsysconfcpus](https://github.com/obmarg/libsysconfcpus) to change the reported CPU count.
+
+Basic fix involves:
+
+```bash
+# install sysconfcpus on CI
+git clone https://github.com/obmarg/libsysconfcpus.git $HOME/dependencies/libsysconfcpus
+cd libsysconfcpus
+.configure --prefix=$HOME/dependencies/sysconfcpus
+make && make install
+
+# use sysconfcpus with elm-make
+mv $HOME/your_rails_app/node_modules/.bin/elm-make $HOME/your_rails_app/node_modules/.bin/elm-make-old
+printf "#\041/bin/bash\n\necho \"Running elm-make with sysconfcpus -n 2\"\n\n$HOME/dependencies/sysconfcpus/bin/sysconfcpus -n 2 $HOME/your_rails_app/node_modules/.bin/elm-make-old \"\$@\"" > $HOME/your_rails_app/node_modules/.bin/elm-make
+chmod +x $HOME/your_rails_app/node_modules/.bin/elm-make
+```
+
+## Rake assets:precompile fails. ExecJS::RuntimeError
+This error occurs because you are trying to uglify a pack that's already been minified by Webpacker. To avoid this conflict and prevent appearing of ExecJS::RuntimeError error, you will need to disable uglifier from Rails config:
+
+```ruby
+// production.rb
+# From
+
+Rails.application.config.assets.js_compressor = :uglifier
+
+# To
+
+#Rails.application.config.assets.js_compressor = :uglifier
+
+```

data/docs/typescript.md

@@ -3,7 +3,7 @@
 
 ## Typescript with React
 
-1. Setup react using webpacker [react installer](#react). Then add required depedencies
+1. Setup react using Webpacker [react installer](#react). Then add required depedencies
 for using typescript with React:
 
 ```bash
@@ -44,7 +44,7 @@ typescript, JSX with React.
 
 ## HTML templates with Typescript and Angular
 
-After you have installed angular using `bundle exec rails webpacker:install:angular`
+After you have installed Angular using `bundle exec rails webpacker:install:angular`
 you would need to follow these steps to add HTML templates support:
 
 1. Use `yarn` to add html-loader

data/docs/webpack-dev-server.md

@@ -1,4 +1,4 @@
-# Webpack Dev Server
+# webpack-dev-server
 
 
 ## HTTPS
@@ -11,7 +11,7 @@ Please note that the `webpack-dev-server` will use a self-signed certificate,
 so your web browser will display a warning/exception upon accessing the page. If you get
 `https://localhost:3035/sockjs-node/info?t=1503127986584 net::ERR_INSECURE_RESPONSE`
 in your console, simply open the link in your browser and accept the SSL exception.
-Now if you refresh your rails view everything should work as expected.
+Now if you refresh your Rails view everything should work as expected.
 
 
 ## HOT module replacement
@@ -36,10 +36,10 @@ otherwise you will get not found error for stylesheets.
 
 If you use Nginx in development to proxy requests to your Rails server from
 another domain, like `myapp.dev`, the Webpacker middleware will be able to
-forward requests for "packs" to the Webpack dev server.
+forward requests for "packs" to the webpack dev server.
 
 If you're using `inline` mode behing Nginx, you may also need to provide the
-hostname to Webpack dev server so it can initiate the websocket connection for
+hostname to webpack dev server so it can initiate the websocket connection for
 live reloading ([Webpack
 docs](https://webpack.js.org/configuration/dev-server/#devserver-public)).
 
@@ -73,3 +73,20 @@ server {
     # ...
 }
 ```
+
+## Customizing Logging
+
+By default, the dev server will display a colored progress notification while
+your code is being compiled.  (Under the hood, we are using `webpack-dev-server
+--progress --color`).  However, this might cause issues if you don't use
+`foreman` and/or try to log webpack-dev-server's output to a file.  You can
+disable this stylized output by adding `pretty: false` to your `dev_server`
+config:
+
+```yaml
+development:
+  # ...
+  dev_server:
+    # ...
+    pretty: false
+```

data/docs/webpack.md

@@ -1,4 +1,4 @@
-# Webpack
+# webpack
 
 
 ## Configuration
@@ -28,29 +28,36 @@ module.exports = {
   }
 }
 
-// config/webpack/development.js
-const merge = require('webpack-merge')
+// config/webpack/environment.js
 const environment = require('./environment')
 const customConfig = require('./custom')
 
-module.exports = merge(environment.toWebpackConfig(), customConfig)
-```
+// Set nested object prop using path notation
+environment.config.set('resolve.extensions', ['.foo', '.bar'])
+environment.config.set('output.filename', '[name].js')
 
-If you need access to configs within Webpacker's configuration, you can import them like this:
-```js
-const config = require('@rails/webpacker/package/config');
-const asset_host = require('@rails/webpacker/package/asset_host');
+// Merge custom config
+environment.config.merge(customConfig)
+
+// Delete a property
+environment.config.delete('output.chunkFilename')
 
-console.log(asset_host.publicPathWithHost);
+module.exports = environment
 ```
 
-**Note:** You will have to merge custom config to all env where you want that config
-to be available. In above case, it will be applied to development environment.
+If you need access to configs within Webpacker's configuration,
+you can import them like so:
 
+```js
+const { config, asset_host } = require('@rails/webpacker')
+
+console.log(asset_host.publicPathWithHost)
+console.log(config.source_path)
+```
 
 ## Loaders
 
-You can add additional loaders beyond the base set that webpacker provides by
+You can add additional loaders beyond the base set that Webpacker provides by
 adding it to your environment. We'll use `json-loader` as an example:
 
 ```
@@ -61,34 +68,86 @@ yarn add json-loader
 // config/webpack/environment.js
 const { environment } = require('@rails/webpacker')
 
-environment.loaders.set('json', {
+environment.loaders.append('json', {
   test: /\.json$/,
   use: 'json-loader'
 })
 
+// Insert json loader at the top of list
+environment.loaders.prepend('json', jsonLoader)
+
+// Insert json loader after/before a given loader
+environment.loaders.insert('json', jsonLoader, { after: 'style'} )
+environment.loaders.insert('json', jsonLoader, { before: 'babel'} )
+
 module.exports = environment
 ```
 
-Finally add `.json` to the list of extensions in `config/webpacker.yml`. Now if you `import()` any `.json` files inside your javascript
+Finally add `.json` to the list of extensions in `config/webpacker.yml`. Now if you `import()` any `.json` files inside your JavaScript
 they will be processed using `json-loader`. Voila!
 
-You can also modify the loaders that webpacker pre-configures for you. We'll update
+You can also modify the loaders that Webpacker pre-configures for you. We'll update
 the `babel` loader as an example:
 
 ```js
 // config/webpack/environment.js
 const { environment } = require('@rails/webpacker')
 
-// Update an option directly
 const babelLoader = environment.loaders.get('babel')
 babelLoader.options.cacheDirectory = false
 
 module.exports = environment
 ```
 
-### Overriding Loader Options in Webpack 3+ (for CSS Modules etc.)
+### Coffeescript 2
+
+Out of the box webpacker supports coffeescript 1,
+but here is how you can use Coffeescript 2:
+
+```
+yarn add coffeescript@2.0.1
+```
+
+```js
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+
+const babelLoader = environment.loaders.get('babel')
+
+// Replace existing coffee loader with CS2 version
+environment.loaders.insert('coffee', {
+  test: /\.coffee(\.erb)?$/,
+  use:  babelLoader.use.concat(['coffee-loader'])
+})
+
+module.exports = environment
+```
+
+### React SVG loader
+
+To use react svg loader, you should append svg loader before file loader:
+
+```js
+const { environment } = require('@rails/webpacker')
+
+const babelLoader = environment.loaders.get('babel')
 
-In Webpack 3+, if you'd like to specify additional or different options for a loader, edit `config/webpack/environment.js` and provide an options object to override. This is similar to the technique shown above, but the following example shows specifically how to apply CSS Modules, which is what you may be looking for:
+environment.loaders.insert('svg', {
+  test: /\.svg$/,
+  use: babelLoader.use.concat([
+    {
+      loader: 'react-svg-loader',
+      options: {
+        jsx: true // true outputs JSX tags
+      }
+    }
+  ])
+}, { before: 'file' })
+```
+
+### Overriding Loader Options in webpack 3+ (for CSS Modules etc.)
+
+In webpack 3+, if you'd like to specify additional or different options for a loader, edit `config/webpack/environment.js` and provide an options object to override. This is similar to the technique shown above, but the following example shows specifically how to apply CSS Modules, which is what you may be looking for:
 
 ```javascript
 const { environment } = require('@rails/webpacker')
@@ -126,10 +185,11 @@ const { environment } = require('@rails/webpacker')
 const webpack = require('webpack')
 
 // Get a pre-configured plugin
-environment.plugins.get('ExtractText') // Is an ExtractTextPlugin instance
+const manifestPlugin = environment.plugins.get('Manifest')
+manifestPlugin.opts.writeToFileEmit = false
 
 // Add an additional plugin of your choosing : ProvidePlugin
-environment.plugins.set(
+environment.plugins.prepend(
   'Provide',
   new webpack.ProvidePlugin({
     $: 'jquery',
@@ -143,9 +203,27 @@ environment.plugins.set(
   })
 )
 
+// Insert before a given plugin
+environment.plugins.insert('CommonChunkVendor',
+  new webpack.optimize.CommonsChunkPlugin({
+    name: 'vendor', // Vendor code
+    minChunks: (module) => module.context && module.context.indexOf('node_modules') !== -1
+  })
+, { before: 'manifest' })
+
 module.exports = environment
 ```
 
+## Resolved modules
+
+To add new paths to `resolve.modules`, the API is same as loaders and plugins:
+
+```js
+const { environment } = require('@rails/webpacker')
+
+// Resolved modules list API - prepend, append, insert
+environment.resolvedModules.append('vendor', 'vendor')
+```
 
 ### Add common chunks
 
@@ -156,18 +234,18 @@ Add the plugins in `config/webpack/environment.js`:
 ```js
 const webpack = require('webpack')
 
-environment.plugins.set(
+environment.plugins.append(
   'CommonsChunkVendor',
   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;
+      return module.context && module.context.indexOf('node_modules') !== -1
     }
   })
 )
 
-environment.plugins.set(
+environment.plugins.append(
   'CommonsChunkManifest',
   new webpack.optimize.CommonsChunkPlugin({
     name: 'manifest',
@@ -189,4 +267,4 @@ Now, add these files to your `layouts/application.html.erb`:
 <%= stylesheet_pack_tag "vendor" %>
 ```
 
-More detailed guides available here: [Webpack guides](https://webpack.js.org/guides/)
+More detailed guides available here: [webpack guides](https://webpack.js.org/guides/)