webpacker 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c15a75f6c29cc05aae6839309adee7e0db2b51ef63976992e03b1d684e703b70
-  data.tar.gz: c02f95838b9f7ca24c178053eeae3eed75523c72a17276e18a1b0b93b4be90c1
+  metadata.gz: c8a4af458838278327cdb33c8e8823c18b74b3c65346b8c15340cf2c2791d3b9
+  data.tar.gz: 447be8bfef3508fd9fdd7757b8e89c3dd78c09bf0f01b8280dbeb1452ea2cfc8
 SHA512:
-  metadata.gz: 79e537a4b5ef7e67da86b59cf3a74c7182b79cd3787285fe06032b2a2d2c0a5fba8b35961caba36e125ffc65d17641eb331fe2d63baee59724efc9e4c0d849da
-  data.tar.gz: 2905386f28390de59651c450c08cad42bcaadc35e2e59ff92ee7e310c9d85aeadf2a208f4634d29896fb749e4e4a1ac3e4fd28a80905315acd6da0d43067c2d5
+  metadata.gz: f66b910cd05928a6ef6a7fd6ca9832297207dcb4776ef838518f962ebaf82b0b49e9e7e7db26dd6ce7ffd90eca6904cc91efa3619c76014d09bf4e47cb4389a1
+  data.tar.gz: 2779a7c38d3b3130e2c4cd386181d0e2a3b73480cc61d343104ad5a525eb25d79fb1e6b5728c3a51b27acf233b9b7ef08232e56017a47dc04257a85bd6da460d

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 **Please note that Webpacker 3.1.0 and 3.1.1 has some serious bugs so please consider using either 3.0.2 or 3.2.0**
 
+## [3.3.0] - 2018-03-03
+
+### Added
+
+- Separate task for installing/updating binstubs
+- CSS modules support [#1248](https://github.com/rails/webpacker/pull/1248)
+- Pass `relative_url_root` to webpacker config [#1236](https://github.com/rails/webpacker/pull/1236)
+
+### Breaking changes
+
+- Fixes #1281 by installing binstubs only as local executables. To upgrade:
+
+```
+bundle exec rails webpacker:binstubs
+```
+
+### Fixed
+- Limit ts-loader to 3.5.0 until webpack 4 support [#1308](https://github.com/rails/webpacker/pull/1308)
+- Custom env support [#1304](https://github.com/rails/webpacker/pull/1304)
+
 ## [3.2.2] - 2018-02-11
 
 ### Added
@@ -12,7 +32,7 @@ bundle exec rails webpacker:install:stimulus
 
 - Upgrade gems and npm packages [#1254](https://github.com/rails/webpacker/pull/1254)
 
-And, bunch of bug fixes [See changes](https://github.com/rails/webpacker/compare/v3.2.1...3.2.2)
+And, bunch of bug fixes [See changes](https://github.com/rails/webpacker/compare/v3.2.1...v3.2.2)
 
 ## [3.2.1] - 2018-01-21
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpacker (3.2.2)
+    webpacker (3.3.0)
       activesupport (>= 4.2)
       rack-proxy (>= 0.6.1)
       railties (>= 4.2)
@@ -9,39 +9,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.4)
-      actionpack (= 5.1.4)
+    actioncable (5.1.5)
+      actionpack (= 5.1.5)
       nio4r (~> 2.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
+    actionmailer (5.1.5)
+      actionpack (= 5.1.5)
+      actionview (= 5.1.5)
+      activejob (= 5.1.5)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
+    actionpack (5.1.5)
+      actionview (= 5.1.5)
+      activesupport (= 5.1.5)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
+    actionview (5.1.5)
+      activesupport (= 5.1.5)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.4)
-      activesupport (= 5.1.4)
+    activejob (5.1.5)
+      activesupport (= 5.1.5)
       globalid (>= 0.3.6)
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
       arel (~> 8.0)
-    activesupport (5.1.4)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -55,9 +55,9 @@ GEM
     erubi (1.7.0)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (0.9.3)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.1.1)
+    loofah (2.2.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.0)
@@ -70,34 +70,34 @@ GEM
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
+    parser (2.5.0.2)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
     rack (2.0.4)
     rack-proxy (0.6.3)
       rack
-    rack-test (0.8.2)
+    rack-test (0.8.3)
       rack (>= 1.0, < 3)
-    rails (5.1.4)
-      actioncable (= 5.1.4)
-      actionmailer (= 5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      activemodel (= 5.1.4)
-      activerecord (= 5.1.4)
-      activesupport (= 5.1.4)
+    rails (5.1.5)
+      actioncable (= 5.1.5)
+      actionmailer (= 5.1.5)
+      actionpack (= 5.1.5)
+      actionview (= 5.1.5)
+      activejob (= 5.1.5)
+      activemodel (= 5.1.5)
+      activerecord (= 5.1.5)
+      activesupport (= 5.1.5)
       bundler (>= 1.3.0)
-      railties (= 5.1.4)
+      railties (= 5.1.5)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
+    railties (5.1.5)
+      actionpack (= 5.1.5)
+      activesupport (= 5.1.5)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)

data/README.md

@@ -86,7 +86,7 @@ gem 'webpacker', '~> 3.2'
 gem 'webpacker', git: 'https://github.com/rails/webpacker.git'
 ```
 
-and finally, run following to install Webpacker:
+Finally, run following to install Webpacker:
 
 ```bash
 bundle
@@ -99,7 +99,7 @@ bundle exec rake webpacker:install
 
 ### Usage
 
-Once installed you can start writing modern ES6-flavored JavaScript app today:
+Once installed, you can start writing modern ES6-flavored JavaScript apps right away:
 
 ```yml
 app/javascript:
@@ -112,8 +112,8 @@ app/javascript:
       └── logo.svg
 ```
 
-You can then link the JavaScript pack in Rails view using `javascript_pack_tag` helper.
-If you have styles imported in your pack file, you can link using `stylesheet_pack_tag`:
+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`:
 
 ```erb
 <%= javascript_pack_tag 'application' %>
@@ -121,7 +121,7 @@ If you have styles imported in your pack file, you can link using `stylesheet_pa
 ```
 
 If you want to link a static asset for `<link rel="prefetch">` or `<img />` tag, you
-can use `asset_pack_path` helper:
+can use the `asset_pack_path` helper:
 
 ```erb
 <link rel="prefetch" href="<%= asset_pack_path 'application.css' %>" />
@@ -136,16 +136,16 @@ you would need to link them in your "pack" or entry file.
 
 Webpacker ships with two binstubs: `./bin/webpack` and `./bin/webpack-dev-server`.
 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.
+executables to ensure that the right configuration files and environmental variables
+are loaded based on your environment.
 
 In development, Webpacker compiles on demand rather than upfront by default. This
 happens when you refer to any of the pack assets using the Webpacker helper methods.
-That means you don't have to run any separate process. Compilation errors are logged
+This means that you don't have to run any separate processes. Compilation errors are logged
 to the standard Rails log.
 
-If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server` if on windows,
-in a separate terminal from `bundle exec rails s`. This process will watch for changes
+If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server`. Windows users will need to run these commands
+in a terminal separate from `bundle exec rails s`. This process will watch for changes
 in the `app/javascript/packs/*.js` files and automatically reload the browser to match.
 
 ```bash
@@ -160,35 +160,35 @@ in the `app/javascript/packs/*.js` files and automatically reload the browser to
 ```
 
 Once you start this development server, Webpacker will automatically start proxying all
-webpack asset requests to this server. When you stop the server, it'll revert to
-on-demand compilation again.
+webpack asset requests to this server. When you stop the server, it'll revert back to
+on-demand compilation.
 
 You can use environment variables as options supported by
 [webpack-dev-server](https://webpack.js.org/configuration/dev-server/) in the
-form `WEBPACKER_DEV_SERVER_<OPTION>`. Please note that these environment
+form `WEBPACKER_DEV_SERVER_<OPTION>`. Please note that these environmental
 variables will always take precedence over the ones already set in the
-configuration file, and that the _same_ environment variables must
+configuration file, and that the _same_ environmental variables must
 be available to the `rails server` process.
 
 ```bash
 WEBPACKER_DEV_SERVER_HOST=example.com WEBPACKER_DEV_SERVER_INLINE=true WEBPACKER_DEV_SERVER_HOT=false ./bin/webpack-dev-server
 ```
 
-By default, webpack dev server listens on `localhost` in development for security
-but if you want your app to be available over local LAN IP or VM instance like vagrant
+By default, the webpack dev server listens on `localhost` in development for security purposes.
+However, if you want your app to be available over local LAN IP or a VM instance like vagrant,
 you can set the `host` when running `./bin/webpack-dev-server` binstub:
 
 ```bash
 WEBPACKER_DEV_SERVER_HOST=0.0.0.0 ./bin/webpack-dev-server
 ```
 
-**Note:** You need to allow webpack-dev-server host as allowed origin for `connect-src` if you are running your application in a restrict CSP environment like Rails 5.2+. This can be done in Rails 5.2+ for development environment in the CSP initializer `config/initializers/content_security_policy.rb` with a snippet like this:
+**Note:** You need to allow webpack-dev-server host as an allowed origin for `connect-src` if you are running your application in a restrict CSP environment (like Rails 5.2+). This can be done in Rails 5.2+ in the CSP initializer `config/initializers/content_security_policy.rb` with a snippet like this:
 
 ```ruby
   p.connect_src :self, :https, 'http://localhost:3035', 'ws://localhost:3035' if Rails.env.development?
 ```
 
-**Note:** Don't forget to prefix `ruby` when running these binstubs on windows
+**Note:** Don't forget to prefix `ruby` when running these binstubs on Windows
 
 ### webpack configuration
 
@@ -197,7 +197,7 @@ See [docs/webpack](docs/webpack.md) for modifying webpack configuration and load
 
 ### Upgrading
 
-You can run following commands to upgrade Webpacker to the latest stable version, this involves upgrading the gem and related npm modules:
+You can run following commands to upgrade Webpacker to the latest stable version. This process involves upgrading the gem and related npm modules:
 
 ```bash
 bundle update webpacker
@@ -207,15 +207,15 @@ yarn upgrade webpack-dev-server --latest
 
 ### Yarn Integrity
 
-By default in development, webpacker runs a yarn integrity check to ensure that all local npm 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 and you will be asked to upgrade your local npm packages by running `yarn install`.
+By default, in development, webpacker runs a yarn integrity check to ensure that all local npm 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 npm packages by running `yarn install`.
 
-To turn off this option, you will need to override the default by adding a new config options to your Rails development environment configuration file (`config/environment/development.rb`):
+To turn off this option, you will need to override the default by adding a new config option to your Rails development environment configuration file (`config/environment/development.rb`):
 
 ```
 config.webpacker.check_yarn_integrity = false
 ```
 
-You may also turn on this option by adding the config option to any Rails environment configuration file:
+You may also turn on this feature by adding the config option to any Rails environment configuration file:
 
 ```
 config.webpacker.check_yarn_integrity = true
@@ -239,8 +239,8 @@ rails new myapp --webpack=react
 (or run `bundle exec 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
+The installer will add all relevant dependencies using Yarn, 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.
 
 
@@ -257,19 +257,19 @@ rails new myapp --webpack=angular
 (or run `bundle exec 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
+The installer will add the TypeScript and Angular core libraries using Yarn alongside
+a few changes to the configuration files. An example component written in
 TypeScript will also be added to your project in `app/javascript` so that
 you can experiment with Angular right away.
 
-By default Angular uses a JIT compiler for development environment, this
+By default, Angular uses a JIT compiler for development environment. This
 compiler is not compatible with restrictive CSP (Content Security
 Policy) environments like Rails 5.2+. You can use Angular AOT compiler
 in development with the [@ngtools/webpack](https://www.npmjs.com/package/@ngtools/webpack#usage) plugin.
 
-Alternatively if you're using Rails 5.2+ you can enable `unsafe-eval` rule for
-development environment, this can be done in the `config/initializers/content_security_policy.rb`
-with the following configuration:
+Alternatively if you're using Rails 5.2+ you can enable `unsafe-eval` rule for your
+development environment. This can be done in the `config/initializers/content_security_policy.rb`
+with the following code:
 
 ```ruby
   if Rails.env.development?
@@ -291,13 +291,12 @@ rails new myapp --webpack=vue
 ```
 (or run `bundle exec 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.
+The installer will add Vue and its required libraries using Yarn alongside
+automatically applying changes needed to the configuration files. An example component will
+be added to your project in `app/javascript` so that you can experiment with Vue right away.
 
-If you're using Rails 5.2+ you need to enable `unsafe-eval` rule for development environment,
-this can be done in the `config/initializers/content_security_policy.rb` with the following
+If you're using Rails 5.2+ you'll need to enable `unsafe-eval` rule for your development environment.
+This can be done in the `config/initializers/content_security_policy.rb` with the following
 configuration:
 
 ```ruby
@@ -322,7 +321,7 @@ rails new myapp --webpack=elm
 
 (or run `bundle exec 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.
+The Elm library and its core packages will be added via Yarn and Elm.
 An example `Main.elm` app will also be added to your project in `app/javascript`
 so that you can experiment with Elm right away.
 
@@ -356,15 +355,15 @@ run `bundle exec rails webpacker:install:erb` on a Rails app already
 setup with Webpacker.
 
 An example `hello_erb.js.erb` file will also be added to your project
-in `app/javascript/packs` so that you can experiment with Erb flavoured
+in `app/javascript/packs` so that you can experiment with Erb-flavoured
 javascript right away.
 
 
 ## 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.
+app files and compiled webpack bundles will go in your Rails app.
+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)**
@@ -399,16 +398,16 @@ If you have `hmr` turned to true, then the `stylesheet_pack_tag` generates no ou
 ### Resolved
 
 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 then you can use `resolved_paths`
-option available in `config/webpacker.yml`, which lets you
-add additional paths webpack should lookup when resolving modules:
+`app/assets` or inside an engine, and you want to share that
+with webpack modules, you can use the `resolved_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']
 ```
 
-You can then import them inside your modules like so:
+You can then import these items inside your modules like so:
 
 ```js
 // Note it's relative to parent directory i.e. app/assets
@@ -423,9 +422,9 @@ 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
-tracked paths. You can configure the paths tracked
-by adding new paths to `watched_paths` array, much like Rails `autoload_paths`:
+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
@@ -436,7 +435,7 @@ 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`. Remember to set NODE_ENV environment variable to production during deployment or when running the rake task.
+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`. Remember to set NODE_ENV environment variable to production during deployment or when running this rake task.
 
 ## Docs
 

data/docs/css.md

@@ -4,7 +4,7 @@
 Webpacker supports importing CSS, Sass and SCSS files directly into your JavaScript files.
 
 
-## Import styles into your JS app
+## Import global styles into your JS app
 
 ```sass
 // app/javascript/hello_react/styles/hello-react.sass
@@ -30,6 +30,36 @@ const Hello = props => (
 )
 ```
 
+## Import scoped styles into your JS app
+
+Stylesheets end with `.module.*` is treated as [CSS Modules](https://github.com/css-modules/css-modules).
+
+```sass
+// app/javascript/hello_react/styles/hello-react.module.sass
+
+.helloReact
+  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 styles from '../hello_react/styles/hello-react'
+
+const Hello = props => (
+  <div className={styles.helloReact}>
+    <img src={helloIcon} alt="hello-icon" />
+    <p>Hello {props.name}!</p>
+  </div>
+)
+```
+
+**Note:** Declared class is referenced as object property in JavaScript.
+
 
 ## Link styles from your Rails views