babel-loader 8.0.5 → 8.2.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2016 Luís Couto <hello@luiscouto.pt>
+Copyright (c) 2014-2019 Luís Couto <hello@luiscouto.pt>
 
 MIT License
 

package/README.md

@@ -2,9 +2,7 @@
 > 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)
-[![Build Status](https://travis-ci.org/babel/babel-loader.svg?branch=master)](https://travis-ci.org/babel/babel-loader)
-[![Build Status](https://ci.appveyor.com/api/projects/status/77y5mk6amwqt0q88/branch/master?svg=true)](https://ci.appveyor.com/project/babel/babel-loader/branch/master)
-[![codecov](https://codecov.io/gh/babel/babel-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/babel/babel-loader)
+[![codecov](https://codecov.io/gh/babel/babel-loader/branch/main/graph/badge.svg)](https://codecov.io/gh/babel/babel-loader)
 
 <div align="center">
   <a href="https://github.com/babel/babel">
@@ -29,12 +27,6 @@ This package allows transpiling JavaScript files using [Babel](https://github.co
 npm install -D babel-loader @babel/core @babel/preset-env webpack
 ```
 
-> webpack 4.x | babel-loader 7.x | babel 6.x
-
-```bash
-npm install -D babel-loader@7 babel-core babel-preset-env webpack
-```
-
 <h2 align="center">Usage</h2>
 
 webpack documentation: [Loaders](https://webpack.js.org/loaders/)
@@ -84,13 +76,13 @@ 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 set to `true` in options (`{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.
 
 * `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.
 
-* `customize`: Default `null`. The path of a module that exports a `custom` callback [like the one that you'd pass to `.custom()`](#customized-loader). Since you already have to make a new file to use this, it is recommended that you instead use `.custom` to create a wrapper loader. Only use this is you _must_ continue using `babel-loader` directly, but still want to customize.
+* `customize`: Default `null`. The path of a module that exports a `custom` callback [like the one that you'd pass to `.custom()`](#customized-loader). Since you already have to make a new file to use this, it is recommended that you instead use `.custom` to create a wrapper loader. Only use this if you _must_ continue using `babel-loader` directly, but still want to customize.
 
 ## Troubleshooting
 
@@ -108,11 +100,11 @@ Babel uses very small helpers for common functions such as `_extend`. By default
 
 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, requiring `babel-plugin-transform-runtime` instead 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 -D @babel/plugin-transform-runtime` to include this in your project and `babel-runtime` itself as a dependency with `npm install @babel/runtime`.
+**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: [
@@ -134,7 +126,7 @@ rules: [
 
 #### **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/main/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
 // ...
@@ -190,7 +182,7 @@ If you receive this message, it means that you have the npm package `babel` inst
 
 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:
 ```javascript
   {
@@ -199,6 +191,59 @@ In the case one of your dependencies is installing `babel` and you cannot uninst
   }
 ```
 
+### Exclude libraries that should not be transpiled
+
+`core-js` and `webpack/buildin` will cause errors if they are transpiled by Babel.
+
+You will need to exclude them form `babel-loader`.
+
+```js
+{
+  "loader": "babel-loader",
+  "options": {
+    "exclude": [
+      // \\ for Windows, \/ for Mac OS and Linux
+      /node_modules[\\\/]core-js/,
+      /node_modules[\\\/]webpack[\\\/]buildin/,
+    ],
+    "presets": [
+      "@babel/preset-env"
+    ]
+  }
+}
+```
+
+## Customize config based on webpack target
+
+Webpack supports bundling multiple [targets](https://webpack.js.org/concepts/targets/). For cases where you may want different Babel configurations for each target (like `web` _and_ `node`), this loader provides a `target` property via Babel's [caller](https://babeljs.io/docs/en/config-files#apicallercb) API.
+
+For example, to change the environment targets passed to `@babel/preset-env` based on the webpack target:
+
+```javascript
+// babel.config.js
+
+module.exports = api => {
+  return {
+    plugins: [
+      "@babel/plugin-proposal-nullish-coalescing-operator",
+      "@babel/plugin-proposal-optional-chaining"
+    ],
+    presets: [
+      [
+        "@babel/preset-env",
+        {
+          useBuiltIns: "entry",
+          // caller.target will be the same as the target option from webpack
+          targets: api.caller(caller => caller && caller.target === "node")
+            ? { node: "current" }
+            : { chrome: "58", ie: "11" }
+        }
+      ]
+    ]
+  }
+}
+```
+
 ## Customized Loader
 
 `babel-loader` exposes a loader-builder utility that allows users to add custom handling

package/lib/cache.js

@@ -23,11 +23,9 @@ const zlib = require("zlib");
 
 const crypto = require("crypto");
 
-const mkdirpOrig = require("mkdirp");
-
 const findCacheDir = require("find-cache-dir");
 
-const promisify = require("util.promisify");
+const promisify = require("pify");
 
 const transform = require("./transform"); // Lazily instantiated when needed
 
@@ -37,17 +35,18 @@ const readFile = promisify(fs.readFile);
 const writeFile = promisify(fs.writeFile);
 const gunzip = promisify(zlib.gunzip);
 const gzip = promisify(zlib.gzip);
-const mkdirp = promisify(mkdirpOrig);
+
+const makeDir = require("make-dir");
 /**
  * Read the contents from the compressed file.
  *
  * @async
  * @params {String} filename
+ * @params {Boolean} compress
  */
 
-const read =
-/*#__PURE__*/
-function () {
+
+const read = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(function* (filename, compress) {
     const data = yield readFile(filename + (compress ? ".gz" : ""));
     const content = compress ? yield gunzip(data) : data;
@@ -63,13 +62,12 @@ function () {
  *
  * @async
  * @params {String} filename
+ * @params {Boolean} compress
  * @params {String} result
  */
 
 
-const write =
-/*#__PURE__*/
-function () {
+const write = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator(function* (filename, compress, result) {
     const content = JSON.stringify(result);
     const data = compress ? yield gzip(content) : content;
@@ -108,9 +106,7 @@ const filename = function (source, identifier, options) {
  */
 
 
-const handleCache =
-/*#__PURE__*/
-function () {
+const handleCache = /*#__PURE__*/function () {
   var _ref3 = _asyncToGenerator(function* (directory, params) {
     const {
       source,
@@ -130,7 +126,7 @@ function () {
     const fallback = typeof cacheDirectory !== "string" && directory !== os.tmpdir(); // Make sure the directory exists.
 
     try {
-      yield mkdirp(directory);
+      yield makeDir(directory);
     } catch (err) {
       if (fallback) {
         return handleCache(os.tmpdir(), params);
@@ -166,38 +162,28 @@ function () {
  *
  * @async
  * @param  {Object}   params
- * @param  {String}   params.directory  Directory to store cached files
- * @param  {String}   params.identifier Unique identifier to bust cache
+ * @param  {String}   params.cacheDirectory   Directory to store cached files
+ * @param  {String}   params.cacheIdentifier  Unique identifier to bust cache
+ * @param  {Boolean}  params.cacheCompression Whether compressing cached files
  * @param  {String}   params.source   Original contents of the file to be cached
  * @param  {Object}   params.options  Options to be given to the transform fn
- * @param  {Function} params.transform  Function that will transform the
- *                                      original file and whose result will be
- *                                      cached
  *
  * @example
  *
- *   cache({
- *     directory: '.tmp/cache',
- *     identifier: 'babel-loader-cachefile',
+ *   const result = await cache({
+ *     cacheDirectory: '.tmp/cache',
+ *     cacheIdentifier: 'babel-loader-cachefile',
  *     cacheCompression: false,
  *     source: *source code from file*,
  *     options: {
  *       experimental: true,
  *       runtime: true
  *     },
- *     transform: function(source, options) {
- *       var content = *do what you need with the source*
- *       return content;
- *     }
- *   }, function(err, result) {
- *
  *   });
  */
 
 
-module.exports =
-/*#__PURE__*/
-function () {
+module.exports = /*#__PURE__*/function () {
   var _ref4 = _asyncToGenerator(function* (params) {
     let directory;
 

package/lib/index.js

@@ -22,7 +22,9 @@ if (/^6\./.test(babel.version)) {
   throw new Error("\n babel-loader@8 will not work with the '@babel/core@6' bridge package. " + "If you want to use Babel 6.x, install 'babel-loader@7'.");
 }
 
-const pkg = require("../package.json");
+const {
+  version
+} = require("../package.json");
 
 const cache = require("./cache");
 
@@ -30,10 +32,16 @@ const transform = require("./transform");
 
 const injectCaller = require("./injectCaller");
 
-const path = require("path");
+const schema = require("./schema");
+
+const {
+  isAbsolute
+} = require("path");
 
 const loaderUtils = require("loader-utils");
 
+const validateOptions = require("schema-utils");
+
 function subscribe(subscriber, metadata, context) {
   if (context[subscriber]) {
     context[subscriber](metadata);
@@ -60,13 +68,16 @@ function _loader() {
   _loader = _asyncToGenerator(function* (source, inputSourceMap, overrides) {
     const filename = this.resourcePath;
     let loaderOptions = loaderUtils.getOptions(this) || {};
+    validateOptions(schema, loaderOptions, {
+      name: "Babel loader"
+    });
 
     if (loaderOptions.customize != null) {
       if (typeof loaderOptions.customize !== "string") {
         throw new Error("Customized loaders must be implemented as standalone modules.");
       }
 
-      if (!path.isAbsolute(loaderOptions.customize)) {
+      if (!isAbsolute(loaderOptions.customize)) {
         throw new Error("Customized loaders must be passed as absolute paths, since " + "babel-loader has no way to know what they would be relative to.");
       }
 
@@ -135,9 +146,13 @@ function _loader() {
 
     if (!babel.loadPartialConfig) {
       throw new Error(`babel-loader ^8.0.0-beta.3 requires @babel/core@7.0.0-beta.41, but ` + `you appear to be using "${babel.version}". Either update your ` + `@babel/core version, or pin you babel-loader version to 8.0.0-beta.2`);
-    }
+    } // babel.loadPartialConfigAsync is available in v7.8.0+
+
 
-    const config = babel.loadPartialConfig(injectCaller(programmaticOptions));
+    const {
+      loadPartialConfigAsync = babel.loadPartialConfig
+    } = babel;
+    const config = yield loadPartialConfigAsync(injectCaller(programmaticOptions, this.target));
 
     if (config) {
       let options = config.options;
@@ -165,7 +180,7 @@ function _loader() {
         cacheIdentifier = JSON.stringify({
           options,
           "@babel/core": transform.version,
-          "@babel/loader": pkg.version
+          "@babel/loader": version
         }),
         cacheCompression = true,
         metadataSubscribers = []

package/lib/injectCaller.js

@@ -2,14 +2,21 @@
 
 const babel = require("@babel/core");
 
-module.exports = function injectCaller(opts) {
+module.exports = function injectCaller(opts, target) {
   if (!supportsCallerOption()) return opts;
   return Object.assign({}, opts, {
     caller: Object.assign({
       name: "babel-loader",
+      // Provide plugins with insight into webpack target.
+      // https://github.com/babel/babel-loader/issues/787
+      target,
       // Webpack >= 2 supports ESM and dynamic import.
       supportsStaticESM: true,
-      supportsDynamicImport: true
+      supportsDynamicImport: true,
+      // Webpack 5 supports TLA behind a flag. We enable it by default
+      // for Babel, and then webpack will throw an error if the experimental
+      // flag isn't enabled.
+      supportsTopLevelAwait: true
     }, opts.caller)
   });
 }; // TODO: We can remove this eventually, I'm just adding it so that people have

package/lib/schema.json

@@ -0,0 +1,28 @@
+{
+  "type": "object",
+  "properties": {
+    "cacheDirectory": {
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string"
+        }
+      ],
+      "default": false
+    },
+    "cacheIdentifier": {
+      "type": "string"
+    },
+    "cacheCompression": {
+      "type": "boolean",
+      "default": true
+    },
+    "customize": {
+      "type": "string",
+      "default": null
+    }
+  },
+  "additionalProperties": true
+}

package/lib/transform.js

@@ -6,15 +6,13 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
 
 const babel = require("@babel/core");
 
-const promisify = require("util.promisify");
+const promisify = require("pify");
 
 const LoaderError = require("./Error");
 
 const transform = promisify(babel.transform);
 
-module.exports =
-/*#__PURE__*/
-function () {
+module.exports = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(function* (source, options) {
     let result;
 
@@ -26,7 +24,7 @@ function () {
 
     if (!result) return null; // We don't return the full result here because some entries are not
     // really serializable. For a full list of properties see here:
-    // https://github.com/babel/babel/blob/master/packages/babel-core/src/transformation/index.js
+    // https://github.com/babel/babel/blob/main/packages/babel-core/src/transformation/index.js
     // For discussion on this topic see here:
     // https://github.com/babel/babel-loader/pull/629
 

package/package.json

@@ -1,51 +1,55 @@
 {
   "name": "babel-loader",
-  "version": "8.0.5",
+  "version": "8.2.1",
   "description": "babel module loader for webpack",
   "files": [
     "lib"
   ],
   "main": "lib/index.js",
   "engines": {
-    "node": ">= 6.9"
+    "node": ">= 8.9"
   },
   "dependencies": {
-    "find-cache-dir": "^2.0.0",
-    "loader-utils": "^1.0.2",
-    "mkdirp": "^0.5.1",
-    "util.promisify": "^1.0.0"
+    "find-cache-dir": "^2.1.0",
+    "loader-utils": "^1.4.0",
+    "make-dir": "^2.1.0",
+    "pify": "^4.0.1",
+    "schema-utils": "^2.6.5"
   },
   "peerDependencies": {
     "@babel/core": "^7.0.0",
     "webpack": ">=2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.2.0",
-    "@babel/core": "^7.2.0",
-    "@babel/preset-env": "^7.2.0",
-    "ava": "1.0.1",
+    "@ava/babel": "^1.0.1",
+    "@babel/cli": "^7.12.1",
+    "@babel/core": "^7.12.3",
+    "@babel/preset-env": "^7.12.1",
+    "ava": "^3.13.0",
     "babel-eslint": "^10.0.1",
-    "babel-plugin-istanbul": "^5.1.0",
-    "babel-plugin-react-intl": "^3.0.1",
-    "cross-env": "^5.2.0",
-    "eslint": "^5.9.0",
-    "eslint-config-babel": "^8.0.2",
-    "eslint-config-prettier": "^3.3.0",
-    "eslint-plugin-flowtype": "^3.2.0",
+    "babel-plugin-istanbul": "^6.0.0",
+    "babel-plugin-react-intl": "^8.2.15",
+    "cross-env": "^7.0.2",
+    "eslint": "^7.13.0",
+    "eslint-config-babel": "^9.0.0",
+    "eslint-config-prettier": "^6.3.0",
+    "eslint-plugin-flowtype": "^5.2.0",
     "eslint-plugin-prettier": "^3.0.0",
-    "husky": "^1.2.0",
-    "lint-staged": "^8.1.0",
-    "nyc": "^13.1.0",
-    "prettier": "^1.15.3",
-    "react": "^16.0.0",
-    "react-intl": "^2.1.2",
+    "husky": "^4.3.0",
+    "lint-staged": "^10.5.1",
+    "nyc": "^15.1.0",
+    "pnp-webpack-plugin": "^1.6.4",
+    "prettier": "^2.1.2",
+    "react": "^17.0.1",
+    "react-intl": "^5.9.4",
     "react-intl-webpack-plugin": "^0.3.0",
-    "rimraf": "^2.4.3",
-    "webpack": "^4.0.0"
+    "rimraf": "^3.0.0",
+    "semver": "7.3.2",
+    "webpack": "^5.4.0"
   },
   "scripts": {
     "clean": "rimraf lib/",
-    "build": "babel src/ --out-dir lib/",
+    "build": "babel src/ --out-dir lib/ --copy-files",
     "format": "prettier --write --trailing-comma all 'src/**/*.js' 'test/**/*.test.js' 'test/helpers/*.js' && prettier --write --trailing-comma es5 'scripts/*.js'",
     "lint": "eslint src test",
     "precommit": "lint-staged",
@@ -90,9 +94,11 @@
       "!test/fixtures/**/*",
       "!test/helpers/**/*"
     ],
-    "sources": [
-      "src/**/*.js"
-    ]
+    "babel": {
+      "compileAsTests": [
+        "test/helpers/**/*"
+      ]
+    }
   },
   "lint-staged": {
     "scripts/*.js": [
@@ -116,4 +122,4 @@
       "git add yarn.lock"
     ]
   }
-}
+}