babel-loader 9.2.1 → 10.0.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">
@@ -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/cache.js

@@ -10,7 +10,6 @@
 const os = require("os");
 const path = require("path");
 const zlib = require("zlib");
-const crypto = require("crypto");
 const {
   promisify
 } = require("util");
@@ -19,17 +18,15 @@ 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");
 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);
 
@@ -68,16 +65,38 @@ const write = async function (filename, compress, result) {
  *
  * @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";
 };
+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
+    }
+  }
+};
+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
@@ -92,14 +111,21 @@ 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
     logger.debug(`discarded cache as it can not be read`);
@@ -124,20 +150,16 @@ 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;
+  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;
 };
@@ -172,15 +194,18 @@ module.exports = async function (params) {
   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);
-};
+};
+function findCacheDir(name) {
+  if (env.CACHE_DIR && !["true", "false", "1", "0"].includes(env.CACHE_DIR)) {
+    return path.join(env.CACHE_DIR, name);
+  }
+  const rootPkgJSONPath = path.dirname(findUpSync("package.json"));
+  if (rootPkgJSONPath) {
+    return path.join(rootPkgJSONPath, "node_modules", ".cache", name);
+  }
+  return os.tmpdir();
+}

package/lib/index.js

@@ -23,7 +23,9 @@ const schema = require("./schema");
 const {
   isAbsolute
 } = require("path");
-const validateOptions = require("schema-utils").validate;
+const {
+  promisify
+} = require("util");
 function subscribe(subscriber, metadata, context) {
   if (context[subscriber]) {
     context[subscriber](metadata);
@@ -41,17 +43,9 @@ function makeLoader(callback) {
 }
 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");
+  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 +74,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 +129,17 @@ 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;
     let result;
     if (cacheDirectory) {
       logger.debug("cache is enabled");
+      const getFileTimestamp = promisify((path, cb) => {
+        this._compilation.fileSystemInfo.getFileTimestamp(path, cb);
+      });
+      const hash = this.utils.createHash(this._compilation.outputOptions.hashFunction);
       result = await cache({
         source,
         options,
@@ -153,6 +147,8 @@ async function loader(source, inputSourceMap, overrides) {
         cacheDirectory,
         cacheIdentifier,
         cacheCompression,
+        hash,
+        getFileTimestamp,
         logger
       });
     } else {
@@ -180,7 +176,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/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,82 @@
+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 seralizing
+ * 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 {*} val Babel options
+ * @param {*} 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;
+      } else if (val.toJSON && typeof val.toJSON === "function") {
+        return serialize(val.toJSON(), isArrayProp);
+      } else {
+        toStr = objToString.call(val);
+        if (toStr === "[object Array]") {
+          str = "[";
+          max = val.length - 1;
+          for (i = 0; i < max; i++) {
+            str += serialize(val[i], true) + ",";
+          }
+          if (max > -1) {
+            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];
+            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:
+      return isFinite(val) ? val : null;
+  }
+}
+module.exports = function (val) {
+  var returnVal = serialize(val, false);
+  if (returnVal !== undefined) {
+    return "" + returnVal;
+  }
+};

package/lib/transform.js

@@ -15,7 +15,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 +36,7 @@ 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 || [], dep => [dep]).sort()
   };
 };
 module.exports.version = babel.version;

package/package.json

@@ -1,38 +1,35 @@
 {
   "name": "babel-loader",
-  "version": "9.2.1",
+  "version": "10.0.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"
+    "webpack": ">=5.61.0"
   },
   "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",
+    "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"
+    "webpack": "^5.93.0"
   },
   "scripts": {
     "clean": "node ./scripts/rimraf.mjs lib",
@@ -43,7 +40,7 @@
     "prepublish": "yarn run clean && yarn run build",
     "preversion": "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 +75,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",