jetpacker 0.1.0 → 0.2.0

data/docs/webpack.md

@@ -0,0 +1,364 @@
+# 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('@rails/webpacker')
+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)
+environment.config.merge({ devtool: 'none' })
+
+// 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')
+
+const jsonLoader = {
+  test: /\.json$/,
+  use: 'json-loader'
+}
+
+// Insert json loader at the end of list
+environment.loaders.append('json', jsonLoader)
+
+// 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' })
+
+const fileLoader = environment.loaders.get('file')
+fileLoader.exclude = /\.(svg)$/i
+```
+
+
+### Url Loader
+
+```js
+// config/webpack/loaders/url.js
+
+module.exports = {
+  test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
+  use: [{
+    loader: 'url-loader',
+    options: {
+      limit: 10000,
+      name: '[name]-[hash].[ext]'
+    }
+  }]
+}
+
+// config/webpack/environment.js
+
+const { environment } = require('@rails/webpacker')
+const url = require('./loaders/url')
+
+environment.loaders.prepend('url', url)
+
+// avoid using both file and url loaders
+environment.loaders.get('file').test = /\.(tiff|ico|svg|eot|otf|ttf|woff|woff2)$/i
+```
+
+### 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: {
+    localIdentName: '[name]__[local]___[hash:base64:5]'
+  },
+  sourceMap: true,
+}
+
+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.options.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 SplitChunks (Webpack V4)
+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.
+
+Since 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
+
+// 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' %>
+
+<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 when using this 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' %>
+```
+
+For the old configuration with the CommonsChunkPlugin see below. **Note** that this functionality is deprecated in Webpack V4.
+
+#### Preloading
+
+Before preload or prefetch your assets, please read [https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content](https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content).
+
+Webpack also provide it's own methods for preload or prefetch [https://medium.com/webpack/link-rel-prefetch-preload-in-webpack-51a52358f84c](https://medium.com/webpack/link-rel-prefetch-preload-in-webpack-51a52358f84c).
+
+You can preload your assets with the `preload_pack_asset` helper if you have Rails >= 5.2.x.
+
+```erb
+<%= preload_pack_asset 'fonts/fa-regular-400.woff2' %>
+```
+
+**Warning:** You don't want to preload the css, you want to preload the fonts and images inside the css so that fonts, css, and images can all be downloaded in parallel instead of waiting for the browser to parse the css.
+
+### Add common chunks (deprecated in Webpack V4)
+
+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,23 @@
+# Yarn
+
+Webpacker by default uses `yarn` as a 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
+```
+
+## Add an npm module to `devDependencies`
+To add a new JS module that will only be available to local development:
+
+```bash
+yarn add --dev browser-sync
+```
+
+Be careful not to add any build or app related JS modules in this fashion. Adding JS modules to `devDependencies` [will block them from being installed in **any** production environment](https://yarnpkg.com/lang/en/docs/cli/install/#toc-yarn-install-production-true-false).
+
+Docs from JS modules may instruct you to use `--dev` or `devDependencies`, but this is generally under the assumption that you are using a `node.js` workflow.

data/gemfiles/Gemfile-rails-edge

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

data/gemfiles/Gemfile-rails.4.2.x

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

data/gemfiles/Gemfile-rails.5.0.x

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

data/gemfiles/Gemfile-rails.5.1.x

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

data/gemfiles/Gemfile-rails.5.2.x

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

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 6.0.0.rc2"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"