webpacker 5.4.3 → 6.0.0.beta

data/docs/integrations.md

@@ -1,220 +0,0 @@
-# Integrations
-
-Webpacker ships with basic out-of-the-box integration for React, Angular, Vue and Elm.
-You can see a list of available commands/tasks by running `bundle exec rails webpacker`:
-
-## React
-
-To use Webpacker with [React](https://facebook.github.io/react/), create a
-new Rails 5.1+ app using `--webpack=react` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=react
-```
-
-(or run `bundle exec rails webpacker:install:react` in an existing Rails app already
-setup with Webpacker).
-
-The installer will add all relevant dependencies using Yarn, changes
-to the configuration files, and an example React component to your
-project in `app/javascript/packs` so that you can experiment with React right away.
-
-
-## Angular with TypeScript
-
-To use Webpacker with [Angular](https://angular.io/), create a
-new Rails 5.1+ app using `--webpack=angular` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=angular
-```
-
-(or run `bundle exec rails webpacker:install:angular` on a Rails app already
-setup with Webpacker).
-
-The installer will add the TypeScript and Angular core libraries using Yarn alongside
-a few changes to the configuration files. An example component written in
-TypeScript will also be added to your project in `app/javascript` so that
-you can experiment with Angular right away.
-
-By default, Angular uses a JIT compiler for development environment. This
-compiler is not compatible with restrictive CSP (Content Security
-Policy) environments like Rails 5.2+. You can use Angular AOT compiler
-in development with the [@ngtools/webpack](https://www.npmjs.com/package/@ngtools/webpack#usage) plugin.
-
-Alternatively if you're using Rails 5.2+ you can enable `unsafe-eval` rule for your
-development environment. This can be done in the `config/initializers/content_security_policy.rb`
-with the following code:
-
-```ruby
-Rails.application.config.content_security_policy do |policy|
-  if Rails.env.development?
-    policy.script_src :self, :https, :unsafe_eval
-  else
-    policy.script_src :self, :https
-  end
-end
-```
-
-
-## Vue
-
-To use Webpacker with [Vue](https://vuejs.org/), create a
-new Rails 5.1+ app using `--webpack=vue` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=vue
-```
-(or run `bundle exec rails webpacker:install:vue` on a Rails app already setup with Webpacker).
-
-The installer will add Vue and its required libraries using Yarn alongside
-automatically applying changes needed to the configuration files. An example component will
-be added to your project in `app/javascript` so that you can experiment with Vue right away.
-
-If you're using Rails 5.2+ you'll need to enable `unsafe-eval` rule for your development environment.
-This can be done in the `config/initializers/content_security_policy.rb` with the following
-configuration:
-
-```ruby
-Rails.application.config.content_security_policy do |policy|
-  if Rails.env.development?
-    policy.script_src :self, :https, :unsafe_eval
-  else
-    policy.script_src :self, :https
-  end
-end
-```
-You can read more about this in the [Vue docs](https://vuejs.org/v2/guide/installation.html#CSP-environments).
-
-### Lazy loading integration
-
-See [docs/es6](es6.md) to know more about Webpack and Webpacker configuration.
-
-For instance, you can lazy load Vue JS components:
-
-Before:
-```js
-import Vue from 'vue'
-import { VCard } from 'vuetify/lib'
-
-Vue.component('VCard', VCard)
-```
-
-After:
-```js
-import Vue from 'vue'
-
-// With destructuring assignment
-Vue.component('VCard', import('vuetify/lib').then(({ VCard }) => VCard)
-
-// Or without destructuring assignment
-Vue.component('OtherComponent', () => import('./OtherComponent'))
-```
-
-You can use it in a Single File Component as well:
-
-```html
-<template>
-  ...
-</template>
-
-<script>
-export default {
-  components: {
-    OtherComponent: () => import('./OtherComponent')
-  }
-}
-</script>
-```
-
-By wrapping the import function into an arrow function, Vue will execute it only when it gets requested, loading the module in that moment.
-
-##### Automatic registration
-
-```js
-/**
- * The following block of code may be used to automatically register your
- * Vue components. It will recursively scan this directory for the Vue
- * components and automatically register them with their "basename".
- *
- * Eg. ./components/OtherComponent.vue -> <other-component></other-component>
- * Eg. ./UI/ButtonComponent.vue -> <button-component></button-component>
- */
-
-const files = require.context('./', true, /\.vue$/i)
-files.keys().map(key => {
-  const component = key.split('/').pop().split('.')[0]
-
-  // With Lazy Loading
-  Vue.component(component, () => import(`${key}`))
-
-  // Or without Lazy Loading
-  Vue.component(component, files(key).default)
-})
-```
-
-## Elm
-
-To use Webpacker with [Elm](http://elm-lang.org), create a
-new Rails 5.1+ app using `--webpack=elm` option:
-
-```
-# Rails 5.1+
-rails new myapp --webpack=elm
-```
-
-(or run `bundle exec rails webpacker:install:elm` on a Rails app already setup with Webpacker).
-
-The Elm library and its core packages will be added via Yarn and Elm.
-An example `Main.elm` app will also be added to your project in `app/javascript`
-so that you can experiment with Elm right away.
-
-## Svelte
-
-To use Webpacker with [Svelte](https://svelte.dev), create a
-new Rails 5.1+ app using `--webpack=svelte` option:
-
-```
-# Rails 5.1+
-rails new myapp --webpack=svelte
-```
-
-(or run `bundle exec rails webpacker:install:svelte` on a Rails app already setup with Webpacker).
-
-Please play with the [Svelte Tutorial](https://svelte.dev/tutorial/basics) or learn more about its API at https://svelte.dev/docs
-
-## Stimulus
-
-To use Webpacker with [Stimulus](http://stimulusjs.org), create a
-new Rails 5.1+ app using `--webpack=stimulus` option:
-
-```
-# Rails 5.1+
-rails new myapp --webpack=stimulus
-```
-
-(or run `bundle exec rails webpacker:install:stimulus` on a Rails app already setup with Webpacker).
-
-Please read [The Stimulus Handbook](https://stimulusjs.org/handbook/introduction) or learn more about its source code at https://github.com/stimulusjs/stimulus
-
-## CoffeeScript
-
-To add [CoffeeScript](http://coffeescript.org/) support,
-run `bundle exec rails webpacker:install:coffee` on a Rails app already
-setup with Webpacker.
-
-An example `hello_coffee.coffee` file will also be added to your project
-in `app/javascript/packs` so that you can experiment with CoffeeScript right away.
-
-## Erb
-
-To add [Erb](https://apidock.com/ruby/ERB) support in your JS templates,
-run `bundle exec rails webpacker:install:erb` on a Rails app already
-setup with Webpacker.
-
-An example `hello_erb.js.erb` file will also be added to your project
-in `app/javascript/packs` so that you can experiment with Erb-flavoured
-javascript right away.

data/docs/misc.md

@@ -1,23 +0,0 @@
-# How-Tos
-
-
-## Ignoring swap files
-
-If you are using vim or emacs and want to ignore certain files you can add `ignore-loader`:
-
-```
-yarn add ignore-loader
-```
-
-and add `ignore-loader` to `config/webpack/environment.js`
-
-```js
-// ignores vue~ swap files
-const { environment } = require('@rails/webpacker')
-environment.loaders.append('ignore', {
-  test:  /.vue~$/,
-  loader: 'ignore-loader'
-})
-```
-
-And now all files with `.vue~` will be ignored by the webpack compiler.

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
-```