babel-loader 9.1.2 → 9.2.0

package/README.md

@@ -41,7 +41,7 @@ Within your webpack configuration object, you'll need to add the babel-loader to
 module: {
   rules: [
     {
-      test: /\.m?js$/,
+      test: /\.(?:js|mjs|cjs)$/,
       exclude: /node_modules/,
       use: {
         loader: 'babel-loader',
@@ -66,7 +66,7 @@ You can pass options to the loader by using the [`options`](https://webpack.js.o
 module: {
   rules: [
     {
-      test: /\.m?js$/,
+      test: /\.(?:js|mjs|cjs)$/,
       exclude: /node_modules/,
       use: {
         loader: 'babel-loader',
@@ -82,11 +82,17 @@ module: {
 }
 ```
 
+The `options` passed here will be [merged](https://babeljs.io/docs/configuration#how-babel-merges-config-items) with Babel config files, e.g. `babel.config.js` or `.babelrc`.
+
 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 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 and the `babel-loader`'s version
+  - the [merged](https://babeljs.io/docs/configuration#how-babel-merges-config-items) [Babel config](https://babeljs.io/docs/config-files), including options passed to `babel-loader` and the contents of `babel.config.js` or `.babelrc` file if they exist
+  - 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.
 
@@ -106,13 +112,13 @@ You can also speed up babel-loader by as much as 2x by using the `cacheDirectory
 
 ### Some files in my node_modules are not transpiled for IE 11
 
-Although we typically recommend not compiling `node_modules`, you may need to when using libraries that do not support IE 11.
+Although we typically recommend not compiling `node_modules`, you may need to when using libraries that do not support IE 11 or any legacy targets.
 
 For this, you can either use a combination of `test` and `not`, or [pass a function](https://webpack.js.org/configuration/module/#condition) to your `exclude` option. You can also use negative lookahead regex as suggested [here](https://github.com/webpack/webpack/issues/2031#issuecomment-294706065).
 
 ```javascript
 {
-    test: /\.m?js$/,
+    test: /\.(?:js|mjs|cjs)$/,
     exclude: {
       and: [/node_modules/], // Exclude libraries in node_modules ...
       not: [
@@ -150,7 +156,7 @@ rules: [
   // the 'transform-runtime' plugin tells Babel to
   // require the runtime instead of inlining it.
   {
-    test: /\.m?js$/,
+    test: /\.(?:js|mjs|cjs)$/,
     exclude: /node_modules/,
     use: {
       loader: 'babel-loader',
@@ -216,7 +222,7 @@ require('./app');
 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: /\.m?js$/,
+    test: /\.(?:js|mjs|cjs)$/,
     loader: 'babel',
   }
 ```
@@ -227,7 +233,7 @@ To fix this, you should uninstall the npm package `babel`, as it is deprecated i
 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
   {
-    test: /\.m?js$/,
+    test: /\.(?:js|mjs|cjs)$/,
     loader: 'babel-loader',
   }
 ```
@@ -323,7 +329,8 @@ your `custom` callback function.
 ```js
 // Export from "./my-custom-loader.js" or whatever you want.
 module.exports = require("babel-loader").custom(babel => {
-  function myPlugin() {
+  // Extract the custom options in the custom plugin
+  function myPlugin(api, { opt1, opt2 }) {
     return {
       visitor: {},
     };
@@ -342,7 +349,7 @@ module.exports = require("babel-loader").custom(babel => {
     },
 
     // Passed Babel's 'PartialConfig' object.
-    config(cfg) {
+    config(cfg, { customOptions }) {
       if (cfg.hasFilesystemConfig()) {
         // Use the normal config
         return cfg.options;
@@ -353,8 +360,8 @@ module.exports = require("babel-loader").custom(babel => {
         plugins: [
           ...(cfg.options.plugins || []),
 
-          // Include a custom plugin in the options.
-          myPlugin,
+          // Include a custom plugin in the options and passing it the customOptions object.
+          [myPlugin, customOptions],
         ],
       };
     },
@@ -389,7 +396,7 @@ Given the loader's options, split custom options out of `babel-loader`'s
 options.
 
 
-### `config(cfg: PartialConfig): Object`
+### `config(cfg: PartialConfig, options: { source, customOptions }): Object`
 
 Given Babel's `PartialConfig` object, return the `options` object that should
 be passed to `babel.transform`.

package/lib/Error.js

@@ -1,5 +1,3 @@
-"use strict";
-
 const STRIP_FILENAME_RE = /^[^:]+: /;
 const format = err => {
   if (err instanceof SyntaxError) {

package/lib/cache.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Filesystem Cache
  *
@@ -13,7 +11,6 @@ const os = require("os");
 const path = require("path");
 const zlib = require("zlib");
 const crypto = require("crypto");
-const findCacheDir = require("find-cache-dir");
 const {
   promisify
 } = require("util");
@@ -22,6 +19,7 @@ const {
   writeFile,
   mkdir
 } = require("fs/promises");
+const findCacheDirP = import("find-cache-dir");
 const transform = require("./transform");
 // Lazily instantiated when needed
 let defaultCacheDirectory = null;
@@ -29,7 +27,7 @@ let hashType = "sha256";
 // use md5 hashing if sha256 is not available
 try {
   crypto.createHash(hashType);
-} catch (err) {
+} catch {
   hashType = "md5";
 }
 const gunzip = promisify(zlib.gunzip);
@@ -93,19 +91,25 @@ const handleCache = async function (directory, params) {
     options = {},
     cacheIdentifier,
     cacheDirectory,
-    cacheCompression
+    cacheCompression,
+    logger
   } = 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
+    logger.debug(`reading cache file '${file}'`);
     return await read(file, cacheCompression);
-  } catch (err) {}
+  } catch {
+    // conitnue if cache can't be read
+    logger.debug(`discarded cache as it can not be read`);
+  }
   const fallback = typeof cacheDirectory !== "string" && directory !== os.tmpdir();
 
   // Make sure the directory exists.
   try {
     // overwrite directory if exists
+    logger.debug(`creating cache folder '${directory}'`);
     await mkdir(directory, {
       recursive: true
     });
@@ -118,12 +122,14 @@ const handleCache = async function (directory, params) {
 
   // Otherwise just transform the file
   // return it to the user asap and write it in cache
+  logger.debug(`applying Babel transform`);
   const result = await transform(source, options);
 
   // Do not cache if there are external dependencies,
   // since they might change and we cannot control it.
   if (!result.externalDependencies.length) {
     try {
+      logger.debug(`writing result to cache file '${file}'`);
       await write(file, cacheCompression, result);
     } catch (err) {
       if (fallback) {
@@ -167,6 +173,9 @@ module.exports = async function (params) {
     directory = params.cacheDirectory;
   } else {
     if (defaultCacheDirectory === null) {
+      const {
+        default: findCacheDir
+      } = await findCacheDirP;
       defaultCacheDirectory = findCacheDir({
         name: "babel-loader"
       }) || os.tmpdir();

package/lib/index.js

@@ -1,5 +1,3 @@
-"use strict";
-
 let babel;
 try {
   babel = require("@babel/core");
@@ -43,6 +41,7 @@ function makeLoader(callback) {
 }
 async function loader(source, inputSourceMap, overrides) {
   const filename = this.resourcePath;
+  const logger = this.getLogger("babel-loader");
   let loaderOptions = this.getOptions();
   validateOptions(schema, loaderOptions, {
     name: "Babel loader"
@@ -57,15 +56,18 @@ async function loader(source, inputSourceMap, overrides) {
     if (overrides) {
       throw new Error("babel-loader's 'customize' option is not available when already " + "using a customized babel-loader wrapper.");
     }
+    logger.debug(`loading customize override: '${loaderOptions.customize}'`);
     let override = require(loaderOptions.customize);
     if (override.__esModule) override = override.default;
     if (typeof override !== "function") {
       throw new Error("Custom overrides must be functions.");
     }
+    logger.debug("applying customize override to @babel/core");
     overrides = override(babel);
   }
   let customOptions;
   if (overrides && overrides.customOptions) {
+    logger.debug("applying overrides customOptions() to loader options");
     const result = await overrides.customOptions.call(this, loaderOptions, {
       source,
       map: inputSourceMap
@@ -81,7 +83,7 @@ async function loader(source, inputSourceMap, overrides) {
   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");
   }
-
+  logger.debug("normalizing loader 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.
@@ -108,10 +110,12 @@ async function loader(source, inputSourceMap, overrides) {
   delete programmaticOptions.cacheIdentifier;
   delete programmaticOptions.cacheCompression;
   delete programmaticOptions.metadataSubscribers;
+  logger.debug("resolving Babel configs");
   const config = await babel.loadPartialConfigAsync(injectCaller(programmaticOptions, this.target));
   if (config) {
     let options = config.options;
     if (overrides && overrides.config) {
+      logger.debug("applying overrides config() to Babel config");
       options = await overrides.config.call(this, config, {
         source,
         map: inputSourceMap,
@@ -139,20 +143,27 @@ async function loader(source, inputSourceMap, overrides) {
     } = loaderOptions;
     let result;
     if (cacheDirectory) {
+      logger.debug("cache is enabled");
       result = await cache({
         source,
         options,
         transform,
         cacheDirectory,
         cacheIdentifier,
-        cacheCompression
+        cacheCompression,
+        logger
       });
     } else {
+      logger.debug("cache is disabled, applying Babel transform");
       result = await transform(source, options);
     }
-    config.files.forEach(configFile => this.addDependency(configFile));
+    config.files.forEach(configFile => {
+      this.addDependency(configFile);
+      logger.debug(`added '${configFile}' to webpack dependencies`);
+    });
     if (result) {
       if (overrides && overrides.result) {
+        logger.debug("applying overrides result() to Babel transform results");
         result = await overrides.result.call(this, result, {
           source,
           map: inputSourceMap,
@@ -167,9 +178,13 @@ async function loader(source, inputSourceMap, overrides) {
         metadata,
         externalDependencies
       } = result;
-      externalDependencies == null ? void 0 : externalDependencies.forEach(dep => this.addDependency(dep));
+      externalDependencies?.forEach(dep => {
+        this.addDependency(dep);
+        logger.debug(`added '${dep}' to webpack dependencies`);
+      });
       metadataSubscribers.forEach(subscriber => {
         subscribe(subscriber, metadata, this);
+        logger.debug(`invoked metadata subscriber '${String(subscriber)}'`);
       });
       return [code, map];
     }

package/lib/injectCaller.js

@@ -1,8 +1,4 @@
-"use strict";
-
-const babel = require("@babel/core");
 module.exports = function injectCaller(opts, target) {
-  if (!supportsCallerOption()) return opts;
   return Object.assign({}, opts, {
     caller: Object.assign({
       name: "babel-loader",
@@ -18,26 +14,4 @@ module.exports = function injectCaller(opts, target) {
       supportsTopLevelAwait: true
     }, opts.caller)
   });
-};
-
-// TODO: We can remove this eventually, I'm just adding it so that people have
-// a little time to migrate to the newer RCs of @babel/core without getting
-// hard-to-diagnose errors about unknown 'caller' options.
-let supportsCallerOptionFlag = undefined;
-function supportsCallerOption() {
-  if (supportsCallerOptionFlag === undefined) {
-    try {
-      // Rather than try to match the Babel version, we just see if it throws
-      // when passed a 'caller' flag, and use that to decide if it is supported.
-      babel.loadPartialConfig({
-        caller: undefined,
-        babelrc: false,
-        configFile: false
-      });
-      supportsCallerOptionFlag = true;
-    } catch (err) {
-      supportsCallerOptionFlag = false;
-    }
-  }
-  return supportsCallerOptionFlag;
-}
+};

package/lib/transform.js

@@ -1,5 +1,3 @@
-"use strict";
-
 const babel = require("@babel/core");
 const {
   promisify

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-loader",
-  "version": "9.1.2",
+  "version": "9.2.0",
   "description": "babel module loader for webpack",
   "files": [
     "lib"
@@ -10,7 +10,7 @@
     "node": ">= 14.15.0"
   },
   "dependencies": {
-    "find-cache-dir": "^3.3.2",
+    "find-cache-dir": "^4.0.0",
     "schema-utils": "^4.0.0"
   },
   "peerDependencies": {
@@ -19,41 +19,34 @@
   },
   "devDependencies": {
     "@ava/babel": "^1.0.1",
-    "@babel/cli": "^7.19.3",
-    "@babel/core": "^7.19.6",
-    "@babel/preset-env": "^7.19.4",
+    "@babel/cli": "^7.23.0",
+    "@babel/core": "^7.23.3",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
     "ava": "^3.13.0",
-    "babel-eslint": "^10.1.0",
-    "babel-plugin-istanbul": "^6.1.1",
-    "babel-plugin-react-intl": "^8.2.25",
-    "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": "^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": "^3.0.0",
-    "semver": "7.3.2",
-    "webpack": "^5.74.0"
+    "c8": "^8.0.0",
+    "eslint": "^9.6.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^15.8.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.3",
+    "prettier": "^3.0.0",
+    "webpack": "^5.89.0"
   },
   "scripts": {
-    "clean": "rimraf lib/",
+    "clean": "node ./scripts/rimraf.mjs 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",
     "prepublish": "yarn run clean && yarn run build",
     "preversion": "yarn run test",
-    "test": "yarn run lint && cross-env BABEL_ENV=test yarn run build && yarn run test-only",
-    "test-only": "nyc ava"
+    "test": "yarn run lint && yarn run build --source-maps && c8 yarn run test-only",
+    "test-only": "ava"
+  },
+  "resolutions": {
+    "minipass": "6.0.2"
   },
   "repository": {
     "type": "git",
@@ -119,7 +112,5 @@
       "git add yarn.lock"
     ]
   },
-  "resolutions": {
-    "nyc/node-preload": "0.2.0"
-  }
+  "packageManager": "yarn@3.6.4"
 }