webpacker 5.4.1 → 6.0.0.rc.5

data/docs/target.md

@@ -1,22 +0,0 @@
-# Target browsers
-
-By default webpacker provides these front-end tools:
-- [@babel/preset-env](https://github.com/babel/babel/tree/master/packages/babel-preset-env)
-- [Autoprefixer](https://github.com/postcss/autoprefixer)
-- [postcss-preset-env](https://github.com/csstools/postcss-preset-env)
-
-All these tools use [Browserslist](https://github.com/browserslist/browserslist) to detect which environment your users have
-
-Webpacker browserslist default target:
-```
-defaults
-```
-
-`defaults`: `(> 0.5%, last 2 versions, Firefox ESR, not dead)`, [browserl.ist](https://browserl.ist/) is an online tool to check what browsers will be selected by some query.
-
-To keep browsers data up to date, you need to run:
-```bash
-yarn upgrade caniuse-lite
-```
-
-at least once every few months, to prevent such [problems](https://github.com/browserslist/browserslist/issues/492)

data/docs/testing.md

@@ -1,136 +0,0 @@
-# Testing
-
-## Karma setup for Typescript
-
-Webpacker does not setup `Karma` by default, so you've to manually install it along with its dependencies as per your need. Following things marked as optional can be used to fancify the test results (Recommended).
-
-```js
-// package.json
-"scripts": {
-  "test": "NODE_ENV=test karma start"
-},
-"dependencies": {
-  "typescript": "^2.5.2"
-},
-"devDependencies": {
-  "karma": "^1.7.1",
-  "karma-webpack": "^2.0.4",
-  "karma-chrome-launcher": "^2.2.0",
-  "karma-jquery": "^0.2.2",
-  "karma-jasmine": "^1.1.0",
-  "karma-jasmine-jquery": "^0.1.1",
-  "jasmine-core": "^2.8.0",
-  [optional] "karma-coverage": "^1.1.1",
-  [optional] "karma-coverage-istanbul-reporter": "^1.3.0",
-  [optional] "karma-spec-reporter": "0.0.31",
-  [optional] "istanbul-instrumenter-loader": "^3.0.0",
-}
-```
-
-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('./environment')
-environment.plugins.get('Manifest').options.writeToFileEmit = process.env.NODE_ENV !== 'test'
-environment.loaders.append('istanbul-instrumenter', {
-  test: /\.ts$/,
-  enforce: "post",
-  loader: "istanbul-instrumenter-loader",
-  query: {
-    esModules: true
-  },
-  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: "",
-    frameworks: ["jquery-3.2.1", "jasmine-jquery", "jasmine"],
-    plugins: [
-      "karma-jquery",
-      "karma-jasmine-jquery",
-      "karma-jasmine",
-      "karma-webpack",
-      "karma-chrome-launcher",
-      "karma-coverage-istanbul-reporter" /* optional */,
-      "karma-spec-reporter" /* optional */
-    ],
-    files: [ "/* add spec files */" ],
-    exclude: [],
-    webpack: webpackConfig,
-    preprocessors: {"/* add spec files */" : ["webpack"]},
-    mime: { "text/x-typescript": ["ts"] },
-    reporters: ["progress", "coverage-istanbul" /* optional */],
-    coverageIstanbulReporter: {
-      reports: [ 'html', 'lcovonly', 'text-summary' ],
-      fixWebpackSourcePaths: true
-    } /* optional */,
-    port: 9876,
-    colors: true,
-    logLevel: config.LOG_INFO,
-    autoWatch: true,
-    browsers: ["Chrome"],
-    singleRun: true
-  });
-};
-```
-
-## Lazy compilation
-
-Webpacker lazily compiles assets in test env so you can write your tests without any extra
-setup and everything will just work out of the box.
-
-Here is a sample system test case with hello_react example component:
-
-```js
-// Example React component
-
-import React from 'react'
-import ReactDOM from 'react-dom'
-import PropTypes from 'prop-types'
-
-const Hello = props => (
-  <div>Hello David</div>
-)
-
-document.addEventListener('DOMContentLoaded', () => {
-  ReactDOM.render(
-    <Hello />,
-    document.body.appendChild(document.createElement('div')),
-  )
-})
-```
-
-```erb
-<%# views/pages/home.html.erb %>
-
-<%= javascript_pack_tag "hello_react" %>
-```
-
-```rb
-# Tests example React component
-require "application_system_test_case"
-class HomesTest < ApplicationSystemTestCase
-  test "can see the hello message" do
-    visit root_url
-    assert_selector "h5", text: "Hello! David"
-  end
-end
-```
-
-## Capybara setup for Rails
-Make sure you configure Rails to serve static files from the public directory in the test environment.
-
-```rb
-# config/environments/test.rb
-# Configure public file server for tests with Cache-Control for performance.
-config.public_file_server.enabled = 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