webpacker 5.4.0 → 6.0.0.rc.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.eslintrc.js +1 -1
- data/.github/workflows/jest.yml +7 -15
- data/.github/workflows/js-lint.yml +7 -15
- data/.github/workflows/rubocop.yml +1 -1
- data/.github/workflows/ruby.yml +18 -36
- data/.gitignore +2 -0
- data/.node-version +1 -1
- data/.rubocop.yml +5 -4
- data/CHANGELOG.md +45 -9
- data/CONTRIBUTING.md +20 -1
- data/Gemfile.lock +83 -83
- data/README.md +394 -180
- data/config/README.md +3 -0
- data/config/webpacker.yml +1 -0
- data/docs/deployment.md +9 -11
- data/docs/developing_webpacker.md +29 -0
- data/docs/troubleshooting.md +61 -25
- data/docs/v6_upgrade.md +113 -0
- data/gemfiles/Gemfile-rails-edge +1 -1
- data/gemfiles/Gemfile-rails.6.1.x +12 -0
- data/lib/install/{javascript/packs/application.js → application.js} +2 -5
- data/lib/install/bin/webpack +4 -7
- data/lib/install/bin/yarn +18 -0
- data/lib/install/config/webpack/base.js +3 -0
- data/lib/install/config/webpack/development.js +2 -2
- data/lib/install/config/webpack/production.js +2 -2
- data/lib/install/config/webpack/test.js +2 -2
- data/lib/install/config/webpacker.yml +21 -49
- data/lib/install/package.json +15 -0
- data/lib/install/template.rb +63 -28
- data/lib/tasks/webpacker/binstubs.rake +6 -4
- data/lib/tasks/webpacker/check_binstubs.rake +4 -4
- data/lib/tasks/webpacker/check_node.rake +3 -0
- data/lib/tasks/webpacker/check_yarn.rake +4 -1
- data/lib/tasks/webpacker/clobber.rake +1 -1
- data/lib/tasks/webpacker/compile.rake +4 -2
- data/lib/tasks/webpacker/info.rake +12 -10
- data/lib/tasks/webpacker/install.rake +6 -4
- data/lib/tasks/webpacker/verify_config.rake +14 -0
- data/lib/tasks/webpacker/verify_install.rake +1 -10
- data/lib/tasks/webpacker/yarn_install.rake +9 -7
- data/lib/tasks/webpacker.rake +2 -11
- data/lib/tasks/yarn.rake +38 -0
- data/lib/webpacker/commands.rb +21 -16
- data/lib/webpacker/compiler.rb +16 -9
- data/lib/webpacker/configuration.rb +8 -32
- data/lib/webpacker/dev_server.rb +6 -0
- data/lib/webpacker/dev_server_runner.rb +28 -4
- data/lib/webpacker/helper.rb +47 -81
- data/lib/webpacker/instance.rb +4 -0
- data/lib/webpacker/manifest.rb +2 -3
- data/lib/webpacker/railtie.rb +8 -2
- data/lib/webpacker/runner.rb +1 -1
- data/lib/webpacker/version.rb +1 -1
- data/lib/webpacker/webpack_runner.rb +29 -3
- data/lib/webpacker.rb +1 -1
- data/package/__tests__/config.js +5 -37
- data/package/__tests__/development.js +13 -21
- data/package/__tests__/env.js +16 -4
- data/package/__tests__/index.js +9 -0
- data/package/__tests__/production.js +6 -6
- data/package/__tests__/staging.js +7 -6
- data/package/__tests__/test.js +4 -5
- data/package/babel/preset.js +54 -0
- data/package/config.js +6 -14
- data/package/env.js +13 -4
- data/package/environments/__tests__/base.js +20 -52
- data/package/environments/base.js +68 -128
- data/package/environments/development.js +49 -47
- data/package/environments/production.js +66 -64
- data/package/environments/test.js +2 -2
- data/package/index.js +15 -8
- data/package/inliningCss.js +7 -0
- data/package/rules/babel.js +10 -8
- data/package/rules/coffee.js +6 -0
- data/package/rules/erb.js +15 -0
- data/package/rules/file.js +21 -19
- data/package/rules/index.js +16 -18
- data/package/rules/less.js +22 -0
- data/package/rules/raw.js +5 -0
- data/package/rules/sass.js +9 -10
- data/package/rules/stylus.js +26 -0
- data/package/utils/get_style_rule.js +28 -36
- data/package/utils/helpers.js +28 -35
- data/package.json +23 -43
- data/test/command_test.rb +76 -0
- data/test/compiler_test.rb +0 -12
- data/test/configuration_test.rb +4 -35
- data/test/dev_server_runner_test.rb +36 -6
- data/test/engine_rake_tasks_test.rb +39 -0
- data/test/helper_test.rb +76 -62
- data/test/manifest_test.rb +16 -0
- data/test/mounted_app/Rakefile +4 -0
- data/test/mounted_app/test/dummy/Rakefile +3 -0
- data/test/mounted_app/test/dummy/bin/rails +3 -0
- data/test/mounted_app/test/dummy/bin/rake +3 -0
- data/test/mounted_app/test/dummy/config/application.rb +10 -0
- data/test/mounted_app/test/dummy/config/environment.rb +3 -0
- data/test/mounted_app/test/dummy/config/webpacker.yml +75 -0
- data/test/mounted_app/test/dummy/config.ru +5 -0
- data/test/mounted_app/test/dummy/package.json +7 -0
- data/test/rake_tasks_test.rb +1 -10
- data/test/test_app/app/{javascript/packs → packs/entrypoints}/application.js +1 -1
- data/test/test_app/config/initializers/inspect_autoload_paths.rb +1 -0
- data/test/test_app/config/webpacker.yml +5 -31
- data/test/test_app/config/webpacker_other_location.yml +79 -0
- data/test/test_app/config/webpacker_public_root.yml +0 -1
- data/test/test_app/public/packs/manifest.json +36 -18
- data/test/test_app/some.config.js +0 -0
- data/test/webpack_runner_test.rb +9 -3
- data/test/webpacker_test.rb +21 -0
- data/webpacker.gemspec +2 -2
- data/yarn.lock +2183 -6524
- metadata +63 -93
- data/.travis.yml +0 -43
- data/docs/assets.md +0 -119
- data/docs/cloud9.md +0 -310
- data/docs/css.md +0 -308
- data/docs/docker.md +0 -68
- data/docs/engines.md +0 -213
- data/docs/env.md +0 -63
- data/docs/es6.md +0 -72
- data/docs/folder-structure.md +0 -66
- data/docs/integrations.md +0 -220
- data/docs/misc.md +0 -23
- data/docs/props.md +0 -223
- data/docs/target.md +0 -22
- data/docs/testing.md +0 -136
- data/docs/typescript.md +0 -190
- data/docs/v4-upgrade.md +0 -142
- data/docs/webpack-dev-server.md +0 -92
- data/docs/webpack.md +0 -364
- data/docs/yarn.md +0 -23
- data/lib/install/angular.rb +0 -23
- data/lib/install/coffee.rb +0 -25
- data/lib/install/config/.browserslistrc +0 -1
- data/lib/install/config/babel.config.js +0 -70
- data/lib/install/config/postcss.config.js +0 -12
- data/lib/install/config/webpack/environment.js +0 -3
- data/lib/install/elm.rb +0 -39
- data/lib/install/erb.rb +0 -25
- data/lib/install/examples/angular/hello_angular/app/app.component.ts +0 -9
- data/lib/install/examples/angular/hello_angular/app/app.module.ts +0 -16
- data/lib/install/examples/angular/hello_angular/index.ts +0 -8
- data/lib/install/examples/angular/hello_angular/polyfills.ts +0 -73
- data/lib/install/examples/angular/hello_angular.js +0 -7
- data/lib/install/examples/coffee/hello_coffee.coffee +0 -4
- data/lib/install/examples/elm/Main.elm +0 -55
- data/lib/install/examples/elm/hello_elm.js +0 -16
- data/lib/install/examples/erb/hello_erb.js.erb +0 -6
- data/lib/install/examples/react/babel.config.js +0 -87
- data/lib/install/examples/react/hello_react.jsx +0 -26
- data/lib/install/examples/react/tsconfig.json +0 -21
- data/lib/install/examples/stimulus/application.js +0 -1
- data/lib/install/examples/stimulus/controllers/hello_controller.js +0 -18
- data/lib/install/examples/stimulus/controllers/index.js +0 -9
- data/lib/install/examples/svelte/app.svelte +0 -11
- data/lib/install/examples/svelte/hello_svelte.js +0 -20
- data/lib/install/examples/typescript/hello_typescript.ts +0 -4
- data/lib/install/examples/typescript/tsconfig.json +0 -24
- data/lib/install/examples/vue/app.vue +0 -22
- data/lib/install/examples/vue/hello_vue.js +0 -72
- data/lib/install/loaders/coffee.js +0 -6
- data/lib/install/loaders/elm.js +0 -25
- data/lib/install/loaders/erb.js +0 -11
- data/lib/install/loaders/svelte.js +0 -9
- data/lib/install/loaders/vue.js +0 -6
- data/lib/install/react.rb +0 -18
- data/lib/install/stimulus.rb +0 -12
- data/lib/install/svelte.rb +0 -29
- data/lib/install/typescript.rb +0 -39
- data/lib/install/vue.rb +0 -49
- data/lib/tasks/installers.rake +0 -42
- data/package/config_types/__tests__/config_list.js +0 -118
- data/package/config_types/__tests__/config_object.js +0 -43
- data/package/config_types/config_list.js +0 -75
- data/package/config_types/config_object.js +0 -55
- data/package/config_types/index.js +0 -7
- data/package/rules/module.css.js +0 -3
- data/package/rules/module.sass.js +0 -8
- data/package/rules/node_modules.js +0 -22
- data/package/utils/__tests__/deep_assign.js +0 -32
- data/package/utils/__tests__/deep_merge.js +0 -10
- data/package/utils/__tests__/get_style_rule.js +0 -65
- data/package/utils/__tests__/objectify.js +0 -9
- data/package/utils/deep_assign.js +0 -22
- data/package/utils/deep_merge.js +0 -22
- data/package/utils/objectify.js +0 -3
- /data/test/test_app/app/{javascript/packs → packs/entrypoints}/multi_entry.css +0 -0
- /data/test/test_app/app/{javascript/packs → packs/entrypoints}/multi_entry.js +0 -0
data/docs/v4-upgrade.md
DELETED
@@ -1,142 +0,0 @@
|
|
1
|
-
# Webpacker Upgrade Guide
|
2
|
-
|
3
|
-
|
4
|
-
To update a Webpacker v3.5 app to v4, follow these steps:
|
5
|
-
|
6
|
-
1. Update the `webpacker` gem and the `@rails/webpacker` package to v4. This will upgrade Webpack itself from 3.x to 4.x, make sure you're aware of [any deprecations which might effect you](https://webpack.js.org/migrate/4/). Also make sure any other packages you depend on support Webpack 4 and don't require any changes, e.g. if you explicitly include `webpack` you need to upgrade it to 4.x, and if you use `webpack-dev-server` you need to upgrade it to 3.x.
|
7
|
-
|
8
|
-
2. Browser support definitions have been moved from [`.browserslistrc`](../lib/install/config/.browserslistrc) to `/`.
|
9
|
-
|
10
|
-
3. Merge any differences between [`config/webpacker.yml`](../lib/install/config/webpacker.yml) and your `config/webpacker.yml`.
|
11
|
-
|
12
|
-
4. Webpacker v4 upgrades Babel to [v7](https://babeljs.io/docs/en/v7-migration), see also [the release blog post](https://babeljs.io/blog/2018/08/27/7.0.0). Many packages were moved to the `@babel/` namespace, any babel plugins you have will need to be updated. It may be worth checking out [babel-upgrade](https://github.com/babel/babel-upgrade) if you have problems. ([#1564](https://github.com/rails/webpacker/pull/1564))
|
13
|
-
|
14
|
-
5. `.babelrc` should be replaced with `babel.config.js` and `.postcssrc.yml` should be replaced with `postcss.config.js` ([#1822](https://github.com/rails/webpacker/pull/1822)). If you never changed these files from their defaults, the versions of [babel.config.js](../lib/install/config/babel.config.js) and [postcss.config.js](../lib/install/config/postcss.config.js) in the webpacker repository should be usable.
|
15
|
-
|
16
|
-
6. Due to the change in [#1625](https://github.com/rails/webpacker/pull/1625), you'll want to make sure that `extract_css` is set to true for the `default` environment in `webpacker.yml` if you want to have Webpacker supply your CSS.
|
17
|
-
|
18
|
-
## SplitChunks Configuration
|
19
|
-
|
20
|
-
If you used the `CommonsChunkPlugin` you'll need to upgrade to using the new `splitChunks`.
|
21
|
-
|
22
|
-
Originally, chunks (and modules imported inside them) were connected by a parent-child relationship in the internal Webpack graph. The `CommonsChunkPlugin` was used to avoid duplicated dependencies across them, but further optimizations were not possible.
|
23
|
-
|
24
|
-
In Webpack v4, the `CommonsChunkPlugin` was removed in favor of `optimization.splitChunks`.
|
25
|
-
|
26
|
-
For the full configuration options of `splitChunks`, see the [Webpack documentation](https://webpack.js.org/plugins/split-chunks-plugin/).
|
27
|
-
|
28
|
-
```js
|
29
|
-
// config/webpack/environment.js
|
30
|
-
const WebpackAssetsManifest = require('webpack-assets-manifest');
|
31
|
-
|
32
|
-
// Enable the default config
|
33
|
-
environment.splitChunks()
|
34
|
-
|
35
|
-
// or using custom config
|
36
|
-
environment.splitChunks((config) => Object.assign({}, config, { optimization: { splitChunks: false }}))
|
37
|
-
```
|
38
|
-
|
39
|
-
Then use the `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` helpers to include all the transpiled
|
40
|
-
packs with the chunks in your view, which creates html tags for all the chunks.
|
41
|
-
|
42
|
-
```erb
|
43
|
-
<%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %>
|
44
|
-
|
45
|
-
<!-- Creates the following: -->
|
46
|
-
<script src="/packs/vendor-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
47
|
-
<script src="/packs/calendar~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
48
|
-
<script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
49
|
-
<script src="/packs/map~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
50
|
-
<script src="/packs/map-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
51
|
-
```
|
52
|
-
|
53
|
-
**Important:** Pass all your pack names to the helper otherwise you will get duplicated chunks on the page.
|
54
|
-
|
55
|
-
```erb
|
56
|
-
<%# DO %>
|
57
|
-
<%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
|
58
|
-
|
59
|
-
<%# DON'T %>
|
60
|
-
<%= javascript_packs_with_chunks_tag 'calendar' %>
|
61
|
-
<%= javascript_packs_with_chunks_tag 'map' %>
|
62
|
-
```
|
63
|
-
|
64
|
-
## Package-Specific Notes
|
65
|
-
|
66
|
-
- If you're using React, you need to add `"@babel/preset-react"`, to the list of `presets` in your babel config.
|
67
|
-
- If you're using Vue Loader, you'll need to upgrade to [v15](https://vue-loader.vuejs.org/migrating.html) for Webpack 4.
|
68
|
-
- To see what Webpacker generates for a given framework with v4, you may want to re-run `bundle exec rake webpacker:install:FRAMEWORK` and let it override the files for your given JavaScript framework, and then compare them to see what changes you'll need to make.
|
69
|
-
|
70
|
-
## Excluding node_modules From Being Transpiled By Babel-Loader
|
71
|
-
|
72
|
-
One change to take into consideration, is that Webpacker 4 transpiles the
|
73
|
-
`node_modules` folder with the `babel-loader`. This folder used to be ignored by
|
74
|
-
Webpacker 3. The new behavior helps in case some library contains ES6 code, but in
|
75
|
-
some cases it can lead to issues. To avoid running `babel-loader` in the
|
76
|
-
`node_modules` folder, replicating the same behavior as Webpacker 3, the
|
77
|
-
following code can be added to `config/webpack/environment.js`:
|
78
|
-
|
79
|
-
```javascript
|
80
|
-
environment.loaders.delete('nodeModules')
|
81
|
-
```
|
82
|
-
|
83
|
-
Alternatively, in order to skip only a specific library in the `node_modules`
|
84
|
-
folder, this code can be added:
|
85
|
-
|
86
|
-
```javascript
|
87
|
-
const nodeModulesLoader = environment.loaders.get('nodeModules')
|
88
|
-
if (!Array.isArray(nodeModulesLoader.exclude)) {
|
89
|
-
nodeModulesLoader.exclude = (nodeModulesLoader.exclude == null)
|
90
|
-
? []
|
91
|
-
: [nodeModulesLoader.exclude]
|
92
|
-
}
|
93
|
-
nodeModulesLoader.exclude.push(/some-library/) // replace `some-library` with
|
94
|
-
// the actual path to exclude
|
95
|
-
```
|
96
|
-
|
97
|
-
## Source Maps Enabled By Default
|
98
|
-
|
99
|
-
Source maps are now enabled in production to make debugging in production easier. Enabling source maps doesn't have drawbacks for most of the applications since maps are compressed by default and aren't loaded by browsers unless Dev Tools are opened.
|
100
|
-
|
101
|
-
If you want to keep the old behavior source maps can be disabled in any environment configuration, e.g:
|
102
|
-
|
103
|
-
```js
|
104
|
-
// config/webpack/production.js
|
105
|
-
|
106
|
-
const environment = require('./environment')
|
107
|
-
environment.config.merge({ devtool: false })
|
108
|
-
|
109
|
-
module.exports = environment.toWebpackConfig()
|
110
|
-
```
|
111
|
-
|
112
|
-
## Namespaces
|
113
|
-
|
114
|
-
The compiled packs in the public directory are now stored under namespaces:
|
115
|
-
|
116
|
-
- JavaScripts are stored under `js`
|
117
|
-
- Stylesheets are stored under `css`
|
118
|
-
- Other resources are stored under `media`
|
119
|
-
|
120
|
-
```rb
|
121
|
-
# Before
|
122
|
-
"runtime~hello_react" => "/packs/runtime~hello_react-da2baf7fd07b0e8b6d17.js"
|
123
|
-
|
124
|
-
# After
|
125
|
-
"runtime~hello_react" => "/packs/js/runtime~hello_react-da2baf7fd07b0e8b6d17.js"
|
126
|
-
```
|
127
|
-
|
128
|
-
## Upgrading projects with custom Webpack setups that use only the view helpers
|
129
|
-
The default value for `extract_css` is **false** in `config/webpack.yml`. Custom webpack builds that extract the CSS such as often used with [React on Rails](https://github.com/shakacode/react_on_rails) should set this value to true or else no CSS link tags are generated.
|
130
|
-
|
131
|
-
```yml
|
132
|
-
default: &default
|
133
|
-
# other stuff
|
134
|
-
extract_css: true
|
135
|
-
# by default, extract and emit a css file. The default is false
|
136
|
-
```
|
137
|
-
|
138
|
-
## Example Upgrades
|
139
|
-
|
140
|
-
This is what an upgrade to Webpacker 4 looked like for existing Rails apps (please contribute yours!):
|
141
|
-
|
142
|
-
- https://github.com/connorshea/ContinueFromCheckpoint/pull/77
|
data/docs/webpack-dev-server.md
DELETED
@@ -1,92 +0,0 @@
|
|
1
|
-
# webpack-dev-server
|
2
|
-
|
3
|
-
|
4
|
-
## HTTPS
|
5
|
-
|
6
|
-
If you're using the `webpack-dev-server` in development, you can serve your packs over HTTPS
|
7
|
-
by setting the `https` option for `webpack-dev-server` to `true` in `config/webpacker.yml`,
|
8
|
-
then start the dev server as usual with `./bin/webpack-dev-server`.
|
9
|
-
|
10
|
-
Please note that the `webpack-dev-server` will use a self-signed certificate,
|
11
|
-
so your web browser will display a warning/exception upon accessing the page. If you get
|
12
|
-
`https://localhost:3035/sockjs-node/info?t=1503127986584 net::ERR_INSECURE_RESPONSE`
|
13
|
-
in your console, simply open the link in your browser and accept the SSL exception.
|
14
|
-
Now if you refresh your Rails view everything should work as expected.
|
15
|
-
|
16
|
-
|
17
|
-
## HOT module replacement
|
18
|
-
|
19
|
-
Webpacker out-of-the-box supports HMR with `webpack-dev-server` and
|
20
|
-
you can toggle it by setting `dev_server/hmr` option inside `webpacker.yml`.
|
21
|
-
|
22
|
-
Check out this guide for more information:
|
23
|
-
|
24
|
-
- https://webpack.js.org/configuration/dev-server/#devserver-hot
|
25
|
-
|
26
|
-
To support HMR with React you would need to add `react-hot-loader`. Checkout this guide for
|
27
|
-
more information:
|
28
|
-
|
29
|
-
- https://gaearon.github.io/react-hot-loader/getstarted/
|
30
|
-
|
31
|
-
**Note:** Don't forget to disable `HMR` if you are not running `webpack-dev-server`
|
32
|
-
otherwise you will get not found error for stylesheets.
|
33
|
-
|
34
|
-
|
35
|
-
## Nginx
|
36
|
-
|
37
|
-
If you use Nginx in development to proxy requests to your Rails server from
|
38
|
-
another domain, like `myapp.dev`, the Webpacker middleware will be able to
|
39
|
-
forward requests for "packs" to the webpack dev server.
|
40
|
-
|
41
|
-
If you're using `inline` mode behind Nginx, you may also need to provide the
|
42
|
-
hostname to webpack dev server so it can initiate the websocket connection for
|
43
|
-
live reloading ([Webpack
|
44
|
-
docs](https://webpack.js.org/configuration/dev-server/#devserver-public)).
|
45
|
-
|
46
|
-
To do so, set the `public` option in `config/webpacker.yml`:
|
47
|
-
|
48
|
-
```yaml
|
49
|
-
development:
|
50
|
-
# ...
|
51
|
-
dev_server:
|
52
|
-
# ...
|
53
|
-
public: myapp.dev
|
54
|
-
```
|
55
|
-
|
56
|
-
You may also need to add the following location block to your local Nginx server
|
57
|
-
configuration for your Rails app.
|
58
|
-
|
59
|
-
```
|
60
|
-
server {
|
61
|
-
listen 80;
|
62
|
-
server_name myapp.dev
|
63
|
-
|
64
|
-
# Proxy webpack dev server websocket requests
|
65
|
-
location /sockjs-node {
|
66
|
-
proxy_redirect off;
|
67
|
-
proxy_http_version 1.1;
|
68
|
-
proxy_set_header Upgrade $http_upgrade;
|
69
|
-
proxy_set_header Connection "upgrade";
|
70
|
-
proxy_pass http://127.0.0.1:3035; # change to match your webpack-dev-server host
|
71
|
-
}
|
72
|
-
|
73
|
-
# ...
|
74
|
-
}
|
75
|
-
```
|
76
|
-
|
77
|
-
## Customizing Logging
|
78
|
-
|
79
|
-
By default, the dev server will display a colored progress notification while
|
80
|
-
your code is being compiled. (Under the hood, we are using `webpack-dev-server
|
81
|
-
--progress --color`). However, this might cause issues if you don't use
|
82
|
-
`foreman` and/or try to log webpack-dev-server's output to a file. You can
|
83
|
-
disable this stylized output by adding `pretty: false` to your `dev_server`
|
84
|
-
config:
|
85
|
-
|
86
|
-
```yaml
|
87
|
-
development:
|
88
|
-
# ...
|
89
|
-
dev_server:
|
90
|
-
# ...
|
91
|
-
pretty: false
|
92
|
-
```
|
data/docs/webpack.md
DELETED
@@ -1,364 +0,0 @@
|
|
1
|
-
# webpack
|
2
|
-
|
3
|
-
|
4
|
-
## Configuration
|
5
|
-
|
6
|
-
Webpacker gives you a default set of configuration files for test, development and
|
7
|
-
production environments in `config/webpack/*.js`. You can configure each individual
|
8
|
-
environment in their respective files or configure them all in the base
|
9
|
-
`config/webpack/environment.js` file.
|
10
|
-
|
11
|
-
By default, you don't need to make any changes to `config/webpack/*.js`
|
12
|
-
files since it's all standard production-ready configuration. However,
|
13
|
-
if you do need to customize or add a new loader, this is where you would go.
|
14
|
-
|
15
|
-
Here is how you can modify webpack configuration:
|
16
|
-
|
17
|
-
```js
|
18
|
-
// config/webpack/custom.js
|
19
|
-
module.exports = {
|
20
|
-
resolve: {
|
21
|
-
alias: {
|
22
|
-
jquery: 'jquery/src/jquery',
|
23
|
-
vue: 'vue/dist/vue.js',
|
24
|
-
React: 'react',
|
25
|
-
ReactDOM: 'react-dom',
|
26
|
-
vue_resource: 'vue-resource/dist/vue-resource',
|
27
|
-
}
|
28
|
-
}
|
29
|
-
}
|
30
|
-
|
31
|
-
// config/webpack/environment.js
|
32
|
-
const { environment } = require('@rails/webpacker')
|
33
|
-
const customConfig = require('./custom')
|
34
|
-
|
35
|
-
// Set nested object prop using path notation
|
36
|
-
environment.config.set('resolve.extensions', ['.foo', '.bar'])
|
37
|
-
environment.config.set('output.filename', '[name].js')
|
38
|
-
|
39
|
-
// Merge custom config
|
40
|
-
environment.config.merge(customConfig)
|
41
|
-
environment.config.merge({ devtool: 'none' })
|
42
|
-
|
43
|
-
// Delete a property
|
44
|
-
environment.config.delete('output.chunkFilename')
|
45
|
-
|
46
|
-
module.exports = environment
|
47
|
-
```
|
48
|
-
|
49
|
-
If you need access to configs within Webpacker's configuration,
|
50
|
-
you can import them like so:
|
51
|
-
|
52
|
-
```js
|
53
|
-
const { config } = require('@rails/webpacker')
|
54
|
-
|
55
|
-
console.log(config.output_path)
|
56
|
-
console.log(config.source_path)
|
57
|
-
```
|
58
|
-
|
59
|
-
## Loaders
|
60
|
-
|
61
|
-
You can add additional loaders beyond the base set that Webpacker provides by
|
62
|
-
adding it to your environment. We'll use `json-loader` as an example:
|
63
|
-
|
64
|
-
```
|
65
|
-
yarn add json-loader
|
66
|
-
```
|
67
|
-
|
68
|
-
```js
|
69
|
-
// config/webpack/environment.js
|
70
|
-
const { environment } = require('@rails/webpacker')
|
71
|
-
|
72
|
-
const jsonLoader = {
|
73
|
-
test: /\.json$/,
|
74
|
-
use: 'json-loader'
|
75
|
-
}
|
76
|
-
|
77
|
-
// Insert json loader at the end of list
|
78
|
-
environment.loaders.append('json', jsonLoader)
|
79
|
-
|
80
|
-
// Insert json loader at the top of list
|
81
|
-
environment.loaders.prepend('json', jsonLoader)
|
82
|
-
|
83
|
-
// Insert json loader after/before a given loader
|
84
|
-
environment.loaders.insert('json', jsonLoader, { after: 'style'} )
|
85
|
-
environment.loaders.insert('json', jsonLoader, { before: 'babel'} )
|
86
|
-
|
87
|
-
module.exports = environment
|
88
|
-
```
|
89
|
-
|
90
|
-
Finally add `.json` to the list of extensions in `config/webpacker.yml`. Now if you `import()` any `.json` files inside your JavaScript
|
91
|
-
they will be processed using `json-loader`. Voila!
|
92
|
-
|
93
|
-
You can also modify the loaders that Webpacker pre-configures for you. We'll update
|
94
|
-
the `babel` loader as an example:
|
95
|
-
|
96
|
-
```js
|
97
|
-
// config/webpack/environment.js
|
98
|
-
const { environment } = require('@rails/webpacker')
|
99
|
-
|
100
|
-
const babelLoader = environment.loaders.get('babel')
|
101
|
-
babelLoader.options.cacheDirectory = false
|
102
|
-
|
103
|
-
module.exports = environment
|
104
|
-
```
|
105
|
-
|
106
|
-
### Coffeescript 2
|
107
|
-
|
108
|
-
Out of the box webpacker supports coffeescript 1,
|
109
|
-
but here is how you can use Coffeescript 2:
|
110
|
-
|
111
|
-
```
|
112
|
-
yarn add coffeescript@2.0.1
|
113
|
-
```
|
114
|
-
|
115
|
-
```js
|
116
|
-
// config/webpack/environment.js
|
117
|
-
const { environment } = require('@rails/webpacker')
|
118
|
-
|
119
|
-
const babelLoader = environment.loaders.get('babel')
|
120
|
-
|
121
|
-
// Replace existing coffee loader with CS2 version
|
122
|
-
environment.loaders.insert('coffee', {
|
123
|
-
test: /\.coffee(\.erb)?$/,
|
124
|
-
use: babelLoader.use.concat(['coffee-loader'])
|
125
|
-
})
|
126
|
-
|
127
|
-
module.exports = environment
|
128
|
-
```
|
129
|
-
|
130
|
-
### React SVG loader
|
131
|
-
|
132
|
-
To use react svg loader, you should append svg loader before file loader:
|
133
|
-
|
134
|
-
```js
|
135
|
-
const { environment } = require('@rails/webpacker')
|
136
|
-
|
137
|
-
const babelLoader = environment.loaders.get('babel')
|
138
|
-
|
139
|
-
environment.loaders.insert('svg', {
|
140
|
-
test: /\.svg$/,
|
141
|
-
use: babelLoader.use.concat([
|
142
|
-
{
|
143
|
-
loader: 'react-svg-loader',
|
144
|
-
options: {
|
145
|
-
jsx: true // true outputs JSX tags
|
146
|
-
}
|
147
|
-
}
|
148
|
-
])
|
149
|
-
}, { before: 'file' })
|
150
|
-
|
151
|
-
const fileLoader = environment.loaders.get('file')
|
152
|
-
fileLoader.exclude = /\.(svg)$/i
|
153
|
-
```
|
154
|
-
|
155
|
-
|
156
|
-
### Url Loader
|
157
|
-
|
158
|
-
```js
|
159
|
-
// config/webpack/loaders/url.js
|
160
|
-
|
161
|
-
module.exports = {
|
162
|
-
test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
|
163
|
-
use: [{
|
164
|
-
loader: 'url-loader',
|
165
|
-
options: {
|
166
|
-
limit: 10000,
|
167
|
-
name: '[name]-[hash].[ext]'
|
168
|
-
}
|
169
|
-
}]
|
170
|
-
}
|
171
|
-
|
172
|
-
// config/webpack/environment.js
|
173
|
-
|
174
|
-
const { environment } = require('@rails/webpacker')
|
175
|
-
const url = require('./loaders/url')
|
176
|
-
|
177
|
-
environment.loaders.prepend('url', url)
|
178
|
-
|
179
|
-
// avoid using both file and url loaders
|
180
|
-
environment.loaders.get('file').test = /\.(tiff|ico|svg|eot|otf|ttf|woff|woff2)$/i
|
181
|
-
```
|
182
|
-
|
183
|
-
### Overriding Loader Options in webpack 3+ (for CSS Modules etc.)
|
184
|
-
|
185
|
-
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:
|
186
|
-
|
187
|
-
```javascript
|
188
|
-
const { environment } = require('@rails/webpacker')
|
189
|
-
const merge = require('webpack-merge')
|
190
|
-
|
191
|
-
const myCssLoaderOptions = {
|
192
|
-
modules: {
|
193
|
-
localIdentName: '[name]__[local]___[hash:base64:5]'
|
194
|
-
},
|
195
|
-
sourceMap: true,
|
196
|
-
}
|
197
|
-
|
198
|
-
const CSSLoader = environment.loaders.get('sass').use.find(el => el.loader === 'css-loader')
|
199
|
-
|
200
|
-
CSSLoader.options = merge(CSSLoader.options, myCssLoaderOptions)
|
201
|
-
|
202
|
-
module.exports = environment
|
203
|
-
```
|
204
|
-
|
205
|
-
See [issue #756](https://github.com/rails/webpacker/issues/756#issuecomment-327148547) for additional discussion of this.
|
206
|
-
|
207
|
-
For this to work, don't forget to use the `stylesheet_pack_tag`, for example:
|
208
|
-
|
209
|
-
```
|
210
|
-
<%= stylesheet_pack_tag 'YOUR_PACK_NAME_HERE' %>
|
211
|
-
```
|
212
|
-
|
213
|
-
## Plugins
|
214
|
-
|
215
|
-
The process for adding or modifying webpack plugins is the same as the process
|
216
|
-
for loaders above:
|
217
|
-
|
218
|
-
```js
|
219
|
-
// config/webpack/environment.js
|
220
|
-
const { environment } = require('@rails/webpacker')
|
221
|
-
const webpack = require('webpack')
|
222
|
-
|
223
|
-
// Get a pre-configured plugin
|
224
|
-
const manifestPlugin = environment.plugins.get('Manifest')
|
225
|
-
manifestPlugin.options.writeToFileEmit = false
|
226
|
-
|
227
|
-
// Add an additional plugin of your choosing : ProvidePlugin
|
228
|
-
environment.plugins.prepend(
|
229
|
-
'Provide',
|
230
|
-
new webpack.ProvidePlugin({
|
231
|
-
$: 'jquery',
|
232
|
-
jQuery: 'jquery',
|
233
|
-
jquery: 'jquery',
|
234
|
-
'window.Tether': 'tether',
|
235
|
-
Popper: ['popper.js', 'default'],
|
236
|
-
ActionCable: 'actioncable',
|
237
|
-
Vue: 'vue',
|
238
|
-
VueResource: 'vue-resource',
|
239
|
-
})
|
240
|
-
)
|
241
|
-
|
242
|
-
// Insert before a given plugin
|
243
|
-
environment.plugins.insert('CommonChunkVendor',
|
244
|
-
new webpack.optimize.CommonsChunkPlugin({
|
245
|
-
name: 'vendor', // Vendor code
|
246
|
-
minChunks: (module) => module.context && module.context.indexOf('node_modules') !== -1
|
247
|
-
})
|
248
|
-
, { before: 'manifest' })
|
249
|
-
|
250
|
-
module.exports = environment
|
251
|
-
```
|
252
|
-
|
253
|
-
## Resolved modules
|
254
|
-
|
255
|
-
To add new paths to `resolve.modules`, the API is same as loaders and plugins:
|
256
|
-
|
257
|
-
```js
|
258
|
-
const { environment } = require('@rails/webpacker')
|
259
|
-
|
260
|
-
// Resolved modules list API - prepend, append, insert
|
261
|
-
environment.resolvedModules.append('vendor', 'vendor')
|
262
|
-
```
|
263
|
-
|
264
|
-
### Add SplitChunks (Webpack V4)
|
265
|
-
Originally, chunks (and modules imported inside them) were connected by a parent-child relationship in the internal webpack graph. The CommonsChunkPlugin was used to avoid duplicated dependencies across them, but further optimizations were not possible.
|
266
|
-
|
267
|
-
Since webpack v4, the CommonsChunkPlugin was removed in favor of optimization.splitChunks.
|
268
|
-
|
269
|
-
For the full configuration options of SplitChunks, see the [Webpack documentation](https://webpack.js.org/plugins/split-chunks-plugin/).
|
270
|
-
|
271
|
-
```js
|
272
|
-
// config/webpack/environment.js
|
273
|
-
|
274
|
-
// Enable the default config
|
275
|
-
environment.splitChunks()
|
276
|
-
|
277
|
-
// or using custom config
|
278
|
-
environment.splitChunks((config) => Object.assign({}, config, { optimization: { splitChunks: false }}))
|
279
|
-
```
|
280
|
-
|
281
|
-
Then use the `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` helpers to include all the transpiled
|
282
|
-
packs with the chunks in your view, which creates html tags for all the chunks.
|
283
|
-
|
284
|
-
```erb
|
285
|
-
<%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %>
|
286
|
-
|
287
|
-
<script src="/packs/vendor-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
288
|
-
<script src="/packs/calendar~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
289
|
-
<script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
290
|
-
<script src="/packs/map~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
291
|
-
<script src="/packs/map-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
|
292
|
-
```
|
293
|
-
|
294
|
-
**Important:** Pass all your pack names when using this helper otherwise you will
|
295
|
-
get duplicated chunks on the page.
|
296
|
-
|
297
|
-
```erb
|
298
|
-
<%# DO %>
|
299
|
-
<%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
|
300
|
-
|
301
|
-
<%# DON'T %>
|
302
|
-
<%= javascript_packs_with_chunks_tag 'calendar' %>
|
303
|
-
<%= javascript_packs_with_chunks_tag 'map' %>
|
304
|
-
```
|
305
|
-
|
306
|
-
For the old configuration with the CommonsChunkPlugin see below. **Note** that this functionality is deprecated in Webpack V4.
|
307
|
-
|
308
|
-
#### Preloading
|
309
|
-
|
310
|
-
Before preload or prefetch your assets, please read [https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content](https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content).
|
311
|
-
|
312
|
-
Webpack also provide it's own methods for preload or prefetch [https://medium.com/webpack/link-rel-prefetch-preload-in-webpack-51a52358f84c](https://medium.com/webpack/link-rel-prefetch-preload-in-webpack-51a52358f84c).
|
313
|
-
|
314
|
-
You can preload your assets with the `preload_pack_asset` helper if you have Rails >= 5.2.x.
|
315
|
-
|
316
|
-
```erb
|
317
|
-
<%= preload_pack_asset 'fonts/fa-regular-400.woff2' %>
|
318
|
-
```
|
319
|
-
|
320
|
-
**Warning:** You don't want to preload the css, you want to preload the fonts and images inside the css so that fonts, css, and images can all be downloaded in parallel instead of waiting for the browser to parse the css.
|
321
|
-
|
322
|
-
### Add common chunks (deprecated in Webpack V4)
|
323
|
-
|
324
|
-
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.
|
325
|
-
|
326
|
-
Add the plugins in `config/webpack/environment.js`:
|
327
|
-
|
328
|
-
```js
|
329
|
-
const webpack = require('webpack')
|
330
|
-
|
331
|
-
environment.plugins.append(
|
332
|
-
'CommonsChunkVendor',
|
333
|
-
new webpack.optimize.CommonsChunkPlugin({
|
334
|
-
name: 'vendor',
|
335
|
-
minChunks: (module) => {
|
336
|
-
// this assumes your vendor imports exist in the node_modules directory
|
337
|
-
return module.context && module.context.indexOf('node_modules') !== -1
|
338
|
-
}
|
339
|
-
})
|
340
|
-
)
|
341
|
-
|
342
|
-
environment.plugins.append(
|
343
|
-
'CommonsChunkManifest',
|
344
|
-
new webpack.optimize.CommonsChunkPlugin({
|
345
|
-
name: 'manifest',
|
346
|
-
minChunks: Infinity
|
347
|
-
})
|
348
|
-
)
|
349
|
-
```
|
350
|
-
|
351
|
-
Now, add these files to your `layouts/application.html.erb`:
|
352
|
-
|
353
|
-
```erb
|
354
|
-
<%# Head %>
|
355
|
-
|
356
|
-
<%= javascript_pack_tag "manifest" %>
|
357
|
-
<%= javascript_pack_tag "vendor" %>
|
358
|
-
|
359
|
-
<%# If importing any styles from node_modules in your JS app %>
|
360
|
-
|
361
|
-
<%= stylesheet_pack_tag "vendor" %>
|
362
|
-
```
|
363
|
-
|
364
|
-
More detailed guides available here: [webpack guides](https://webpack.js.org/guides/)
|
data/docs/yarn.md
DELETED
@@ -1,23 +0,0 @@
|
|
1
|
-
# Yarn
|
2
|
-
|
3
|
-
Webpacker by default uses `yarn` as a package manager for `node_modules`
|
4
|
-
|
5
|
-
|
6
|
-
## Add a new npm module
|
7
|
-
|
8
|
-
To add any new JS module you can use `yarn`:
|
9
|
-
|
10
|
-
```bash
|
11
|
-
yarn add bootstrap material-ui
|
12
|
-
```
|
13
|
-
|
14
|
-
## Add an npm module to `devDependencies`
|
15
|
-
To add a new JS module that will only be available to local development:
|
16
|
-
|
17
|
-
```bash
|
18
|
-
yarn add --dev browser-sync
|
19
|
-
```
|
20
|
-
|
21
|
-
Be careful not to add any build or app related JS modules in this fashion. Adding JS modules to `devDependencies` [will block them from being installed in **any** production environment](https://yarnpkg.com/lang/en/docs/cli/install/#toc-yarn-install-production-true-false).
|
22
|
-
|
23
|
-
Docs from JS modules may instruct you to use `--dev` or `devDependencies`, but this is generally under the assumption that you are using a `node.js` workflow.
|
data/lib/install/angular.rb
DELETED
@@ -1,23 +0,0 @@
|
|
1
|
-
require "webpacker/configuration"
|
2
|
-
|
3
|
-
say "Copying angular example entry file to #{Webpacker.config.source_entry_path}"
|
4
|
-
copy_file "#{__dir__}/examples/angular/hello_angular.js", "#{Webpacker.config.source_entry_path}/hello_angular.js"
|
5
|
-
|
6
|
-
say "Copying hello_angular app to #{Webpacker.config.source_path}"
|
7
|
-
directory "#{__dir__}/examples/angular/hello_angular", "#{Webpacker.config.source_path}/hello_angular"
|
8
|
-
|
9
|
-
say "Installing all angular dependencies"
|
10
|
-
run "yarn add core-js zone.js rxjs @angular/core @angular/common @angular/compiler @angular/platform-browser @angular/platform-browser-dynamic"
|
11
|
-
|
12
|
-
if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
|
13
|
-
say "You need to enable unsafe-eval rule.", :yellow
|
14
|
-
say "This can be done in Rails 5.2+ for development environment in the CSP initializer", :yellow
|
15
|
-
say "config/initializers/content_security_policy.rb with a snippet like this:", :yellow
|
16
|
-
say "if Rails.env.development?", :yellow
|
17
|
-
say " policy.script_src :self, :https, :unsafe_eval", :yellow
|
18
|
-
say "else", :yellow
|
19
|
-
say " policy.script_src :self, :https", :yellow
|
20
|
-
say "end", :yellow
|
21
|
-
end
|
22
|
-
|
23
|
-
say "Webpacker now supports angular 🎉", :green
|
data/lib/install/coffee.rb
DELETED
@@ -1,25 +0,0 @@
|
|
1
|
-
require "webpacker/configuration"
|
2
|
-
|
3
|
-
say "Copying coffee loader to config/webpack/loaders"
|
4
|
-
copy_file "#{__dir__}/loaders/coffee.js", Rails.root.join("config/webpack/loaders/coffee.js").to_s
|
5
|
-
|
6
|
-
say "Adding coffee loader to config/webpack/environment.js"
|
7
|
-
insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
|
8
|
-
"const coffee = require('./loaders/coffee')\n",
|
9
|
-
after: /require\(('|")@rails\/webpacker\1\);?\n/
|
10
|
-
|
11
|
-
insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
|
12
|
-
"environment.loaders.prepend('coffee', coffee)\n",
|
13
|
-
before: "module.exports"
|
14
|
-
|
15
|
-
say "Updating webpack paths to include .coffee file extension"
|
16
|
-
insert_into_file Webpacker.config.config_path, "- .coffee\n".indent(4), after: /\s+extensions:\n/
|
17
|
-
|
18
|
-
say "Copying the example entry file to #{Webpacker.config.source_entry_path}"
|
19
|
-
copy_file "#{__dir__}/examples/coffee/hello_coffee.coffee",
|
20
|
-
"#{Webpacker.config.source_entry_path}/hello_coffee.coffee"
|
21
|
-
|
22
|
-
say "Installing all Coffeescript dependencies"
|
23
|
-
run "yarn add coffeescript@1.12.7 coffee-loader"
|
24
|
-
|
25
|
-
say "Webpacker now supports Coffeescript 🎉", :green
|
@@ -1 +0,0 @@
|
|
1
|
-
defaults
|