babel-loader 8.0.1 → 8.0.2

package/README.md

@@ -1,4 +1,4 @@
-> This readme is for babel-loader v8 + Babel v7  
+> This README is for babel-loader v8 + Babel v7
 > Check the [7.x branch](https://github.com/babel/babel-loader/tree/7.x) for docs with Babel v6
 
 [![NPM Status](https://img.shields.io/npm/v/babel-loader.svg?style=flat)](https://www.npmjs.com/package/babel-loader)
@@ -7,18 +7,19 @@
 [![codecov](https://codecov.io/gh/babel/babel-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/babel/babel-loader)
 
 <div align="center">
-  <a href="https://github.com/babel/babel/">
-    <img width="200" height="200" src="https://rawgit.com/babel/logo/master/babel.svg">
+  <a href="https://github.com/babel/babel">
+    <img src="https://rawgit.com/babel/logo/master/babel.svg" alt="Babel logo" width="200" height="200">
   </a>
   <a href="https://github.com/webpack/webpack">
-    <img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg">
+    <img src="https://webpack.js.org/assets/icon-square-big.svg" alt="webpack logo" width="200" height="200">
   </a>
-  <h1>Babel Loader</h1>
 </div>
 
+<h1 align="center">Babel Loader</h1>
+
 This package allows transpiling JavaScript files using [Babel](https://github.com/babel/babel) and [webpack](https://github.com/webpack/webpack).
 
-__Notes:__ Issues with the output should be reported on the babel [issue tracker](https://github.com/babel/babel/issues).
+**Note**: Issues with the output should be reported on the Babel [Issues](https://github.com/babel/babel/issues) tracker.
 
 <h2 align="center">Install</h2>
 
@@ -36,7 +37,7 @@ npm install -D babel-loader@7 babel-core babel-preset-env webpack
 
 <h2 align="center">Usage</h2>
 
-[Documentation: Using loaders](https://webpack.js.org/loaders/)
+webpack documentation: [Loaders](https://webpack.js.org/loaders/)
 
 Within your webpack configuration object, you'll need to add the babel-loader to the list of modules, like so:
 
@@ -61,8 +62,7 @@ module: {
 
 See the `babel` [options](https://babeljs.io/docs/usage/api/#options).
 
-
-You can pass options to the loader by using the [options property](https://webpack.js.org/configuration/module/#rule-options-rule-query):
+You can pass options to the loader by using the [`options`](https://webpack.js.org/configuration/module/#rule-options-rule-query) property:
 
 ```javascript
 module: {
@@ -84,43 +84,40 @@ module: {
 
 This loader also supports the following loader-specific option:
 
-* `cacheDirectory`: Default `false`. When set, the given directory will be used to cache the results of the loader. Future webpack builds will attempt to read from the cache to avoid needing to run the potentially expensive Babel recompilation process on each run. If the value is blank (`loader: 'babel-loader?cacheDirectory'`) or `true` (`loader: babel-loader?cacheDirectory=true`) the loader will use the default cache directory in `node_modules/.cache/babel-loader` or fallback to the default OS temporary file directory if no `node_modules` folder could be found in any root directory.
+* `cacheDirectory`: Default `false`. When set, the given directory will be used to cache the results of the loader. Future webpack builds will attempt to read from the cache to avoid needing to run the potentially expensive Babel recompilation process on each run. If the value is blank (`loader: 'babel-loader?cacheDirectory'`) or `true` (`loader: 'babel-loader?cacheDirectory=true'`), the loader will use the default cache directory in `node_modules/.cache/babel-loader` or fallback to the default OS temporary file directory if no `node_modules` folder could be found in any root directory.
 
-* `cacheIdentifier`: Default is a string composed by the babel-core's version, the babel-loader's version, the contents of .babelrc file if it exists and the value of the environment variable `BABEL_ENV` with a fallback to the `NODE_ENV` environment variable. This can be set to a custom value to force cache busting if the identifier changes.
+* `cacheIdentifier`: Default is a string composed by the `babel-core`'s version, the `babel-loader`'s version, the contents of `.babelrc` file if it exists, and the value of the environment variable `BABEL_ENV` with a fallback to the `NODE_ENV` environment variable. This can be set to a custom value to force cache busting if the identifier changes.
 
-__Note:__ The `sourceMap` option is ignored, instead sourceMaps are automatically enabled when webpack is configured to use them (via the `devtool` config option).
+* `cacheCompression`: Default `true`. When set, each Babel transform output will be compressed with Gzip. If you want to opt-out of cache compression, set it to `false` -- your project may benefit from this if it transpiles thousands of files.
+
+**Note**: The `sourceMap` option is ignored. Instead, source maps are automatically enabled when webpack is configured to use them (via the [`devtool`](https://webpack.js.org/configuration/devtool/#devtool) config option).
 
 ## Troubleshooting
 
 ### babel-loader is slow!
 
-Make sure you are transforming as few files as possible. Because you are probably
-matching `/\.js$/`, you might be transforming the `node_modules` folder or other unwanted
-source.
+Make sure you are transforming as few files as possible. Because you are probably matching `/\.js$/`, you might be transforming the `node_modules` folder or other unwanted source.
 
 To exclude `node_modules`, see the `exclude` option in the `loaders` config as documented above.
 
-You can also speed up babel-loader by as much as 2x by using the `cacheDirectory` option.
-This will cache transformations to the filesystem.
+You can also speed up babel-loader by as much as 2x by using the `cacheDirectory` option. This will cache transformations to the filesystem.
 
-### babel is injecting helpers into each file and bloating my code!
+### Babel is injecting helpers into each file and bloating my code!
 
-babel uses very small helpers for common functions such as `_extend`. By default
-this will be added to every file that requires it.
+Babel uses very small helpers for common functions such as `_extend`. By default, this will be added to every file that requires it.
 
-You can instead require the babel runtime as a separate module to avoid the duplication.
+You can instead require the Babel runtime as a separate module to avoid the duplication.
 
-The following configuration disables automatic per-file runtime injection in babel, instead
-requiring `babel-plugin-transform-runtime` and making all helper references use it.
+The following configuration disables automatic per-file runtime injection in Babel, requiring `babel-plugin-transform-runtime` instead and making all helper references use it.
 
 See the [docs](https://babeljs.io/docs/plugins/transform-runtime/) for more information.
 
-**NOTE:** You must run `npm install @babel/plugin-transform-runtime --save-dev` to include this in your project and `babel-runtime` itself as a dependency with `npm install @babel/runtime --save`.
+**NOTE**: You must run `npm install -D @babel/plugin-transform-runtime` to include this in your project and `babel-runtime` itself as a dependency with `npm install @babel/runtime`.
 
 ```javascript
 rules: [
-  // the 'transform-runtime' plugin tells babel to require the runtime
-  // instead of inlining it.
+  // the 'transform-runtime' plugin tells Babel to
+  // require the runtime instead of inlining it.
   {
     test: /\.js$/,
     exclude: /(node_modules|bower_components)/,
@@ -135,9 +132,9 @@ rules: [
 ]
 ```
 
-#### **NOTE:** transform-runtime & custom polyfills (e.g. Promise library)
+#### **NOTE**: transform-runtime & custom polyfills (e.g. Promise library)
 
-Since [babel-plugin-transform-runtime](https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-runtime) includes a polyfill that includes a custom [regenerator runtime](https://github.com/facebook/regenerator/blob/master/packages/regenerator-runtime/runtime.js) and [core.js](https://github.com/zloirock/core-js), the following usual shimming method using `webpack.ProvidePlugin` will not work:
+Since [babel-plugin-transform-runtime](https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-runtime) includes a polyfill that includes a custom [regenerator-runtime](https://github.com/facebook/regenerator/blob/master/packages/regenerator-runtime/runtime.js) and [core-js](https://github.com/zloirock/core-js), the following usual shimming method using `webpack.ProvidePlugin` will not work:
 
 ```javascript
 // ...
@@ -181,21 +178,21 @@ require('@babel/runtime/core-js/promise').default = require('bluebird');
 require('./app');
 ```
 
-### The node API for `babel` has been moved to `babel-core`.
+### The Node.js API for `babel` has been moved to `babel-core`.
 
-If you receive this message it means that you have the npm package `babel` installed and use the short notation of the loader in the webpack config (which is not valid anymore as of webpack 2.x):
-```js
+If you receive this message, it means that you have the npm package `babel` installed and are using the short notation of the loader in the webpack config (which is not valid anymore as of webpack 2.x):
+```javascript
   {
     test: /\.js$/,
     loader: 'babel',
   }
 ```
 
-Webpack then tries to load the `babel` package instead of the `babel-loader`.
+webpack then tries to load the `babel` package instead of the `babel-loader`.
 
-To fix this you should uninstall the npm package `babel` as it is deprecated in babel v6. (instead install `babel-cli` or `babel-core`)
+To fix this, you should uninstall the npm package `babel`, as it is deprecated in Babel v6. (Instead, install `babel-cli` or `babel-core`.)
 In the case one of your dependencies is installing `babel` and you cannot uninstall it yourself, use the complete name of the loader in the webpack config:
-```js
+```javascript
   {
     test: /\.js$/,
     loader: 'babel-loader',

package/lib/cache.js

@@ -46,13 +46,13 @@ const mkdirp = promisify(mkdirpOrig);
 const read =
 /*#__PURE__*/
 function () {
-  var _ref = _asyncToGenerator(function* (filename) {
-    const data = yield readFile(filename);
-    const content = yield gunzip(data);
-    return JSON.parse(content);
+  var _ref = _asyncToGenerator(function* (filename, compress) {
+    const data = yield readFile(filename + (compress ? ".gz" : ""));
+    const content = compress ? yield gunzip(data) : data;
+    return JSON.parse(content.toString());
   });
 
-  return function read(_x) {
+  return function read(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -68,13 +68,13 @@ function () {
 const write =
 /*#__PURE__*/
 function () {
-  var _ref2 = _asyncToGenerator(function* (filename, result) {
+  var _ref2 = _asyncToGenerator(function* (filename, compress, result) {
     const content = JSON.stringify(result);
-    const data = yield gzip(content);
-    return yield writeFile(filename, data);
+    const data = compress ? yield gzip(content) : content;
+    return yield writeFile(filename + (compress ? ".gz" : ""), data);
   });
 
-  return function write(_x2, _x3) {
+  return function write(_x3, _x4, _x5) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -96,7 +96,7 @@ const filename = function (source, identifier, options) {
     identifier
   });
   hash.update(contents);
-  return hash.digest("hex") + ".json.gz";
+  return hash.digest("hex") + ".json";
 };
 /**
  * Handle the cache
@@ -114,14 +114,15 @@ function () {
       source,
       options = {},
       cacheIdentifier,
-      cacheDirectory
+      cacheDirectory,
+      cacheCompression
     } = params;
     const file = path.join(directory, filename(source, cacheIdentifier, options));
 
     try {
       // No errors mean that the file was previously cached
       // we just need to return it
-      return yield read(file);
+      return yield read(file, cacheCompression);
     } catch (err) {}
 
     const fallback = typeof cacheDirectory !== "string" && directory !== os.tmpdir(); // Make sure the directory exists.
@@ -141,7 +142,7 @@ function () {
     const result = yield transform(source, options);
 
     try {
-      yield write(file, result);
+      yield write(file, cacheCompression, result);
     } catch (err) {
       if (fallback) {
         // Fallback to tmpdir if node_modules folder not writable
@@ -154,7 +155,7 @@ function () {
     return result;
   });
 
-  return function handleCache(_x4, _x5) {
+  return function handleCache(_x6, _x7) {
     return _ref3.apply(this, arguments);
   };
 }();
@@ -176,6 +177,7 @@ function () {
  *   cache({
  *     directory: '.tmp/cache',
  *     identifier: 'babel-loader-cachefile',
+ *     cacheCompression: false,
  *     source: *source code from file*,
  *     options: {
  *       experimental: true,
@@ -212,7 +214,7 @@ function () {
     return yield handleCache(directory, params);
   });
 
-  return function (_x6) {
+  return function (_x8) {
     return _ref4.apply(this, arguments);
   };
 }();

package/lib/index.js

@@ -26,8 +26,6 @@ const cache = require("./cache");
 
 const transform = require("./transform");
 
-const relative = require("./utils/relative");
-
 const loaderUtils = require("loader-utils");
 
 function subscribe(subscriber, metadata, context) {
@@ -71,24 +69,33 @@ function _loader() {
 
     if (typeof loaderOptions.babelrc === "string") {
       console.warn("The option `babelrc` should not be set to a string anymore in the babel-loader config. " + "Please update your configuration and set `babelrc` to true or false.\n" + "If you want to specify a specific babel config file to inherit config from " + "please use the `extends` option.\nFor more information about this options see " + "https://babeljs.io/docs/core-packages/#options");
-    } // Set babel-loader's default options.
+    } // Standardize on 'sourceMaps' as the key passed through to Webpack, so that
+    // users may safely use either one alongside our default use of
+    // 'this.sourceMap' below without getting error about conflicting aliases.
+
 
+    if (Object.prototype.hasOwnProperty.call(loaderOptions, "sourceMap") && !Object.prototype.hasOwnProperty.call(loaderOptions, "sourceMaps")) {
+      loaderOptions = Object.assign({}, loaderOptions, {
+        sourceMaps: loaderOptions.sourceMap
+      });
+      delete loaderOptions.sourceMap;
+    }
 
-    const {
-      sourceRoot = process.cwd(),
-      sourceMap = this.sourceMap,
-      sourceFileName = relative(sourceRoot, filename)
-    } = loaderOptions;
     const programmaticOptions = Object.assign({}, loaderOptions, {
       filename,
       inputSourceMap: inputSourceMap || undefined,
-      sourceRoot,
-      sourceMap,
-      sourceFileName
+      // Set the default sourcemap behavior based on Webpack's mapping flag,
+      // but allow users to override if they want.
+      sourceMaps: loaderOptions.sourceMaps === undefined ? this.sourceMap : loaderOptions.sourceMaps,
+      // Ensure that Webpack will get a full absolute path in the sourcemap
+      // so that it can properly map the module back to its internal cached
+      // modules.
+      sourceFileName: filename
     }); // Remove loader related options
 
     delete programmaticOptions.cacheDirectory;
     delete programmaticOptions.cacheIdentifier;
+    delete programmaticOptions.cacheCompression;
     delete programmaticOptions.metadataSubscribers;
 
     if (!babel.loadPartialConfig) {
@@ -107,6 +114,16 @@ function _loader() {
         });
       }
 
+      if (options.sourceMaps === "inline") {
+        // Babel has this weird behavior where if you set "inline", we
+        // inline the sourcemap, and set 'result.map = null'. This results
+        // in bad behavior from Babel since the maps get put into the code,
+        // which Webpack does not expect, and because the map we return to
+        // Webpack is null, which is also bad. To avoid that, we override the
+        // behavior here so "inline" just behaves like 'true'.
+        options.sourceMaps = true;
+      }
+
       const {
         cacheDirectory = null,
         cacheIdentifier = JSON.stringify({
@@ -114,6 +131,7 @@ function _loader() {
           "@babel/core": transform.version,
           "@babel/loader": pkg.version
         }),
+        cacheCompression = true,
         metadataSubscribers = []
       } = loaderOptions;
       let result;
@@ -124,7 +142,8 @@ function _loader() {
           options,
           transform,
           cacheDirectory,
-          cacheIdentifier
+          cacheIdentifier,
+          cacheCompression
         });
       } else {
         result = yield transform(source, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-loader",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "babel module loader for webpack",
   "files": [
     "lib"

package/lib/utils/relative.js

@@ -1,15 +0,0 @@
-"use strict";
-
-const path = require("path");
-
-module.exports = function relative(root, file) {
-  const rootPath = root.replace(/\\/g, "/").split("/")[1];
-  const filePath = file.replace(/\\/g, "/").split("/")[1]; // If the file is in a completely different root folder
-  // use the absolute path of the file
-
-  if (rootPath && rootPath !== filePath) {
-    return file;
-  }
-
-  return path.relative(root, file);
-};