webpacker 5.4.3 → 6.0.0.beta

data/docs/troubleshooting.md

@@ -1,158 +0,0 @@
-# Troubleshooting
-
-## Debugging your webpack config
-
-1. Read the error message carefully. The error message will tell you the precise key value
-   that is not matching what Webpack expects.
-2. Put a `debugger` statement in your Webpack configuration and run `bin/webpack --debug-webpacker`.
-   If you have a node debugger installed, you'll see the Chrome debugger for your webpack
-   config. For example, install the Chrome extension [NiM](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj) and
-   set the option for the dev tools to open automatically. For more details on debugging,
-   see the official [Webpack docs on debugging](https://webpack.js.org/contribute/debugging/#devtools)
-3. Any arguments that you add to bin/webpack get sent to webpack. For example, you can pass `--debug` to switch loaders to debug mode. See [webpack CLI debug options](https://webpack.js.org/api/cli/#debug-options) for more information on the available options.
-4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-webpacker`
-
-## ENOENT: no such file or directory - node-sass
-
-If you get the error `ENOENT: no such file or directory - node-sass` on deploy with
-`assets:precompile` or `bundle exec rails webpacker:compile` you may need to
-move Sass to production `dependencies`.
-
-Move any packages that related to Sass (e.g. `node-sass` or `sass-loader`) from
-`devDependencies` to `dependencies` in `package.json`. This is because
-webpacker is running on a production system with the Rails workflow to build
-the assets. Particularly on hosting providers that try to detect and do the right
-thing, like Heroku.
-
-However, if you get this on local development, or not during a deploy then you
-may need to rebuild `node-sass`. It's a bit of a weird error; basically, it
-can't find the `node-sass` binary.  An easy solution is to create a postinstall
-hook to ensure `node-sass` is rebuilt whenever new modules are installed.
-
-In `package.json`:
-
-```json
-"scripts": {
-  "postinstall": "npm rebuild node-sass"
-}
-```
-
-## 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.
-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.
-Therefore, make sure webpack
-(i.e `./bin/webpack-dev-server`) is running and has
-completed the compilation successfully before loading a view.
-
-
-## throw er; // Unhandled 'error' event
-
-* If you get this error while trying to use Elm, try rebuilding Elm. You can do
-  so with a postinstall hook in your `package.json`:
-
-```
-"scripts": {
-  "postinstall": "npm rebuild elm"
-}
-```
-
-
-## webpack or webpack-dev-server not found
-
-* This could happen if  `webpacker:install` step is skipped. Please run `bundle exec rails webpacker:install` to fix the issue.
-
-* If you encounter the above error on heroku after upgrading from Rails 4.x to 5.1.x, then the problem might be related to missing `yarn` binstub. Please run following commands to update/add binstubs:
-
-```bash
-bundle config --delete bin
-./bin/rails app:update:bin # or rails app:update:bin
-```
-
-
-## Running webpack on Windows
-
-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:
-
-```
-C:\path>ruby bin\webpack
-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.
-
-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 minify by terser 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.new(harmony: true)
-
-```
-
-### Angular: WARNING in ./node_modules/@angular/core/esm5/core.js, Critical dependency: the request of a dependency is an expression
-
-To silent these warnings, please update `config/webpack/environment.js`
-
-```js
-// environment.js
-const webpack = require('webpack')
-const { resolve } = require('path')
-const { environment, config } = require('@rails/webpacker')
-
-environment.plugins.append('ContextReplacement',
-  new webpack.ContextReplacementPlugin(
-    /angular(\\|\/)core(\\|\/)(@angular|esm5)/,
-    resolve(config.source_path)
-  )
-)
-```
-
-### Compilation Fails Silently
-
-If compiling is not producing output files and there are no error messages to help troubleshoot. Setting the webpack_compile_output configuration variable to 'true' in webpacker.yml may add some helpful error information to your log file (Rails log/development.log or log/production.log)
-
-```yml
-# webpacker.yml
-default: &default
-  source_path: app/javascript
-  source_entry_path: packs
-  public_root_path: public
-  public_output_path: complaints_packs
-  webpack_compile_output: true
-```

data/docs/typescript.md

@@ -1,190 +0,0 @@
-# TypeScript
-
-## Installation
-
-1. Run the TypeScript installer
-
-```bash
-bundle exec rails webpacker:install:typescript
-```
-
-After that, a new file called `hello_typescript.ts` will be present in your `packs` directory (or rather the `source_entry_path` of your `webpacker.yml` configuration). You're now ready to write TypeScript. 
-
-## (Optional) Adding Compile-Time Type Checking
-
-The default installation only transpiles your TypeScript code using Babel. If you would like to enable type checking as part of the Webpack compilation process (i.e. fail the build if there are TS errors), you can do the following:
-
-1. Install the Fork TS Checker Webpack Plugin
-
-    ```sh
-    yarn add --dev fork-ts-checker-webpack-plugin
-    ```
-
-2. Then add it to your development environment config in `config/webpack/development.js`
-
-    ```js
-    const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
-    const path = require("path");
-
-    environment.plugins.append(
-      "ForkTsCheckerWebpackPlugin",
-      new ForkTsCheckerWebpackPlugin({
-        typescript: {
-          configFile: path.resolve(__dirname, "../../tsconfig.json"),
-        },
-        async: false,
-      })
-    );
-    ```
-
-    If you are `fork-ts-checker-webpack-plugin` older than 5.0, the `tsconfig` option also needs to be specified:
-
-    ```js
-    const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
-    const path = require("path");
-
-    environment.plugins.append(
-      "ForkTsCheckerWebpackPlugin",
-      new ForkTsCheckerWebpackPlugin({
-        // this is a relative path to your project's TypeScript config
-        tsconfig: path.resolve(__dirname, "../../tsconfig.json"),
-        // non-async so type checking will block compilation
-        async: false,
-      })
-    );
-    ```
-
-## Upgrading to 5.1
-
-If you update your App to `webpacker >= 5.1` and had TypeScript installed before, you need to add some new/remove some old configurations:
-
-1. Remove old packages:
-    - `yarn remove ts-loader`
-
-2. Add new packages:
-    - `yarn add @babel/preset-typescript`
-
-3. Remove old configuration files: 
-    - Delete this file: `config/webpack/loaders/typescript.js`
-
-4. Remove the following lines from `config/webpack/environment.js`:
-    - `const typescript = require('./loaders/typescript')`
-    - `environment.loaders.prepend('typescript', typescript)`
-
-5. Add the TypeScript preset to your `babel.config.js`:
-    - This line `['@babel/preset-typescript', { 'allExtensions': true, 'isTSX': true }]` has to be added as the last item to the `presets` array in your `babel.config.js`
-
-### Upgrading to 5.1 for Vue users
-
-1. Remove old packages:
-    - `yarn remove ts-loader pnp-webpack-plugin`
-
-2. Follow point 3 and 4 from the `TypeScript with Vue components` section
-
-## TypeScript with React
-
-1. Setup react using Webpacker [react installer](../README.md#react). Then run the TypeScript installer
-
-```bash
-bundle exec rails webpacker:install:typescript
-```
-
-2. Rename the generated `hello_react.js` to `hello_react.tsx`. Make the file valid TypeScript and
-now you can use TypeScript, JSX with React.
-
-## TypeScript with Vue components
-
-1. Setup Vue using the Webpacker [Vue installer](../README.md#vue). Then run the TypeScript installer
-
-```bash
-bundle exec rails webpacker:install:typescript
-```
-
-2. Rename generated `hello_vue.js` to `hello_vue.ts`.
-3. Install the right Babel preset: `yarn add babel-preset-typescript-vue`
-4. Change the generated `babel.config.js` from
-
-```js
-["@babel/preset-typescript", { "allExtensions": true, "isTSX": true }]
-```
-
-to
-
-```js
-["babel-preset-typescript-vue", { "allExtensions": true, "isTSX": true }]
-```
-
-and now you can use `<script lang="ts">` in your `.vue` component files. See [the babel-preset-typescript-vue docs](https://www.npmjs.com/package/babel-preset-typescript-vue) for more info.
-
-## HTML templates with TypeScript and 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
-
-```bash
-yarn add html-loader
-```
-
-2. Add html-loader to `config/webpack/environment.js`
-
-```js
-environment.loaders.append('html', {
-  test: /\.html$/,
-  use: [{
-    loader: 'html-loader',
-    options: {
-      minimize: true,
-      removeAttributeQuotes: false,
-      caseSensitive: true,
-      customAttrSurround: [ [/#/, /(?:)/], [/\*/, /(?:)/], [/\[?\(?/, /(?:)/] ],
-      customAttrAssign: [ /\)?\]?=/ ]
-    }
-  }]
-})
-```
-
-3. Add `.html` to `config/webpacker.yml`
-
-```yml
-  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!'
-}
-```
-
-That's all. Voila!

data/docs/v4-upgrade.md

@@ -1,142 +0,0 @@
-# Webpacker Upgrade Guide
-
-
-To update a Webpacker v3.5 app to v4, follow these steps:
-
-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.
-
-2. Browser support definitions have been moved from [`.browserslistrc`](../lib/install/config/.browserslistrc) to `/`.
-
-3. Merge any differences between [`config/webpacker.yml`](../lib/install/config/webpacker.yml) and your `config/webpacker.yml`.
-
-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))
-
-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.
-
-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.
-
-## SplitChunks Configuration
-
-If you used the `CommonsChunkPlugin` you'll need to upgrade to using the new `splitChunks`.
-
-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.
-
-In Webpack v4, the `CommonsChunkPlugin` was removed in favor of `optimization.splitChunks`.
-
-For the full configuration options of `splitChunks`, see the [Webpack documentation](https://webpack.js.org/plugins/split-chunks-plugin/).
-
-```js
-// config/webpack/environment.js
-const WebpackAssetsManifest = require('webpack-assets-manifest');
-
-// Enable the default config
-environment.splitChunks()
-
-// or using custom config
-environment.splitChunks((config) => Object.assign({}, config, { optimization: { splitChunks: false }}))
-```
-
-Then use the `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` helpers to include all the transpiled
-packs with the chunks in your view, which creates html tags for all the chunks.
-
-```erb
-<%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %>
-
-<!-- Creates the following: -->
-<script src="/packs/vendor-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/calendar~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/map~runtime-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-<script src="/packs/map-16838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-```
-
-**Important:** Pass all your pack names to the helper otherwise you will get duplicated chunks on the page.
-
-```erb
-<%# DO %>
-<%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
-
-<%# DON'T %>
-<%= javascript_packs_with_chunks_tag 'calendar' %>
-<%= javascript_packs_with_chunks_tag 'map' %>
-```
-
-## Package-Specific Notes
-
-- If you're using React, you need to add `"@babel/preset-react"`, to the list of `presets` in your babel config.
-- If you're using Vue Loader, you'll need to upgrade to [v15](https://vue-loader.vuejs.org/migrating.html) for Webpack 4.
-- 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.
-
-## Excluding node_modules From Being Transpiled By Babel-Loader
-
-One change to take into consideration, is that Webpacker 4 transpiles the
-`node_modules` folder with the `babel-loader`. This folder used to be ignored by
-Webpacker 3. The new behavior helps in case some library contains ES6 code, but in
-some cases it can lead to issues. To avoid running `babel-loader` in the
-`node_modules` folder, replicating the same behavior as Webpacker 3, the
-following code can be added to `config/webpack/environment.js`:
-
-```javascript
-environment.loaders.delete('nodeModules')
-```
-
-Alternatively, in order to skip only a specific library in the `node_modules`
-folder, this code can be added:
-
-```javascript
-const nodeModulesLoader = environment.loaders.get('nodeModules')
-if (!Array.isArray(nodeModulesLoader.exclude)) {
-  nodeModulesLoader.exclude = (nodeModulesLoader.exclude == null)
-    ? []
-    : [nodeModulesLoader.exclude]
-}
-nodeModulesLoader.exclude.push(/some-library/) // replace `some-library` with
-                                               // the actual path to exclude
-```
-
-## Source Maps Enabled By Default
-
-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.
-
-If you want to keep the old behavior source maps can be disabled in any environment configuration, e.g:
-
-```js
-// config/webpack/production.js
-
-const environment = require('./environment')
-environment.config.merge({ devtool: false })
-
-module.exports = environment.toWebpackConfig()
-```
-
-## Namespaces
-
-The compiled packs in the public directory are now stored under namespaces:
-
-- JavaScripts are stored under `js`
-- Stylesheets are stored under `css`
-- Other resources are stored under `media`
-
-```rb
-# Before
-"runtime~hello_react" => "/packs/runtime~hello_react-da2baf7fd07b0e8b6d17.js"
-
-# After
-"runtime~hello_react" => "/packs/js/runtime~hello_react-da2baf7fd07b0e8b6d17.js"
-```
-
-## Upgrading projects with custom Webpack setups that use only the view helpers
-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.
-
-  ```yml
-  default: &default
-     # other stuff
-     extract_css: true
-     # by default, extract and emit a css file. The default is false
-  ```
-
-## Example Upgrades
-
-This is what an upgrade to Webpacker 4 looked like for existing Rails apps (please contribute yours!):
-
-- https://github.com/connorshea/ContinueFromCheckpoint/pull/77

data/docs/webpack-dev-server.md

@@ -1,92 +0,0 @@
-# webpack-dev-server
-
-
-## HTTPS
-
-If you're using the `webpack-dev-server` in development, you can serve your packs over HTTPS
-by setting 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/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.
-
-
-## HOT module replacement
-
-Webpacker out-of-the-box supports HMR with `webpack-dev-server` and
-you can toggle it by setting `dev_server/hmr` option inside `webpacker.yml`.
-
-Check out this guide for more information:
-
-- https://webpack.js.org/configuration/dev-server/#devserver-hot
-
-To support HMR with React you would need to add `react-hot-loader`. Checkout this guide for
-more information:
-
-- https://gaearon.github.io/react-hot-loader/getstarted/
-
-**Note:** Don't forget to disable `HMR` if you are not running `webpack-dev-server`
-otherwise you will get not found error for stylesheets.
-
-
-## Nginx
-
-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.
-
-If you're using `inline` mode behind Nginx, you may also need to provide the
-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)).
-
-To do so, set the `public` option in `config/webpacker.yml`:
-
-```yaml
-development:
-  # ...
-  dev_server:
-    # ...
-    public: myapp.dev
-```
-
-You may also need to add the following location block to your local Nginx server
-configuration for your Rails app.
-
-```
-server {
-    listen 80;
-    server_name myapp.dev
-
-    # Proxy webpack dev server websocket requests
-    location /sockjs-node {
-        proxy_redirect off;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "upgrade";
-        proxy_pass http://127.0.0.1:3035; # change to match your webpack-dev-server host
-    }
-
-    # ...
-}
-```
-
-## 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
-```