webpacker 4.2.2 → 5.2.0

data/docs/testing.md

@@ -10,8 +10,7 @@ Webpacker does not setup `Karma` by default, so you've to manually install it al
   "test": "NODE_ENV=test karma start"
 },
 "dependencies": {
-  "typescript": "^2.5.2",
-  "ts-loader": "^2.3.7"
+  "typescript": "^2.5.2"
 },
 "devDependencies": {
   "karma": "^1.7.1",
@@ -33,7 +32,7 @@ It is beneficial to use the same webpack configuration file (generated by webpac
 ```js
 // config/webpack/test.js
 const environment = require('./environment')
-environment.plugins.get('Manifest').opts.writeToFileEmit = process.env.NODE_ENV !== 'test'
+environment.plugins.get('Manifest').options.writeToFileEmit = process.env.NODE_ENV !== 'test'
 environment.loaders.append('istanbul-instrumenter', {
   test: /\.ts$/,
   enforce: "post",

data/docs/troubleshooting.md

@@ -4,11 +4,13 @@
 
 1. Read the error message carefully. The error message will tell you the precise key value
    that is not matching what Webpack expects.
-2. Put a `debugger` statement in your Webpack configuration and run `bin/webpack --debug`.
+2. Put a `debugger` statement in your Webpack configuration and run `bin/webpack --debug-webpacker`.
    If you have a node debugger installed, you'll see the Chrome debugger for your webpack
    config. For example, install the Chrome extension [NiM](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj) and
    set the option for the dev tools to open automatically. For more details on debugging,
    see the official [Webpack docs on debugging](https://webpack.js.org/contribute/debugging/#devtools)
+3. Any arguments that you add to bin/webpack get sent to webpack. For example, you can pass `--debug` to switch loaders to debug mode. See [webpack CLI debug options](https://webpack.js.org/api/cli/#debug-options) for more information on the available options.
+4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-webpacker`
 
 ## ENOENT: no such file or directory - node-sass
 

data/docs/typescript.md

@@ -1,19 +1,98 @@
-# Typescript
+# TypeScript
 
+## Installation
 
-## Typescript with React
+1. Run the TypeScript installer
 
-1. Setup react using Webpacker [react installer](../README.md#react). Then 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
-yarn add @types/react @types/react-dom
 ```
 
-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.
+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
+## TypeScript with Vue components
 
 1. Setup Vue using the Webpacker [Vue installer](../README.md#vue). Then run the TypeScript installer
 
@@ -22,37 +101,22 @@ bundle exec rails webpacker:install:typescript
 ```
 
 2. Rename generated `hello_vue.js` to `hello_vue.ts`.
-3. Add the webpack plug-n-play plugin to your yarn packages with `yarn add pnp-webpack-plugin`.
-4. Change the generated `config/webpack/loaders/typescript.js` from
+3. Install the right Babel preset: `yarn add babel-preset-typescript-vue`
+4. Change the generated `babel.config.js` from
 
 ```js
-module.exports = {
-  test: /\.(ts|tsx)?(\.erb)?$/,
-  use: [{
-    loader: 'ts-loader'
-  }]
-}
+["@babel/preset-typescript", { "allExtensions": true, "isTSX": true }]
 ```
 
 to
 
 ```js
-const PnpWebpackPlugin = require('pnp-webpack-plugin');
-
-module.exports = {
-  test: /\.(ts|tsx)?(\.erb)?$/,
-  use: [{
-    loader: 'ts-loader',
-    options: PnpWebpackPlugin.tsLoaderOptions({
-      appendTsSuffixTo: [/\.vue$/]
-    })
-  }]
-}
+["babel-preset-typescript-vue", { "allExtensions": true, "isTSX": true }]
 ```
 
-and now you can use `<script lang="ts">` in your `.vue` component files. See [the pnp-webpack-plugin docs for the `ts-loader` integration](https://github.com/arcanis/pnp-webpack-plugin#ts-loader-integration) for more info.
+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
+## 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:

data/docs/webpack-dev-server.md

@@ -19,7 +19,7 @@ Now if you refresh your Rails view everything should work as expected.
 Webpacker out-of-the-box supports HMR with `webpack-dev-server` and
 you can toggle it by setting `dev_server/hmr` option inside `webpacker.yml`.
 
-Checkout this guide for more information:
+Check out this guide for more information:
 
 - https://webpack.js.org/configuration/dev-server/#devserver-hot
 

data/lib/install/config/babel.config.js

@@ -56,9 +56,7 @@ module.exports = function(api) {
       [
         '@babel/plugin-transform-runtime',
         {
-          helpers: false,
-          regenerator: true,
-          corejs: false
+          helpers: false
         }
       ],
       [

data/lib/install/config/webpacker.yml

@@ -6,12 +6,11 @@ default: &default
   public_root_path: public
   public_output_path: packs
   cache_path: tmp/cache/webpacker
-  check_yarn_integrity: false
   webpack_compile_output: true
 
   # Additional paths webpack should lookup modules
   # ['app/assets', 'engine/foo/app/assets']
-  resolved_paths: []
+  additional_paths: []
 
   # Reload manifest.json on all requests so we reload latest compiled packs
   cache_manifest: false
@@ -52,9 +51,6 @@ development:
   <<: *default
   compile: true
 
-  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
-  check_yarn_integrity: true
-
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
     https: false

data/lib/install/examples/react/tsconfig.json

@@ -8,7 +8,8 @@
     "moduleResolution": "node",
     "sourceMap": true,
     "target": "es5",
-    "jsx": "react"
+    "jsx": "react",
+    "noEmit": true
   },
   "exclude": [
     "**/*.spec.ts",

data/lib/install/examples/typescript/tsconfig.json

@@ -11,7 +11,8 @@
         "*": ["node_modules/*", "app/javascript/*"]
     },
     "sourceMap": true,
-    "target": "es5"
+    "target": "es5",
+    "noEmit": true
   },
   "exclude": [
     "**/*.spec.ts",

data/lib/install/loaders/svelte.js

@@ -1,9 +1,9 @@
 module.exports = {
-  test: /\.svelte$/,
+  test: /\.svelte(\.erb)?$/,
   use: [{
     loader: 'svelte-loader',
     options: {
-      hotReload: true
+      hotReload: false
     }
   }],
 }

data/lib/install/template.rb

@@ -1,7 +1,7 @@
 # Install Webpacker
 copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
 
-puts "Copying webpack core config"
+say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack"
 
 say "Copying postcss.config.js to app root directory"

data/lib/install/typescript.rb

@@ -15,17 +15,10 @@ if File.exist?(package_json)
   end
 end
 
-say "Copying typescript loader to config/webpack/loaders"
-copy_file "#{__dir__}/loaders/typescript.js", Rails.root.join("config/webpack/loaders/typescript.js").to_s
-
-say "Adding typescript loader to config/webpack/environment.js"
-insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
-  "const typescript =  require('./loaders/typescript')\n",
-  after: /require\(('|")@rails\/webpacker\1\);?\n/
-
-insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
-  "environment.loaders.prepend('typescript', typescript)\n",
-  before: "module.exports"
+say "Adding TypeScript preset to babel.config.js"
+insert_into_file Rails.root.join("babel.config.js").to_s,
+  ",\n      ['@babel/preset-typescript', { 'allExtensions': true, 'isTSX': true }]",
+  before: /\s*\].filter\(Boolean\),\n\s*plugins: \[/
 
 say "Copying tsconfig.json to the Rails root directory for typescript"
 copy_file "#{__dir__}/examples/#{example_source}/tsconfig.json", "tsconfig.json"
@@ -41,6 +34,6 @@ copy_file "#{__dir__}/examples/typescript/hello_typescript.ts",
   "#{Webpacker.config.source_entry_path}/hello_typescript.ts"
 
 say "Installing all typescript dependencies"
-run "yarn add typescript ts-loader #{additional_packages}"
+run "yarn add typescript @babel/preset-typescript #{additional_packages}"
 
 say "Webpacker now supports typescript 🎉", :green

data/lib/tasks/webpacker/check_node.rake

@@ -1,24 +1,31 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Node.js is installed"
   task :check_node do
     begin
-      node_version = `node -v || nodejs -v`
+      node_version = `node -v || nodejs -v`.strip
       raise Errno::ENOENT if node_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      node_requirement = JSON.parse(pkg_path.read)["engines"]["node"]
+      node_range = JSON.parse(pkg_path.read)["engines"]["node"]
+      is_valid = SemanticRange.satisfies?(node_version, node_range) rescue false
+      semver_major = node_version[/\d+/] rescue nil
+      is_unstable = semver_major.to_i.odd? rescue false
 
-      requirement = Gem::Requirement.new(node_requirement)
-      version = Gem::Version.new(node_version.strip.tr("v", ""))
+      if is_unstable
+        $stderr.puts "Warning: you are using an unstable release of Node.js (#{node_version}). If you encounter issues with Node.js, consider switching to an Active LTS release. More info: https://docs.npmjs.com/try-the-latest-stable-version-of-node"
+      end
 
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Node.js #{requirement} and you are using #{version}"
+      unless is_valid
+        $stderr.puts "Webpacker requires Node.js \"#{node_range}\" and you are using #{node_version}"
         $stderr.puts "Please upgrade Node.js https://nodejs.org/en/download/"
-        $stderr.puts "Exiting!" && exit!
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Node.js not installed. Please download and install Node.js https://nodejs.org/en/download/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/check_yarn.rake

@@ -1,24 +1,31 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Yarn is installed"
   task :check_yarn do
     begin
-      yarn_version = `yarn --version`
+      yarn_version = `yarn --version`.strip
       raise Errno::ENOENT if yarn_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      yarn_requirement = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      yarn_range = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      is_valid = SemanticRange.satisfies?(yarn_version, yarn_range) rescue false
+      is_unsupported = SemanticRange.satisfies?(yarn_version, ">=2.0.0") rescue false
 
-      requirement = Gem::Requirement.new(yarn_requirement)
-      version = Gem::Version.new(yarn_version)
-
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Yarn #{requirement} and you are using #{version}"
-        $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
-        $stderr.puts "Exiting!" && exit!
+      unless is_valid
+        $stderr.puts "Webpacker requires Yarn \"#{yarn_range}\" and you are using #{yarn_version}"
+        if is_unsupported
+          $stderr.puts "This version of Webpacker does not support Yarn #{yarn_version}. Please downgrade to a supported version of Yarn https://yarnpkg.com/lang/en/docs/install/"
+          $stderr.puts "For information on using Webpacker with Yarn 2.0, see https://github.com/rails/webpacker/issues/2112"
+        else
+          $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
+        end
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/clean.rake

@@ -4,16 +4,22 @@ require "webpacker/configuration"
 
 namespace :webpacker do
   desc "Remove old compiled webpacks"
-  task :clean, [:keep] => ["webpacker:verify_install", :environment] do |_, args|
+  task :clean, [:keep, :age] => ["webpacker:verify_install", :environment] do |_, args|
     Webpacker.ensure_log_goes_to_stdout do
-      Webpacker.clean(Integer(args.keep || 2))
+      Webpacker.clean(Integer(args.keep || 2), Integer(args.age || 3600))
     end
   end
 end
 
-# Run clean if the assets:clean is run
-if Rake::Task.task_defined?("assets:clean")
-  Rake::Task["assets:clean"].enhance do
-    Rake::Task["webpacker:clean"].invoke
+skip_webpacker_clean = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clean
+  # Run clean if the assets:clean is run
+  if Rake::Task.task_defined?("assets:clean")
+    Rake::Task["assets:clean"].enhance do
+      Rake::Task["webpacker:clean"].invoke
+    end
+  else
+    Rake::Task.define_task("assets:clean" => "webpacker:clean")
   end
 end

data/lib/tasks/webpacker/clobber.rake

@@ -8,9 +8,13 @@ namespace :webpacker do
   end
 end
 
-# Run clobber if the assets:clobber is run
-if Rake::Task.task_defined?("assets:clobber")
-  Rake::Task["assets:clobber"].enhance do
-    Rake::Task["webpacker:clobber"].invoke
+skip_webpacker_clobber = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clobber
+  # Run clobber if the assets:clobber is run
+  if Rake::Task.task_defined?("assets:clobber")
+    Rake::Task["assets:clobber"].enhance do
+      Rake::Task["webpacker:clobber"].invoke
+    end
   end
 end

data/lib/tasks/webpacker/yarn_install.rake

@@ -1,21 +1,10 @@
 namespace :webpacker do
   desc "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
   task :yarn_install do
-    system "yarn install --no-progress"
-
-    exit(1) unless $?.success?
+    valid_node_envs = %w[test development production]
+    node_env = ENV.fetch("NODE_ENV") do
+      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+    end
+    system({ "NODE_ENV" => node_env }, "yarn install --no-progress --frozen-lockfile")
   end
 end
-
-def enhance_yarn_install
-  Rake::Task["yarn:install"].enhance do
-    exit(1) unless $?.success?
-  end
-end
-
-if Rake::Task.task_defined?("yarn:install")
-  enhance_yarn_install
-else
-  # this is mainly for pre-5.x era
-  Rake::Task.define_task("yarn:install" => "webpacker:yarn_install")
-end