babel-loader 9.2.1 → 10.1.0

package/README.md

@@ -1,4 +1,4 @@
-> This README is for babel-loader v8/v9 with Babel v7
+> This README is for babel-loader v8/v9/v10 with Babel v7
 > If you are using legacy Babel v6, see the [7.x branch](https://github.com/babel/babel-loader/tree/7.x) docs
 
 [![NPM Status](https://img.shields.io/npm/v/babel-loader.svg?style=flat)](https://www.npmjs.com/package/babel-loader)
@@ -6,7 +6,7 @@
 
 <div align="center">
   <a href="https://github.com/babel/babel">
-    <img src="https://rawgit.com/babel/logo/master/babel.svg" alt="Babel logo" width="200" height="200">
+    <img src="https://raw.githubusercontent.com/babel/logo/master/babel.svg" alt="Babel logo" width="200" height="200">
   </a>
   <a href="https://github.com/webpack/webpack">
     <img src="https://webpack.js.org/assets/icon-square-big.svg" alt="webpack logo" width="200" height="200">
@@ -15,7 +15,7 @@
 
 <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).
+This package allows transpiling JavaScript files using [Babel](https://github.com/babel/babel) together with [webpack](https://github.com/webpack/webpack) or [Rspack](https://github.com/web-infra-dev/rspack).
 
 **Note**: Issues with the output should be reported on the Babel [Issues](https://github.com/babel/babel/issues) tracker.
 
@@ -25,6 +25,7 @@ This package allows transpiling JavaScript files using [Babel](https://github.co
 > |:-:|:-:|:-:|:-:|
 > | 8.x | 4.x or 5.x | 7.x | >= 8.9 |
 > | 9.x | 5.x | ^7.12.0 | >= 14.15.0 |
+> | 10.x | ^5.61.0 | ^7.12.0 \|\| ^8.0.0-alpha | ^18.20.0 \|\| ^20.10.0 \|\| >=22.0.0` |
 
 
 ```bash
@@ -46,8 +47,9 @@ module: {
       use: {
         loader: 'babel-loader',
         options: {
+          targets: "defaults",
           presets: [
-            ['@babel/preset-env', { targets: "defaults" }]
+            ['@babel/preset-env']
           ]
         }
       }
@@ -71,10 +73,11 @@ module: {
       use: {
         loader: 'babel-loader',
         options: {
+          targets: "defaults",
           presets: [
-            ['@babel/preset-env', { targets: "defaults" }]
+            ['@babel/preset-env']
           ],
-          plugins: ['@babel/plugin-proposal-class-properties']
+          plugins: ['@babel/plugin-proposal-decorators', { version: "2023-11" }]
         }
       }
     }
@@ -88,20 +91,30 @@ 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 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.
+* `cacheIdentifier`: Default is a string composed by the `@babel/core`'s version and the `babel-loader`'s version. The final cache id will be determined by the input file path, the [merged](https://babeljs.io/docs/configuration#how-babel-merges-config-items) Babel config via `Babel.loadPartialConfigAsync` and the `cacheIdentifier`. The merged Babel config will be determined by the `babel.config.js` or `.babelrc` file if they exist, or the value of the environment variable `BABEL_ENV` and `NODE_ENV`. `cacheIdentifier` 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 if you _must_ continue using `babel-loader` directly, but still want to customize.
 
-* `metadataSubscribers`: Default `[]`. Takes an array of context function names. E.g. if you passed ['myMetadataPlugin'], you'd assign a subscriber function to `context.myMetadataPlugin` within your webpack plugin's hooks & that function will be called with `metadata`.
+* `metadataSubscribers`: Default `[]`. Takes an array of context function names. E.g. if you passed ['myMetadataPlugin'], you'd assign a subscriber function to `context.myMetadataPlugin` within your webpack plugin's hooks & that function will be called with `metadata`. See [`./test/metadata.test.js`](./test/metadata.test.js) for an example.
 
 ## Troubleshooting
 
+### Enable debug mode logging
+
+Specify the webpack option [`stats.loggingDebug`](https://webpack.js.org/configuration/stats/#statsloggingdebug) to output verbose debug logs.
+
+```js
+// webpack.config.js
+module.exports = {
+  // ...
+  stats: {
+    loggingDebug: ["babel-loader"]
+  }
+}
+```
+
 ### babel-loader is slow!
 
 Make sure you are transforming as few files as possible. Because you are probably matching `/\.m?js$/`, you might be transforming the `node_modules` folder or other unwanted source.
@@ -291,10 +304,6 @@ For example, to change the environment targets passed to `@babel/preset-env` bas
 
 module.exports = api => {
   return {
-    plugins: [
-      "@babel/plugin-proposal-nullish-coalescing-operator",
-      "@babel/plugin-proposal-optional-chaining"
-    ],
     presets: [
       [
         "@babel/preset-env",

package/lib/Error.js

@@ -1,4 +1,14 @@
+// @ts-check
 const STRIP_FILENAME_RE = /^[^:]+: /;
+
+/**
+ * @typedef { Error & { hideStack?: boolean, codeFrame?: string } } BabelLoaderError
+ */
+/**
+ * Format the error for display.
+ * @param {BabelLoaderError} err
+ * @returns {BabelLoaderError}
+ */
 const format = err => {
   if (err instanceof SyntaxError) {
     err.name = "SyntaxError";
@@ -12,6 +22,9 @@ const format = err => {
   return err;
 };
 class LoaderError extends Error {
+  /**
+   * @param {BabelLoaderError} err
+   */
   constructor(err) {
     super();
     const {

package/lib/cache.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * Filesystem Cache
  *
@@ -7,10 +8,10 @@
  * @see https://github.com/babel/babel-loader/issues/34
  * @see https://github.com/babel/babel-loader/pull/41
  */
+const nodeModule = require("node:module");
 const os = require("os");
 const path = require("path");
 const zlib = require("zlib");
-const crypto = require("crypto");
 const {
   promisify
 } = require("util");
@@ -19,26 +20,53 @@ const {
   writeFile,
   mkdir
 } = require("fs/promises");
-const findCacheDirP = import("find-cache-dir");
+const {
+  sync: findUpSync
+} = require("find-up");
+const {
+  env
+} = process;
 const transform = require("./transform");
-// Lazily instantiated when needed
+const serialize = require("./serialize");
+/**
+ * @typedef {object} FileSystemInfoEntry
+ * @property {number} safeTime
+ * @property {number} timestamp
+ */
+/**
+ * @typedef {object} WebpackLogger
+ * @property {function(string): void} debug
+ * @property {function(string): void} info
+ * @property {function(string): void} warn
+ * @property {function(string): void} error
+ */
+/**
+ * @typedef {object} WebpackHash
+ * @property {(data: string | Buffer, inputEncoding?: string) => WebpackHash} update
+ * @property {(encoding?: string) => string | Buffer} digest
+ */
+
+/**
+ * @type {string | null}
+ */
 let defaultCacheDirectory = null;
-let hashType = "sha256";
-// use md5 hashing if sha256 is not available
-try {
-  crypto.createHash(hashType);
-} catch {
-  hashType = "md5";
-}
 const gunzip = promisify(zlib.gunzip);
 const gzip = promisify(zlib.gzip);
+const findRootPackageJSON = () => {
+  if (nodeModule.findPackageJSON) {
+    return nodeModule.findPackageJSON("..", __filename);
+  } else {
+    // todo: remove this fallback when dropping support for Node.js < 22.14
+    return findUpSync("package.json");
+  }
+};
 
 /**
  * Read the contents from the compressed file.
  *
  * @async
- * @params {String} filename
- * @params {Boolean} compress
+ * @param {string} filename
+ * @param {boolean} compress
  */
 const read = async function (filename, compress) {
   const data = await readFile(filename + (compress ? ".gz" : ""));
@@ -48,11 +76,10 @@ const read = async function (filename, compress) {
 
 /**
  * Write contents into a compressed file.
- *
  * @async
- * @params {String} filename
- * @params {Boolean} compress
- * @params {String} result
+ * @param {string} filename
+ * @param {boolean} compress
+ * @param {any} result
  */
 const write = async function (filename, compress, result) {
   const content = JSON.stringify(result);
@@ -62,28 +89,74 @@ const write = async function (filename, compress, result) {
 
 /**
  * Build the filename for the cached file
- *
- * @params {String} source  File source code
- * @params {Object} options Options used
- *
- * @return {String}
+ * @param {string} source File source code
+ * @param {string} identifier Unique identifier to bust cache
+ * @param {Object} options Options used
+ * @param {WebpackHash} hash Hash function returned by `LoaderContext.utils.createHash`
+ * @return {string}
  */
-const filename = function (source, identifier, options) {
-  const hash = crypto.createHash(hashType);
-  const contents = JSON.stringify({
-    source,
-    options,
-    identifier
-  });
-  hash.update(contents);
+const filename = function (source, identifier, options, hash) {
+  hash.update(serialize([options, source, identifier]));
   return hash.digest("hex") + ".json";
 };
 
+/**
+ * Add timestamps to external dependencies.
+ * @async
+ * @param {import("./transform").TransformResult["externalDependencies"]} externalDependencies
+ * @param {(filename: string) => Promise<FileSystemInfoEntry>} getFileTimestamp
+ */
+const addTimestamps = async function (externalDependencies, getFileTimestamp) {
+  for (const depAndEmptyTimestamp of externalDependencies) {
+    try {
+      const [dep] = depAndEmptyTimestamp;
+      const {
+        timestamp
+      } = await getFileTimestamp(dep);
+      depAndEmptyTimestamp.push(timestamp);
+    } catch {
+      // ignore errors if timestamp is not available
+    }
+  }
+};
+
+/**
+ * Check if any external dependencies have been modified.
+ * @async
+ * @param {import("./transform").TransformResult["externalDependencies"]} externalDepsWithTimestamp
+ * @param {(filename: string) => Promise<FileSystemInfoEntry>} getFileTimestamp
+ * @returns {Promise<boolean>}
+ */
+const areExternalDependenciesModified = async function (externalDepsWithTimestamp, getFileTimestamp) {
+  for (const depAndTimestamp of externalDepsWithTimestamp) {
+    const [dep, timestamp] = depAndTimestamp;
+    let newTimestamp;
+    try {
+      newTimestamp = (await getFileTimestamp(dep)).timestamp;
+    } catch {
+      return true;
+    }
+    if (timestamp !== newTimestamp) {
+      return true;
+    }
+  }
+  return false;
+};
+
 /**
  * Handle the cache
- *
- * @params {String} directory
- * @params {Object} params
+ * @async
+ * @param {string} directory
+ * @param {Object} params
+ * @param {string} params.source The source code to transform.
+ * @param {import(".").NormalizedOptions} [params.options] Options used for transformation.
+ * @param {string} params.cacheIdentifier Unique identifier to bust cache.
+ * @param {string} [params.cacheDirectory] Directory to store cached files.
+ * @param {boolean} [params.cacheCompression] Whether to compress cached files.
+ * @param {WebpackHash} params.hash Hash function to use for the cache filename.
+ * @param {(filename: string) => Promise<FileSystemInfoEntry>} params.getFileTimestamp - Function to get file timestamps.
+ * @param {WebpackLogger} params.logger
+ * @returns {Promise<null | import("./transform").TransformResult>}
  */
 const handleCache = async function (directory, params) {
   const {
@@ -92,16 +165,23 @@ const handleCache = async function (directory, params) {
     cacheIdentifier,
     cacheDirectory,
     cacheCompression,
+    hash,
+    getFileTimestamp,
     logger
   } = params;
-  const file = path.join(directory, filename(source, cacheIdentifier, options));
+  const file = path.join(directory, filename(source, cacheIdentifier, options, hash));
   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);
+    const result = await read(file, cacheCompression);
+    if (!(await areExternalDependenciesModified(result.externalDependencies, getFileTimestamp))) {
+      logger.debug(`validated cache file '${file}'`);
+      return result;
+    }
+    logger.debug(`discarded cache file '${file}' due to changes in external dependencies`);
   } catch {
-    // conitnue if cache can't be read
+    // continue if cache can't be read
     logger.debug(`discarded cache as it can not be read`);
   }
   const fallback = typeof cacheDirectory !== "string" && directory !== os.tmpdir();
@@ -124,34 +204,37 @@ const handleCache = async function (directory, params) {
   // 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) {
-        // Fallback to tmpdir if node_modules folder not writable
-        return handleCache(os.tmpdir(), params);
-      }
-      throw err;
+  if (!result) {
+    logger.debug(`no result from Babel transform, skipping cache write`);
+    return null;
+  }
+  await addTimestamps(result.externalDependencies, getFileTimestamp);
+  try {
+    logger.debug(`writing result to cache file '${file}'`);
+    await write(file, cacheCompression, result);
+  } catch (err) {
+    if (fallback) {
+      // Fallback to tmpdir if node_modules folder not writable
+      return handleCache(os.tmpdir(), params);
     }
+    throw err;
   }
   return result;
 };
 
 /**
  * Retrieve file from cache, or create a new one for future reads
- *
  * @async
- * @param  {Object}   params
- * @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 {object} params
+ * @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 {import(".").NormalizedOptions} params.options Options to be given to the transform function.
+ * @param {function} params.transform Transform function to apply to the file.
+ * @param {WebpackHash} params.hash Hash function to use for the cache filename.
+ * @param {function(string): Promise<FileSystemInfoEntry>} params.getFileTimestamp Function to get file timestamps.
+ * @param {WebpackLogger} params.logger Logger instance.
  *
  * @example
  *
@@ -167,20 +250,29 @@ const handleCache = async function (directory, params) {
  *   });
  */
 
-module.exports = async function (params) {
+module.exports = async function cache(params) {
   let directory;
   if (typeof params.cacheDirectory === "string") {
     directory = params.cacheDirectory;
   } else {
-    if (defaultCacheDirectory === null) {
-      const {
-        default: findCacheDir
-      } = await findCacheDirP;
-      defaultCacheDirectory = findCacheDir({
-        name: "babel-loader"
-      }) || os.tmpdir();
-    }
+    defaultCacheDirectory ??= findCacheDir("babel-loader");
     directory = defaultCacheDirectory;
   }
   return await handleCache(directory, params);
-};
+};
+
+/**
+ * Find the cache directory for babel-loader.
+ * @param {string} name "babel-loader"
+ * @returns {string}
+ */
+function findCacheDir(name) {
+  if (env.CACHE_DIR && !["true", "false", "1", "0"].includes(env.CACHE_DIR)) {
+    return path.join(env.CACHE_DIR, name);
+  }
+  const rootPkgJSONPath = findRootPackageJSON();
+  if (rootPkgJSONPath) {
+    return path.join(path.dirname(rootPkgJSONPath), "node_modules", ".cache", name);
+  }
+  return os.tmpdir();
+}

package/lib/index.js

@@ -1,3 +1,37 @@
+// @ts-check
+/**
+ * @typedef {object} LoaderOnlyOptions
+ * @property {string} [cacheDirectory] Directory to store cached files.
+ * @property {string} [cacheIdentifier] Unique identifier to bust cache.
+ * @property {boolean} [cacheCompression] Whether to compress cached files.
+ * @property {string} [customize] The absolute path of a file that exports a BabelLoaderWrapper.
+ * @property {Array<string>} [metadataSubscribers] Names of subscribers registered in the loader context.
+ */
+
+/**
+ * @typedef {import("webpack").LoaderContext<LoaderOptions>} BabelLoaderContext
+ * @typedef {string} BabelLoaderSource Parameters<import("webpack").LoaderDefinitionFunction>[0]
+ * @typedef {string} BabelLoaderInputSourceMap Parameters<import("webpack").LoaderDefinitionFunction>[1]
+ *
+ * @todo Consider exporting these types from @babel/core
+ * @typedef {Awaited<ReturnType<import("@babel/core").loadPartialConfigAsync>>} PartialConfig
+ * @typedef {PartialConfig['options']} NormalizedOptions
+ */
+
+/**
+ * @typedef {(babel: typeof import("@babel/core")) => BabelOverrideHooks} BabelLoaderWrapper
+ * @typedef {object} BabelOverrideHooks
+ * @property {(this: BabelLoaderContext, loaderOptions: LoaderOptions, params: { source: BabelLoaderSource, map: BabelLoaderInputSourceMap }) => Promise<{ custom: any, loader: LoaderOptions }>} customOptions
+ * @property {(this: BabelLoaderContext, config: PartialConfig, params: { source: BabelLoaderSource, map: BabelLoaderInputSourceMap, customOptions: any }) => Promise<PartialConfig['options']>} config
+ * @property {(this: BabelLoaderContext, result: import("./transform").TransformResult, params: { source: BabelLoaderSource, map: BabelLoaderInputSourceMap, customOptions: any, config: PartialConfig, options: PartialConfig['options'] }) => Promise<import("./transform").TransformResult>} result
+ */
+/**
+ * @typedef {import("@babel/core").InputOptions & LoaderOnlyOptions} LoaderOptions
+ */
+
+/**
+ * @type {import("@babel/core")}
+ */
 let babel;
 try {
   babel = require("@babel/core");
@@ -19,39 +53,66 @@ const {
 const cache = require("./cache");
 const transform = require("./transform");
 const injectCaller = require("./injectCaller");
-const schema = require("./schema");
+const schema = require("./schema.json");
 const {
   isAbsolute
 } = require("path");
-const validateOptions = require("schema-utils").validate;
+const {
+  promisify
+} = require("util");
+
+/**
+ * Invoke a metadata subscriber registered in the loader context.
+ * @param {string} subscriber
+ * @param {unknown} metadata
+ * @param {import("webpack").LoaderContext<LoaderOptions>} context
+ */
 function subscribe(subscriber, metadata, context) {
+  // @ts-expect-error subscriber is a custom function
   if (context[subscriber]) {
+    // @ts-expect-error subscriber is a custom function
     context[subscriber](metadata);
   }
 }
 module.exports = makeLoader();
 module.exports.custom = makeLoader;
+
+/**
+ * @param {BabelLoaderWrapper} [callback]
+ */
 function makeLoader(callback) {
   const overrides = callback ? callback(babel) : undefined;
-  return function (source, inputSourceMap) {
+
+  /**
+   * @this {BabelLoaderContext}
+   * @param {BabelLoaderSource} source
+   * @param {BabelLoaderInputSourceMap} inputSourceMap
+   */
+  const webpackLoader = function (source, inputSourceMap) {
     // Make the loader async
     const callback = this.async();
-    loader.call(this, source, inputSourceMap, overrides).then(args => callback(null, ...args), err => callback(err));
+    loader.call(this, source, inputSourceMap, overrides).then(
+    // @ts-expect-error (FixMe): Argument of type 'string | EncodedSourceMap' is not assignable to parameter of type 'string | Buffer<ArrayBufferLike>'.
+    args => callback(null, ...args), err => callback(err));
   };
+  return webpackLoader;
 }
+
+/**
+ * Babel loader
+ * @this {BabelLoaderContext}
+ * @param {BabelLoaderSource} source The source code to transform
+ * @param {BabelLoaderInputSourceMap} inputSourceMap
+ * @param {BabelOverrideHooks} overrides
+ * @returns
+ */
 async function loader(source, inputSourceMap, overrides) {
   const filename = this.resourcePath;
-  const logger = typeof this.getLogger === "function" ? this.getLogger("babel-loader") : {
-    debug: () => {}
-  };
-  let loaderOptions = this.getOptions();
-  validateOptions(schema, loaderOptions, {
-    name: "Babel loader"
-  });
+  const logger = this.getLogger("babel-loader");
+
+  // @ts-expect-error TS does not treat schema.json/properties/cacheDirectory/type as a constant string literal
+  let loaderOptions = this.getOptions(schema);
   if (loaderOptions.customize != null) {
-    if (typeof loaderOptions.customize !== "string") {
-      throw new Error("Customized loaders must be implemented as standalone modules.");
-    }
     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.");
     }
@@ -80,10 +141,10 @@ async function loader(source, inputSourceMap, overrides) {
 
   // Deprecation handling
   if ("forceEnv" in loaderOptions) {
-    console.warn("The option `forceEnv` has been removed in favor of `envName` in Babel 7.");
+    this.emitWarning(new Error("The option `forceEnv` has been removed in favor of `envName` in Babel 7."));
   }
   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");
+    this.emitWarning(new Error("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/#options"));
   }
   logger.debug("normalizing loader options");
   // Standardize on 'sourceMaps' as the key passed through to Webpack, so that
@@ -135,17 +196,26 @@ async function loader(source, inputSourceMap, overrides) {
     }
     const {
       cacheDirectory = null,
-      cacheIdentifier = JSON.stringify({
-        options,
-        "@babel/core": transform.version,
-        "@babel/loader": version
-      }),
+      cacheIdentifier = "core" + transform.version + "," + "loader" + version,
       cacheCompression = true,
       metadataSubscribers = []
     } = loaderOptions;
+
+    /**
+     * @type {import("./transform").TransformResult}
+     */
     let result;
     if (cacheDirectory) {
       logger.debug("cache is enabled");
+      const getFileTimestamp = promisify(
+      /**
+       * @param {string} path
+       * @param {(err: import("webpack").WebpackError | null, fileTimestamp: import("./cache").FileSystemInfoEntry) => void} cb
+       */
+      (path, cb) => {
+        this._compilation.fileSystemInfo.getFileTimestamp(path, cb);
+      });
+      const hash = this.utils.createHash(this._compilation.outputOptions.hashFunction);
       result = await cache({
         source,
         options,
@@ -153,6 +223,8 @@ async function loader(source, inputSourceMap, overrides) {
         cacheDirectory,
         cacheIdentifier,
         cacheCompression,
+        hash,
+        getFileTimestamp,
         logger
       });
     } else {
@@ -180,7 +252,7 @@ async function loader(source, inputSourceMap, overrides) {
         metadata,
         externalDependencies
       } = result;
-      externalDependencies?.forEach(dep => {
+      externalDependencies?.forEach(([dep]) => {
         this.addDependency(dep);
         logger.debug(`added '${dep}' to webpack dependencies`);
       });

package/lib/injectCaller.js

@@ -1,5 +1,13 @@
+// @ts-check
+/**
+ * Inject babel-loader caller information into the Babel options.
+ * @param {import("@babel/core").InputOptions} opts
+ * @param {string} target
+ * @returns {import("@babel/core").InputOptions}
+ */
 module.exports = function injectCaller(opts, target) {
-  return Object.assign({}, opts, {
+  return {
+    ...opts,
     caller: Object.assign({
       name: "babel-loader",
       // Provide plugins with insight into webpack target.
@@ -13,5 +21,5 @@ module.exports = function injectCaller(opts, target) {
       // flag isn't enabled.
       supportsTopLevelAwait: true
     }, opts.caller)
-  });
+  };
 };

package/lib/schema.json

@@ -1,8 +1,9 @@
 {
+  "title": "Babel Loader options",
   "type": "object",
   "properties": {
     "cacheDirectory": {
-      "oneOf": [
+      "anyOf": [
         {
           "type": "boolean"
         },
@@ -20,8 +21,18 @@
       "default": true
     },
     "customize": {
-      "type": "string",
+      "anyOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "string"
+        }
+      ],
       "default": null
+    },
+    "metadataSubscribers": {
+      "type": "array"
     }
   },
   "additionalProperties": true

package/lib/serialize.js

@@ -0,0 +1,95 @@
+// @ts-check
+var objToString = Object.prototype.toString;
+var objKeys = Object.getOwnPropertyNames;
+
+/**
+ * A custom Babel options serializer
+ *
+ * Intentional deviation from JSON.stringify:
+ * 1. Object properties are sorted before serializing
+ * 2. The output is NOT a valid JSON: e.g.
+ *    The output does not enquote strings, which means a JSON-like string '{"a":1}'
+ *    will share the same result with an JS object { a: 1 }. This is not an issue
+ *    for Babel options, but it can not be used for general serialization purpose
+ * 3. Only 20% slower than the native JSON.stringify on V8
+ *
+ * This function is a fork from https://github.com/nickyout/fast-stable-stringify
+ * @param {unknown} val Babel options
+ * @param {boolean} isArrayProp
+ * @returns serialized Babel options
+ */
+function serialize(val, isArrayProp) {
+  var i, max, str, keys, key, propVal, toStr;
+  if (val === true) {
+    return "!0";
+  }
+  if (val === false) {
+    return "!1";
+  }
+  switch (typeof val) {
+    case "object":
+      if (val === null) {
+        return null;
+        // @ts-expect-error
+      } else if (val.toJSON && typeof val.toJSON === "function") {
+        // @ts-expect-error toJSON has been checked above
+        return serialize(val.toJSON(), isArrayProp);
+      } else {
+        toStr = objToString.call(val);
+        if (toStr === "[object Array]") {
+          str = "[";
+          // @ts-expect-error val is an array
+          max = val.length - 1;
+          for (i = 0; i < max; i++) {
+            // @ts-expect-error val is an array
+            str += serialize(val[i], true) + ",";
+          }
+          if (max > -1) {
+            // @ts-expect-error val is an array
+            str += serialize(val[i], true);
+          }
+          return str + "]";
+        } else if (toStr === "[object Object]") {
+          // only object is left
+          keys = objKeys(val).sort();
+          max = keys.length;
+          str = "{";
+          i = 0;
+          while (i < max) {
+            key = keys[i];
+            // @ts-expect-error key must index val
+            propVal = serialize(val[key], false);
+            if (propVal !== undefined) {
+              if (str) {
+                str += ",";
+              }
+              str += '"' + key + '":' + propVal;
+            }
+            i++;
+          }
+          return str + "}";
+        } else {
+          return JSON.stringify(val);
+        }
+      }
+    case "function":
+    case "undefined":
+      return isArrayProp ? null : undefined;
+    case "string":
+      return val;
+    default:
+      // @ts-expect-error val must be a number because of the toJSON check above
+      return isFinite(val) ? val : null;
+  }
+}
+
+/**
+ * @param {unknown} val
+ * @returns {string | undefined}
+ */
+module.exports = function (val) {
+  var returnVal = serialize(val, false);
+  if (returnVal !== undefined) {
+    return "" + returnVal;
+  }
+};

package/lib/transform.js

@@ -1,13 +1,31 @@
+// @ts-check
 const babel = require("@babel/core");
 const {
   promisify
 } = require("util");
 const LoaderError = require("./Error");
-const transform = promisify(babel.transform);
-module.exports = async function (source, options) {
+const babelTransform = babel.transformAsync ?? promisify(babel.transform);
+/**
+ * @typedef {Object} AmendedTransformResult
+ * @property {[string, number?][]} externalDependencies
+ */
+/**
+ * @typedef {Omit<import("@babel/core").FileResult, "externalDependencies" | "options"> & AmendedTransformResult} TransformResult
+ */
+/**
+ * Transform the source code using Babel.
+ * @async
+ * @param {string} source The source code to transform.
+ * @param {import("@babel/core").InputOptions} options The Babel options.
+ * @returns {Promise<null | TransformResult>} The transformed result or null if no transformation is needed.
+ */
+module.exports = async function transform(source, options) {
+  /**
+   * @type {import("@babel/core").FileResult}
+   */
   let result;
   try {
-    result = await transform(source, options);
+    result = await babelTransform(source, options);
   } catch (err) {
     throw err.message && err.codeFrame ? new LoaderError(err) : err;
   }
@@ -15,7 +33,7 @@ module.exports = async function (source, options) {
 
   // 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/main/packages/babel-core/src/transformation/index.js
+  // https://github.com/babel/babel/blob/main/packages/babel-core/src/transformation/index.ts
   // For discussion on this topic see here:
   // https://github.com/babel/babel-loader/pull/629
   const {
@@ -36,7 +54,12 @@ module.exports = async function (source, options) {
     metadata,
     sourceType,
     // Convert it from a Set to an Array to make it JSON-serializable.
-    externalDependencies: Array.from(externalDependencies || [])
+    externalDependencies: Array.from(externalDependencies || [],
+    /**
+     * @param {string} dep
+     * @returns {[string, number?]}
+     */
+    dep => [dep]).sort()
   };
 };
 module.exports.version = babel.version;

package/package.json

@@ -1,38 +1,46 @@
 {
   "name": "babel-loader",
-  "version": "9.2.1",
+  "version": "10.1.0",
   "description": "babel module loader for webpack",
   "files": [
     "lib"
   ],
   "main": "lib/index.js",
   "engines": {
-    "node": ">= 14.15.0"
+    "node": "^18.20.0 || ^20.10.0 || >=22.0.0"
   },
   "dependencies": {
-    "find-cache-dir": "^4.0.0",
-    "schema-utils": "^4.0.0"
+    "find-up": "^5.0.0"
   },
   "peerDependencies": {
-    "@babel/core": "^7.12.0",
-    "webpack": ">=5"
+    "@babel/core": "^7.12.0 || ^8.0.0-beta.1",
+    "@rspack/core": "^1.0.0 || ^2.0.0-0",
+    "webpack": ">=5.61.0"
+  },
+  "peerDependenciesMeta": {
+    "@rspack/core": {
+      "optional": true
+    },
+    "webpack": {
+      "optional": true
+    }
   },
   "devDependencies": {
-    "@ava/babel": "^1.0.1",
-    "@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",
-    "c8": "^8.0.0",
+    "@babel/cli": "^8.0.0-beta.1",
+    "@babel/core": "^8.0.0-beta.1",
+    "@babel/eslint-parser": "^8.0.0-beta.1",
+    "@babel/preset-env": "^8.0.0-beta.1",
+    "@rspack/core": "^1.7.5",
+    "c8": "^10.1.2",
     "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",
+    "husky": "^9.1.5",
+    "lint-staged": "^15.2.9",
     "prettier": "^3.0.0",
-    "webpack": "^5.89.0"
+    "typescript": "^5.8.3",
+    "webpack": "^5.93.0"
   },
   "scripts": {
     "clean": "node ./scripts/rimraf.mjs lib",
@@ -41,9 +49,9 @@
     "lint": "eslint src test",
     "precommit": "lint-staged",
     "prepublish": "yarn run clean && yarn run build",
-    "preversion": "yarn run test",
+    "preversion": "yarn tsc && yarn run test",
     "test": "yarn run lint && yarn run build --source-maps && c8 yarn run test-only",
-    "test-only": "ava"
+    "test-only": "node --test test/**/*.test.js"
   },
   "resolutions": {
     "minipass": "6.0.2"
@@ -78,18 +86,6 @@
     "sourceMap": false,
     "instrument": false
   },
-  "ava": {
-    "files": [
-      "test/**/*.test.js",
-      "!test/fixtures/**/*",
-      "!test/helpers/**/*"
-    ],
-    "babel": {
-      "compileAsTests": [
-        "test/helpers/**/*"
-      ]
-    }
-  },
   "lint-staged": {
     "scripts/*.js": [
       "prettier --trailing-comma es5 --write",
@@ -113,4 +109,4 @@
     ]
   },
   "packageManager": "yarn@3.6.4"
-}
+}

package/CHANGELOG.md

@@ -1,169 +0,0 @@
-# Changelog
-
-For changes in version v7.0.0 and up please go to [release](https://github.com/babel/babel-loader/releases)
-
-# Old Changelog
-
-## v6.4.1
-
-### 🐛 Bug Fix
-
-- Fixed reset of BABEL_ENV when options.forceEnv is used (#420) @nikopavlica
-
-## v6.4.0
-
-### 🚀 New Feature
-
-- added metadata passing from babel to webpack, which is currently used by react-intl (#398) @Ognian
-
-## v6.3.2
-
-### 😢 Regression
-
-- `forceEnv` was interfering with regular environment handling
-
-## v6.3.1
-
-### 🐛 Bug Fix
-
- - The new `forceEnv` options wasn't working as expected (#379) @chrisvasz
-
-## v6.3.0
-
-### 🚀 New Feature
-
-- Add new config option `forceEnv` (#368) @moimael
-
-Allow to override BABEL_ENV/NODE_ENV at loader-level. Useful for isomorphic applications which have   separate babel config for client and server.
-
-### 🐛 Bug Fix
-
-- Update loader-utils dependency to ^0.2.16 to fix compatibility with webpack 2 (#371) @leonaves
-
-### 💅 Polish
-
-- Improve FS caching to do less sync calls which improves performance slightly (#375) @akx
-
-## v6.2.10
-
-Support for webpack 2.2-rc has been added in this release
-
-### 🐛 Bug Fix
-
-- If cache directory not writable, try to fallback to tmpdir before failing
-
-## v6.2.9
-
-### 😢 Regression
-
-Source maps on windows did not work correctly with v6.2.8.
-Thanks @josephst
-
-### 🏠 Internal
-
-- Add AppVeyor to run tests on windows @danez
-- Fix tests on windows (#343) @danez
-
-## v6.2.8
-
-### 🐛 Bug Fix
-
-- gzipped files should have `.gz` as the extension, not `.gzip` (#326) @bjornstar
-- fix options.sourceFileName gennerate bug (#260) @creeperyang
-
-### 📝 Documentation
-
-- Update README docs for cacheDirectory's actual behaviour (#245) @sohkai
-- updates docs re: transform-runtime (#197) @gbrassey
-
-### 🏠 Internal
-
-- Use eslint and nyc (#321) @danez
-- Adjust travis config (#320) @danez
-- Use babel to compile babel-loader (#319) @danez
-
-## v6.2.7
-
-### 😢 Regression
-
-Fallback to `os.tmpdir()` if no cachedir found (#318) (fixes #317) @danez
-
-Fixes an issue with v6.2.6 when using `babel-loader` as a global package.
-
-## v6.2.6
-
-### 🐛 Bug Fix
-
-- Use standard cache dir as default `cacheDirectory` (#301) @fson
-
-Use the common cache directory, `./node_modules/.cache/babel-loader`, as the default cache directory (when the cacheDirectory setting is enabled).
-
-```js
-query: {
-  cacheDirectory: true
-}
-```
-
-## v6.2.5
-
-- Don't show the call stack for a Babel error (such as when you have a syntax error)
-
-<img width="415" alt="screenshot 2016-08-15 15 24 37" src="https://cloud.githubusercontent.com/assets/30594/17664401/727ba098-62fc-11e6-9f12-42da0cf47f14.png">
-
-- resolve the .babelrc relative to the file path rather than the cwd (current working directory).
-
- * fix: more concise formatting for Babel errors (#287) (Andrey Popp)
- * fix(resolve-rc): resolve-rc relative file path (#253) (Luke Page)
- * add babel-core and preset-2015 to dev dependencies (#273) (timse)
- * chore(docs): add issue and pr templates (#280) (Joshua Wiens)
- * chore(docs): fix badge formatting (Joshua Wiens)
- * chore(ci): expand travis testing (#278) (Joshua Wiens)
- * Update README: add env vars to cacheIdentifier (#267) (Dominik Ferber)
- * add npm badge [skip ci] (Henry Zhu)
- * update [skip ci] (Henry Zhu)
- * remove jsx references as well [skip ci] (Henry Zhu)
- * Save the transform to devDependencies (Ray Booysen)
- * Remove 'react' preset (Jake Rios)
- * Removed babel-preset-react from README.md (Ben Stephenson)
-
-## v6.2.4
- * change allowed peer deps (all webpack 2 beta versions)
-
-## v6.2.3
- * change allowed peer deps (2.0.7-beta)
-
-## v6.2.2
-  * Update peerDependencies to accept webpack 2 [#208](https://github.com/babel/babel-loader/pull/208)
-  * Remove duplicated dependencies
-
-## v6.2.0
-  * Pass true filenames [#106](https://github.com/babel/babel-loader/issues/106)
-  * Remove babel-core from devDependencies
-
-## v6.1.0
-
-  * Merge [PR #146](https://github.com/babel/babel-loader/pull/146) Set source file name relative to options.sourceRoot
-  * Merge [PR #136](https://github.com/babel/babel-loader/pull/136) use container-based infrastructure for faster build
-  * Merge [PR #121](https://github.com/babel/babel-loader/pull/121) Make babelrc configurable
-  * Merge [PR #113](https://github.com/babel/babel-loader/pull/113) Include BABEL_ENV || NODE_ENV in cacheIdentifier
-
-## v6.0.1
-
-  * Update to babel v6.
-
-## v5.3.1
-
-  * Merge [PR #85](https://github.com/babel/babel-loader/pull/85) - Don't override sourcemap if sourcesContent already exists.
-
-
-## v5.3.1
-
-  * Merge [PR #82](https://github.com/babel/babel-loader/pull/82) - Fallback global options to empty object to avoid conflicts with object-assign polyfill.
-
-## v5.3.0
-
-  * Merge [PR #79](https://github.com/babel/babel-loader/pull/79) - This should allow babel-loader to work with [enhanced-require](https://github.com/webpack/enhanced-require).
-
-## v5.2.0
-
-  * Include `.babelrc` file into the `cacheIdentifier` if it exists