webpacker 6.0.0.pre.2 → 6.0.0.rc.1

data/docs/props.md

@@ -1,187 +0,0 @@
-# Props
-
-How do you pass props from your view to your JavaScript component? Here you go.
-
-## React
-See [docs/react.md](./react.md#props-hydration-and-server-side-rendering-ssr).
-
-## Vue
-
-Add the data as attributes in the element you are going to use (or any other element for that matter).
-
-```erb
-<%= content_tag :div,
-  id: "hello-vue",
-  data: {
-    message: "Hello!",
-    name: "David"
-  }.to_json do %>
-<% end %>
-```
-
-This should produce the following HTML:
-
-```html
-<div id="hello-vue" data="{&quot;message&quot;:&quot;Hello!&quot;,&quot;name&quot;:&quot;David&quot;}"></div>
-```
-
-Now, modify your Vue app to expect the properties.
-
-```html
-<template>
-  <div id="app">
-    <p>{{test}}{{message}}{{name}}</p>
-  </div>
-</template>
-
-<script>
-  export default {
-    // A child component needs to explicitly declare
-    // the props it expects to receive using the props option
-    // See https://vuejs.org/v2/guide/components.html#Props
-    props: ["message","name"],
-    data: function () {
-      return {
-        test: 'This will display: '
-      }
-    }
-  }
-</script>
-
-<style>
-</style>
-
-```
-
-```js
-document.addEventListener('DOMContentLoaded', () => {
-  // Get the properties BEFORE the app is instantiated
-  const node = document.getElementById('hello-vue')
-  const props = JSON.parse(node.getAttribute('data'))
-
-  // Render component with props
-  new Vue({
-    render: h => h(App, { props })
-  }).$mount('#hello-vue');
-})
-```
-
-You can follow same steps for Angular too.
-
-
-## Elm
-
-Just like with other implementations, we'll render our data inside a `data`
-attribute:
-
-```erb
-<%= content_tag :div,
-  id: "hello-elm",
-  data: {
-    message: "Hello",
-    name: "David"
-  }.to_json do %>
-<% end %>
-```
-
-We parse the JSON data and pass it to Elm as flags:
-
-```js
-import Elm from '../Main'
-
-document.addEventListener('DOMContentLoaded', () => {
-  const node = document.getElementById('hello-elm')
-  const data = JSON.parse(node.getAttribute('data'))
-  Elm.Main.embed(node, data)
-})
-```
-
-Defining `Flags` as a `type alias`, we instruct Elm to demand flags `message`
-and `name` of type `String` on initialization.
-
-Using `programWithFlags` we bring all the pieces together:
-
-
-```elm
-module Main exposing (..)
-
-import Html exposing (Html, programWithFlags, h1, text)
-import Html.Attributes exposing (style)
-
-
--- MODEL
-
-
-type alias Flags =
-    { message : String
-    , name : String
-    }
-
-
-type alias Model =
-    { message : String
-    , name : String
-    }
-
-
-type Msg
-    = NoOp
-
-
-
--- INIT
-
-
-init : Flags -> ( Model, Cmd Msg )
-init flags =
-    let
-        { message, name } =
-            flags
-    in
-        ( Model message name, Cmd.none )
-
-
-
--- UPDATE
-
-
-update : Msg -> Model -> ( Model, Cmd Msg )
-update msg model =
-    case msg of
-        NoOp ->
-            ( model, Cmd.none )
-
-
-
--- SUBSCRIPTIONS
-
-
-subscriptions : Model -> Sub Msg
-subscriptions model =
-    Sub.none
-
-
-
--- VIEW
-
-
-view : Model -> Html Msg
-view model =
-    h1 [ style [ ( "display", "flex" ), ( "justify-content", "center" ) ] ]
-        [ text (model.message ++ ", " ++ model.name ++ "!") ]
-
-
-
--- MAIN
-
-
-main : Program Flags Model Msg
-main =
-    programWithFlags
-        { view = view
-        , init = init
-        , update = update
-        , subscriptions = subscriptions
-        }
-
-```

data/docs/react.md

@@ -1,183 +0,0 @@
-# React
-
-## Props Hydration and Server-Side Rendering (SSR)
-You only _need_ props hydration if you need SSR. However, there's no good reason to
-have your app make a second round trip to the Rails server to get initialization props.
-
-Server-Side Rendering (SSR) results in Rails rendering HTML for your React components.
-The main reasons to use SSR are better SEO and pages display more quickly. 
-
-### Rails and React Integration Gems
-If you desire more advanced React-integration, like server-side rendering, SSR with react-router, SSR with code splitting, then you should consider these gems:
-
-| Gem | Props Hydration | Server-Side-Rendering (SSR) | SSR with HMR | SSR with React-Router | SSR with Code Splitting | Node SSR |
-| --- | --------------- | --- | --------------------- | ----------------------| ------------------------|----|
-| [shakacode/react_on_rails](https://github.com/shakacode/react_on_rails) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
-| [react-rails](https://github.com/reactjs/react-rails)  | ✅ | ✅ |  | | | | |
-| [webpacker-react](https://github.com/renchap/webpacker-react) | ✅ | | | | | | |
-
-Note, Node SSR for React on Rails requires [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).
-
-### Hydration of Props the Manual Way
-
-If you're not concerned with view helpers to pass props or server-side rendering, you can do it like this:
-
-```erb
-<%# views/layouts/application.html.erb %>
-
-<%= content_tag :div,
-  id: "hello-react",
-  data: {
-    message: 'Hello!',
-    name: 'David'
-}.to_json do %>
-<% end %>
-```
-
-```js
-// app/javascript/packs/hello_react.js
-
-const Hello = props => (
-  <div className='react-app-wrapper'>
-    <img src={clockIcon} alt="clock" />
-    <h5 className='hello-react'>
-      {props.message} {props.name}!
-    </h5>
-  </div>
-)
-
-// Render component with data
-document.addEventListener('DOMContentLoaded', () => {
-  const node = document.getElementById('hello-react')
-  const data = JSON.parse(node.getAttribute('data'))
-
-  ReactDOM.render(<Hello {...data} />, node)
-})
-```
-
-----
-
-## HMR and React Hot Reloading
-
-Before turning HMR on, consider upgrading to the latest stable gems and packages:
-https://github.com/rails/webpacker#upgrading
-
-Configure `config/webpacker.yml` file:
-
-```yaml
-development:
-  extract_css: false
-  dev_server:
-    hmr: true
-    inline: true
-```
-
-This basic configuration alone will have HMR working with the default webpacker setup. However, an code saves will trigger a full page refresh each time you save a file.
-
-Webpack's HMR allows the replacement of modules for React in-place without reloading the browser. To do this, you have two options:
-
-1. Steps below for the [github.com/pmmmwh/react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin).
-1. Deprecated steps below for using the [github.com/gaearon/react-hot-loader](https://github.com/gaearon/react-hot-loader).
-
-### React Refresh Webpack Plugin
-[github.com/pmmmwh/react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin)
-
-You can see an example commit of adding this [here](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/commit/7e53803fce7034f5ecff335db1f400a5743a87e7).
-
-1. Add react refresh packages:
-   `yarn add @pmmmwh/react-refresh-webpack-plugin react-refresh -D`
-2. Update `babel.config.js` adding
-   ```js
-   plugins: [
-     process.env.WEBPACK_DEV_SERVER && 'react-refresh/babel',
-     // other plugins
-   ```
-3. Update `config/webpack/development.js`, only including the plugin if running the WEBPACK_DEV_SERVER
-   ```js
-   const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
-   const environment = require('./environment')
-   
-   const isWebpackDevServer = process.env.WEBPACK_DEV_SERVER;
-   
-   //plugins
-   if (isWebpackDevServer) {
-       environment.plugins.append(
-           'ReactRefreshWebpackPlugin',
-           new ReactRefreshWebpackPlugin({
-               overlay: {
-                   sockPort: 3035
-               }
-           })
-       );
-   }
-   ```
-
-### React Hot Loader (Deprecated)
-
-1. Add the `react-hot-loader` and ` @hot-loader/react-dom` npm packages.
-  ```sh
-  yarn add --dev react-hot-loader @hot-loader/react-dom
-  ```
-
-2. Update your babel config, `babel.config.js`. Add the plugin `react-hot-loader/babel`
-with option `"safetyNet": false`:
-
-```
-{
-    "plugins": [
-        [
-            "react-hot-loader/babel",
-            {
-            "safetyNet": false
-            }
-        ]
-    ]
-}
-```
-
-3. Add changes like this to your entry points:
-
-```diff
-// app/javascript/app.jsx
-
-import React from 'react';
-+ import { hot } from 'react-hot-loader/root';
-
-const App = () => <SomeComponent(s) />
-
-- export default App;
-+ export default hot(App);
-```
-
-4. Adjust your webpack configuration for development so that `sourceMapContents` option for the sass
-loader is `false`:
-
-```diff
-// config/webpack/development.js
-
-process.env.NODE_ENV = process.env.NODE_ENV || 'development'
-
-const environment = require('./environment')
-
-// allows for editing sass/scss files directly in browser
-+ if (!module.hot) {
-+   environment.loaders.get('sass').use.find(item => item.loader === 'sass-loader').options.sourceMapContents = false
-+ }
-+ 
-module.exports = environment.toWebpackConfig()
-```
-
-5. Adjust your `config/webpack/environment.js` for a 
-
-```diff
-// config/webpack/environment.js
-
-// ...
-
-// Fixes: React-Hot-Loader: react-🔥-dom patch is not detected. React 16.6+ features may not work.
-// https://github.com/gaearon/react-hot-loader/issues/1227#issuecomment-482139583
-+ environment.config.merge({ resolve: { alias: { 'react-dom': '@hot-loader/react-dom' } } });
-
-module.exports = environment;
-```
-

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,147 +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
-```
-
-## Webpacker Configuration and Rails Tests
-
-Webpacker ships with three javascript configuration files: `test.js`,
-`development.js`, and `production.js`. The `NODE_ENV` environment
-variable determines which config will be used. `NODE_ENV` is
-independent of `RAILS_ENV` and is set to `development` by [default](/lib/install/bin/webpack#L4).
-This means that `rails test` or `rspec` will use `development.js`
-by default, _not_ `test.js`.
-
-For more information see [Why doesn't Webpacker use my test config when I run Rails tests?](https://rossta.net/blog/why-doesnt-webpacker-use-my-test-config-when-i-run-rails-tests.html)