webpacker 5.4.0 → 6.0.0.rc.6

data/docs/props.md

@@ -1,223 +0,0 @@
-# Props
-
-
-## React
-
-If you need more advanced React-integration, like server rendering, redux, or react-router, see [shakacode/react_on_rails](https://github.com/shakacode/react_on_rails), [react-rails](https://github.com/reactjs/react-rails), and [webpacker-react](https://github.com/renchap/webpacker-react).
-
-If you're not concerned with view helpers to pass props or server rendering, can do it yourself:
-
-```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)
-})
-```
-
-
-## 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/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!