webpacker-jets 3.2.100

data/docs/webpack.md

@@ -0,0 +1,297 @@
+# webpack
+
+
+## Configuration
+
+Webpacker gives you a default set of configuration files for test, development and
+production environments in `config/webpack/*.js`. You can configure each individual
+environment in their respective files or configure them all in the base
+`config/webpack/environment.js` file.
+
+By default, you don't need to make any changes to `config/webpack/*.js`
+files since it's all standard production-ready configuration. However,
+if you do need to customize or add a new loader, this is where you would go.
+
+Here is how you can modify webpack configuration:
+
+```js
+// config/webpack/custom.js
+module.exports = {
+  resolve: {
+    alias: {
+      jquery: 'jquery/src/jquery',
+      vue: 'vue/dist/vue.js',
+      React: 'react',
+      ReactDOM: 'react-dom',
+      vue_resource: 'vue-resource/dist/vue-resource',
+    }
+  }
+}
+
+// config/webpack/environment.js
+const environment = require('./environment')
+const customConfig = require('./custom')
+
+// Set nested object prop using path notation
+environment.config.set('resolve.extensions', ['.foo', '.bar'])
+environment.config.set('output.filename', '[name].js')
+
+// Merge custom config
+environment.config.merge(customConfig)
+
+// Delete a property
+environment.config.delete('output.chunkFilename')
+
+module.exports = environment
+```
+
+If you need access to configs within Webpacker's configuration,
+you can import them like so:
+
+```js
+const { config } = require('@rails/webpacker')
+
+console.log(config.output_path)
+console.log(config.source_path)
+```
+
+## Loaders
+
+You can add additional loaders beyond the base set that Webpacker provides by
+adding it to your environment. We'll use `json-loader` as an example:
+
+```
+yarn add json-loader
+```
+
+```js
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+
+environment.loaders.append('json', {
+  test: /\.json$/,
+  use: 'json-loader'
+})
+
+// Insert json loader at the top of list
+environment.loaders.prepend('json', jsonLoader)
+
+// Insert json loader after/before a given loader
+environment.loaders.insert('json', jsonLoader, { after: 'style'} )
+environment.loaders.insert('json', jsonLoader, { before: 'babel'} )
+
+module.exports = environment
+```
+
+Finally add `.json` to the list of extensions in `config/webpacker.yml`. Now if you `import()` any `.json` files inside your JavaScript
+they will be processed using `json-loader`. Voila!
+
+You can also modify the loaders that Webpacker pre-configures for you. We'll update
+the `babel` loader as an example:
+
+```js
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+
+const babelLoader = environment.loaders.get('babel')
+babelLoader.options.cacheDirectory = false
+
+module.exports = environment
+```
+
+### Coffeescript 2
+
+Out of the box webpacker supports coffeescript 1,
+but here is how you can use Coffeescript 2:
+
+```
+yarn add coffeescript@2.0.1
+```
+
+```js
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+
+const babelLoader = environment.loaders.get('babel')
+
+// Replace existing coffee loader with CS2 version
+environment.loaders.insert('coffee', {
+  test: /\.coffee(\.erb)?$/,
+  use:  babelLoader.use.concat(['coffee-loader'])
+})
+
+module.exports = environment
+```
+
+### React SVG loader
+
+To use react svg loader, you should append svg loader before file loader:
+
+```js
+const { environment } = require('@rails/webpacker')
+
+const babelLoader = environment.loaders.get('babel')
+
+environment.loaders.insert('svg', {
+  test: /\.svg$/,
+  use: babelLoader.use.concat([
+    {
+      loader: 'react-svg-loader',
+      options: {
+        jsx: true // true outputs JSX tags
+      }
+    }
+  ])
+}, { before: 'file' })
+```
+
+
+### Url Loader
+
+```js
+// config/webpack/loaders/url.js
+
+const { assetHost } = require('@rails/webpacker')
+
+module.exports = {
+  test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
+  use: [{
+    loader: 'url-loader',
+    options: {
+      limit: 10000,
+      name: '[name]-[hash].[ext]',
+      publicPath: assetHost.publicPathWithHost
+    }
+  }]
+}
+
+// config/webpack/environment.js
+
+const { environment } = require('@rails/webpacker')
+
+environment.loaders.prepend('url', url)
+```
+
+### Overriding Loader Options in webpack 3+ (for CSS Modules etc.)
+
+In webpack 3+, if you'd like to specify additional or different options for a loader, edit `config/webpack/environment.js` and provide an options object to override. This is similar to the technique shown above, but the following example shows specifically how to apply CSS Modules, which is what you may be looking for:
+
+```javascript
+const { environment } = require('@rails/webpacker')
+const merge = require('webpack-merge')
+
+const myCssLoaderOptions = {
+  modules: true,
+  sourceMap: true,
+  localIdentName: '[name]__[local]___[hash:base64:5]'
+}
+
+const CSSLoader = environment.loaders.get('sass').use.find(el => el.loader === 'css-loader')
+
+CSSLoader.options = merge(CSSLoader.options, myCssLoaderOptions)
+
+module.exports = environment
+```
+
+See [issue #756](https://github.com/rails/webpacker/issues/756#issuecomment-327148547) for additional discussion of this.
+
+For this to work, don't forget to use the `stylesheet_pack_tag`, for example:
+
+```
+<%= stylesheet_pack_tag 'YOUR_PACK_NAME_HERE' %>
+```
+
+## Plugins
+
+The process for adding or modifying webpack plugins is the same as the process
+for loaders above:
+
+```js
+// config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+const webpack = require('webpack')
+
+// Get a pre-configured plugin
+const manifestPlugin = environment.plugins.get('Manifest')
+manifestPlugin.opts.writeToFileEmit = false
+
+// Add an additional plugin of your choosing : ProvidePlugin
+environment.plugins.prepend(
+  'Provide',
+  new webpack.ProvidePlugin({
+    $: 'jquery',
+    jQuery: 'jquery',
+    jquery: 'jquery',
+    'window.Tether': 'tether',
+    Popper: ['popper.js', 'default'],
+    ActionCable: 'actioncable',
+    Vue: 'vue',
+    VueResource: 'vue-resource',
+  })
+)
+
+// Insert before a given plugin
+environment.plugins.insert('CommonChunkVendor',
+  new webpack.optimize.CommonsChunkPlugin({
+    name: 'vendor', // Vendor code
+    minChunks: (module) => module.context && module.context.indexOf('node_modules') !== -1
+  })
+, { before: 'manifest' })
+
+module.exports = environment
+```
+
+## Resolved modules
+
+To add new paths to `resolve.modules`, the API is same as loaders and plugins:
+
+```js
+const { environment } = require('@rails/webpacker')
+
+// Resolved modules list API - prepend, append, insert
+environment.resolvedModules.append('vendor', 'vendor')
+```
+
+### Add common chunks
+
+The CommonsChunkPlugin is an opt-in feature that creates a separate file (known as a chunk), consisting of common modules shared between multiple entry points. By separating common modules from bundles, the resulting chunked file can be loaded once initially, and stored in the cache for later use. This results in page speed optimizations as the browser can quickly serve the shared code from the cache, rather than being forced to load a larger bundle whenever a new page is visited.
+
+Add the plugins in `config/webpack/environment.js`:
+
+```js
+const webpack = require('webpack')
+
+environment.plugins.append(
+  'CommonsChunkVendor',
+  new webpack.optimize.CommonsChunkPlugin({
+    name: 'vendor',
+    minChunks: (module) => {
+      // this assumes your vendor imports exist in the node_modules directory
+      return module.context && module.context.indexOf('node_modules') !== -1
+    }
+  })
+)
+
+environment.plugins.append(
+  'CommonsChunkManifest',
+  new webpack.optimize.CommonsChunkPlugin({
+    name: 'manifest',
+    minChunks: Infinity
+  })
+)
+```
+
+Now, add these files to your `layouts/application.html.erb`:
+
+```erb
+<%# Head %>
+
+<%= javascript_pack_tag "manifest" %>
+<%= javascript_pack_tag "vendor" %>
+
+<%# If importing any styles from node_modules in your JS app %>
+
+<%= stylesheet_pack_tag "vendor" %>
+```
+
+More detailed guides available here: [webpack guides](https://webpack.js.org/guides/)

data/docs/yarn.md

@@ -0,0 +1,12 @@
+# Yarn
+
+Webpacker by default uses `yarn` as package manager for node modules
+
+
+## Add a new npm module
+
+To add any new JS module you can use `yarn`:
+
+```bash
+yarn add bootstrap material-ui
+```

data/exe/webpack

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV["JETS_ENV"] ||= ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["JETS_ENV"]
+
+require "webpacker"
+require "webpacker/webpack_runner"
+Webpacker::WebpackRunner.run(ARGV)

data/exe/webpack-dev-server

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV["JETS_ENV"] ||= ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["JETS_ENV"]
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+Webpacker::DevServerRunner.run(ARGV)

data/gemfiles/Gemfile-rails-edge

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem "webpacker", path: ".."
+
+gem "rails", github: "rails/rails"
+gem "arel", github: "rails/arel"
+gem "rake", ">= 11.1"
+gem "rubocop", ">= 0.49", require: false
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.4.2.x

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "webpacker", path: ".."
+
+gem "rails", "~> 4.2"
+gem "rake", ">= 11.1"
+gem "rubocop", ">= 0.49", require: false
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.5.0.x

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "webpacker", path: ".."
+
+gem "rails", "~> 5.0"
+gem "rake", ">= 11.1"
+gem "rubocop", ">= 0.49", require: false
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "webpacker", path: ".."
+
+gem "rails", "~> 5.1"
+gem "rake", ">= 11.1"
+gem "rubocop", ">= 0.49", require: false
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/lib/install/angular.rb

@@ -0,0 +1,27 @@
+require "webpacker/configuration"
+
+say "Copying angular loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/typescript.js", Jets.root.join("config/webpack/loaders/typescript.js").to_s
+
+say "Adding typescript loader to config/webpack/environment.js"
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "const typescript =  require('./loaders/typescript')\n",
+  after: "require('@rails/webpacker')\n"
+
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.append('typescript', typescript)\n",
+  before: "module.exports"
+
+say "Copying angular example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/angular/hello_angular.js", "#{Webpacker.config.source_entry_path}/hello_angular.js"
+
+say "Copying hello_angular app to #{Webpacker.config.source_path}"
+directory "#{__dir__}/examples/angular/hello_angular", "#{Webpacker.config.source_path}/hello_angular"
+
+say "Copying tsconfig.json to the Rails root directory for typescript"
+copy_file "#{__dir__}/examples/angular/tsconfig.json", "tsconfig.json"
+
+say "Installing all angular dependencies"
+run "yarn add typescript ts-loader core-js zone.js rxjs @angular/core @angular/common @angular/compiler @angular/platform-browser @angular/platform-browser-dynamic"
+
+say "Webpacker now supports angular and typescript 🎉", :green

data/lib/install/coffee.rb

@@ -0,0 +1,22 @@
+require "webpacker/configuration"
+
+say "Copying coffee loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/coffee.js", Jets.root.join("config/webpack/loaders/coffee.js").to_s
+
+say "Adding coffee loader to config/webpack/environment.js"
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "const coffee =  require('./loaders/coffee')\n",
+  after: "require('@rails/webpacker')\n"
+
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.append('coffee', coffee)\n",
+  before: "module.exports"
+
+say "Copying the example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/coffee/hello_coffee.coffee",
+  "#{Webpacker.config.source_entry_path}/hello_coffee.coffee"
+
+say "Installing all Coffeescript dependencies"
+run "yarn add coffeescript@1.12.7 coffee-loader"
+
+say "Webpacker now supports Coffeeescript 🎉", :green

data/lib/install/config/.babelrc

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    ["env", {
+      "modules": false,
+      "targets": {
+        "browsers": "> 1%",
+        "uglify": true
+      },
+      "useBuiltIns": true
+    }]
+  ],
+
+  "plugins": [
+    "syntax-dynamic-import",
+    "transform-object-rest-spread",
+    ["transform-class-properties", { "spec": true }]
+  ]
+}