next-intl 4.6.0 → 4.6.1

package/dist/cjs/development/plugin.cjs

@@ -1,407 +1,13 @@
 'use strict';
 
-var fs = require('fs');
-var path = require('path');
-var module$1 = require('module');
+var plugin = require('./plugin-DDtWCyPI.cjs');
+require('fs/promises');
+require('path');
+require('@parcel/watcher');
+require('fs');
+require('module');
+require('@swc/core');
 
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-function formatMessage(message) {
-  return `\n[next-intl] ${message}\n`;
-}
-function throwError(message) {
-  throw new Error(formatMessage(message));
-}
-function warn(message) {
-  console.warn(formatMessage(message));
-}
 
-/**
- * Wrapper around `fs.watch` that provides a workaround
- * for https://github.com/nodejs/node/issues/5039.
- */
-function watchFile(filepath, callback) {
-  const directory = path.dirname(filepath);
-  const filename = path.basename(filepath);
-  return fs.watch(directory, {
-    persistent: false,
-    recursive: false
-  }, (event, changedFilename) => {
-    if (changedFilename === filename) {
-      callback();
-    }
-  });
-}
 
-function runOnce(fn) {
-  if (process.env._NEXT_INTL_COMPILE_MESSAGES === '1') {
-    return;
-  }
-  process.env._NEXT_INTL_COMPILE_MESSAGES = '1';
-  fn();
-}
-function createMessagesDeclaration(messagesPaths) {
-  // Instead of running _only_ in certain cases, it's
-  // safer to _avoid_ running for certain known cases.
-  // https://github.com/amannn/next-intl/issues/2006
-  const shouldBailOut = ['info', 'start'
-
-  // Note: These commands don't consult the
-  // Next.js config, so we can't detect them here.
-  // - telemetry
-  // - lint
-  //
-  // What remains are:
-  // - dev
-  // - build
-  // - typegen
-  ].some(arg => process.argv.includes(arg));
-  if (shouldBailOut) {
-    return;
-  }
-
-  // Next.js can call the Next.js config multiple
-  // times - ensure we only run once.
-  runOnce(() => {
-    for (const messagesPath of messagesPaths) {
-      const fullPath = path.resolve(messagesPath);
-      if (!fs.existsSync(fullPath)) {
-        throwError(`\`createMessagesDeclaration\` points to a non-existent file: ${fullPath}`);
-      }
-      if (!fullPath.endsWith('.json')) {
-        throwError(`\`createMessagesDeclaration\` needs to point to a JSON file. Received: ${fullPath}`);
-      }
-
-      // Keep this as a runtime check and don't replace
-      // this with a constant during the build process
-      const env = process.env['NODE_ENV'.trim()];
-      compileDeclaration(messagesPath);
-      if (env === 'development') {
-        startWatching(messagesPath);
-      }
-    }
-  });
-}
-function startWatching(messagesPath) {
-  const watcher = watchFile(messagesPath, () => {
-    compileDeclaration(messagesPath, true);
-  });
-  process.on('exit', () => {
-    watcher.close();
-  });
-}
-function compileDeclaration(messagesPath, async = false) {
-  const declarationPath = messagesPath.replace(/\.json$/, '.d.json.ts');
-  function createDeclaration(content) {
-    return `// This file is auto-generated by next-intl, do not edit directly.
-// See: https://next-intl.dev/docs/workflows/typescript#messages-arguments
-
-declare const messages: ${content.trim()};
-export default messages;`;
-  }
-  if (async) {
-    return fs.promises.readFile(messagesPath, 'utf-8').then(content => fs.promises.writeFile(declarationPath, createDeclaration(content)));
-  }
-  const content = fs.readFileSync(messagesPath, 'utf-8');
-  fs.writeFileSync(declarationPath, createDeclaration(content));
-}
-
-const formats = {
-  json: {
-    codec: () => Promise.resolve().then(function () { return require('./JSONCodec-Dlcx71xz.cjs'); }),
-    extension: '.json'
-  },
-  po: {
-    codec: () => Promise.resolve().then(function () { return require('./POCodec-BW-UDNcq.cjs'); }),
-    extension: '.po'
-  }
-};
-function isBuiltInFormat(format) {
-  return typeof format === 'string' && format in formats;
-}
-function getFormatExtension(format) {
-  if (isBuiltInFormat(format)) {
-    return formats[format].extension;
-  } else {
-    return format.extension;
-  }
-}
-
-class SourceFileFilter {
-  static EXTENSIONS = ['ts', 'tsx', 'js', 'jsx'];
-
-  // Will not be entered, except if explicitly asked for
-  // TODO: At some point we should infer these from .gitignore
-  static IGNORED_DIRECTORIES = ['node_modules', '.next', '.git'];
-  static isSourceFile(filePath) {
-    const ext = path.extname(filePath);
-    return SourceFileFilter.EXTENSIONS.map(cur => '.' + cur).includes(ext);
-  }
-  static shouldEnterDirectory(dirPath, srcPaths) {
-    const dirName = path.basename(dirPath);
-    if (SourceFileFilter.IGNORED_DIRECTORIES.includes(dirName)) {
-      return SourceFileFilter.isIgnoredDirectoryExplicitlyIncluded(dirPath, srcPaths);
-    }
-    return true;
-  }
-  static isIgnoredDirectoryExplicitlyIncluded(ignoredDirPath, srcPaths) {
-    return srcPaths.some(srcPath => SourceFileFilter.isWithinPath(srcPath, ignoredDirPath));
-  }
-  static isWithinPath(targetPath, basePath) {
-    const relativePath = path.relative(basePath, targetPath);
-    return relativePath === '' || !relativePath.startsWith('..');
-  }
-}
-
-function getCurrentVersion() {
-  try {
-    const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('plugin.cjs', document.baseURI).href)));
-    const pkg = require$1('next/package.json');
-    return pkg.version;
-  } catch (error) {
-    throw new Error('Failed to get current Next.js version. This can happen if next-intl/plugin is imported into your app code outside of your next.config.js.', {
-      cause: error
-    });
-  }
-}
-function compareVersions(version1, version2) {
-  const v1Parts = version1.split('.').map(Number);
-  const v2Parts = version2.split('.').map(Number);
-  for (let i = 0; i < 3; i++) {
-    const v1 = v1Parts[i] || 0;
-    const v2 = v2Parts[i] || 0;
-    if (v1 > v2) return 1;
-    if (v1 < v2) return -1;
-  }
-  return 0;
-}
-function hasStableTurboConfig() {
-  return compareVersions(getCurrentVersion(), '15.3.0') >= 0;
-}
-function isNextJs16OrHigher() {
-  return compareVersions(getCurrentVersion(), '16.0.0') >= 0;
-}
-
-function withExtensions(localPath) {
-  return [`${localPath}.ts`, `${localPath}.tsx`, `${localPath}.js`, `${localPath}.jsx`];
-}
-function resolveI18nPath(providedPath, cwd) {
-  function resolvePath(pathname) {
-    const parts = [];
-    if (cwd) parts.push(cwd);
-    parts.push(pathname);
-    return path.resolve(...parts);
-  }
-  function pathExists(pathname) {
-    return fs.existsSync(resolvePath(pathname));
-  }
-  if (providedPath) {
-    if (!pathExists(providedPath)) {
-      throwError(`Could not find i18n config at ${providedPath}, please provide a valid path.`);
-    }
-    return providedPath;
-  } else {
-    for (const candidate of [...withExtensions('./i18n/request'), ...withExtensions('./src/i18n/request')]) {
-      if (pathExists(candidate)) {
-        return candidate;
-      }
-    }
-    throwError(`Could not locate request configuration module.\n\nThis path is supported by default: ./(src/)i18n/request.{js,jsx,ts,tsx}\n\nAlternatively, you can specify a custom location in your Next.js config:\n\nconst withNextIntl = createNextIntlPlugin(
-
-Alternatively, you can specify a custom location in your Next.js config:
-
-const withNextIntl = createNextIntlPlugin(
-  './path/to/i18n/request.tsx'
-);`);
-  }
-}
-function getNextConfig(pluginConfig, nextConfig) {
-  const useTurbo = process.env.TURBOPACK != null;
-  const nextIntlConfig = {};
-  function getExtractMessagesLoaderConfig() {
-    const experimental = pluginConfig.experimental;
-    if (!experimental.srcPath || !pluginConfig.experimental?.messages) {
-      throwError('`srcPath` and `messages` are required when using `extractor`.');
-    }
-    return {
-      loader: 'next-intl/extractor/extractionLoader',
-      options: {
-        srcPath: experimental.srcPath,
-        sourceLocale: experimental.extract.sourceLocale,
-        messages: pluginConfig.experimental.messages
-      }
-    };
-  }
-  function getCatalogLoaderConfig() {
-    return {
-      loader: 'next-intl/extractor/catalogLoader',
-      options: {
-        messages: pluginConfig.experimental.messages
-      }
-    };
-  }
-  function getTurboRules() {
-    return nextConfig?.turbopack?.rules ||
-    // @ts-expect-error -- For Next.js <16
-    nextConfig?.experimental?.turbo?.rules || {};
-  }
-  function addTurboRule(rules, glob, rule) {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (rules[glob]) {
-      if (Array.isArray(rules[glob])) {
-        rules[glob].push(rule);
-      } else {
-        rules[glob] = [rules[glob], rule];
-      }
-    } else {
-      rules[glob] = rule;
-    }
-  }
-  if (useTurbo) {
-    if (pluginConfig.requestConfig && path.isAbsolute(pluginConfig.requestConfig)) {
-      throwError("Turbopack support for next-intl currently does not support absolute paths, please provide a relative one (e.g. './src/i18n/config.ts').\n\nFound: " + pluginConfig.requestConfig);
-    }
-
-    // Assign alias for `next-intl/config`
-    const resolveAlias = {
-      // Turbo aliases don't work with absolute
-      // paths (see error handling above)
-      'next-intl/config': resolveI18nPath(pluginConfig.requestConfig)
-    };
-
-    // Add loaders
-    let rules;
-
-    // Add loader for extractor
-    if (pluginConfig.experimental?.extract) {
-      if (!isNextJs16OrHigher()) {
-        throwError('Message extraction requires Next.js 16 or higher.');
-      }
-      rules ??= getTurboRules();
-      const srcPaths = (Array.isArray(pluginConfig.experimental.srcPath) ? pluginConfig.experimental.srcPath : [pluginConfig.experimental.srcPath]).map(srcPath => srcPath.endsWith('/') ? srcPath.slice(0, -1) : srcPath);
-      addTurboRule(rules, `*.{${SourceFileFilter.EXTENSIONS.join(',')}}`, {
-        loaders: [getExtractMessagesLoaderConfig()],
-        condition: {
-          // Note: We don't need `not: 'foreign'`, because this is
-          // implied by the filter based on `srcPath`.
-          path: `{${srcPaths.join(',')}}` + '/**/*',
-          content: /(useExtracted|getExtracted)/
-        }
-      });
-    }
-
-    // Add loader for catalog
-    if (pluginConfig.experimental?.messages) {
-      if (!isNextJs16OrHigher()) {
-        throwError('Message catalog loading requires Next.js 16 or higher.');
-      }
-      rules ??= getTurboRules();
-      const extension = getFormatExtension(pluginConfig.experimental.messages.format);
-      addTurboRule(rules, `*${extension}`, {
-        loaders: [getCatalogLoaderConfig()],
-        condition: {
-          path: `${pluginConfig.experimental.messages.path}/**/*`
-        },
-        as: '*.js'
-      });
-    }
-    if (hasStableTurboConfig() &&
-    // @ts-expect-error -- For Next.js <16
-    !nextConfig?.experimental?.turbo) {
-      nextIntlConfig.turbopack = {
-        ...nextConfig?.turbopack,
-        ...(rules && {
-          rules
-        }),
-        resolveAlias: {
-          ...nextConfig?.turbopack?.resolveAlias,
-          ...resolveAlias
-        }
-      };
-    } else {
-      nextIntlConfig.experimental = {
-        ...nextConfig?.experimental,
-        // @ts-expect-error -- For Next.js <16
-        turbo: {
-          // @ts-expect-error -- For Next.js <16
-          ...nextConfig?.experimental?.turbo,
-          ...(rules && {
-            rules
-          }),
-          resolveAlias: {
-            // @ts-expect-error -- For Next.js <16
-            ...nextConfig?.experimental?.turbo?.resolveAlias,
-            ...resolveAlias
-          }
-        }
-      };
-    }
-  } else {
-    nextIntlConfig.webpack = function webpack(config, context) {
-      if (!config.resolve) config.resolve = {};
-      if (!config.resolve.alias) config.resolve.alias = {};
-
-      // Assign alias for `next-intl/config`
-      // (Webpack requires absolute paths)
-      config.resolve.alias['next-intl/config'] = path.resolve(config.context, resolveI18nPath(pluginConfig.requestConfig, config.context));
-
-      // Add loader for extractor
-      if (pluginConfig.experimental?.extract) {
-        if (!config.module) config.module = {};
-        if (!config.module.rules) config.module.rules = [];
-        const srcPath = pluginConfig.experimental.srcPath;
-        config.module.rules.push({
-          test: new RegExp(`\\.(${SourceFileFilter.EXTENSIONS.join('|')})$`),
-          include: Array.isArray(srcPath) ? srcPath.map(cur => path.resolve(config.context, cur)) : path.resolve(config.context, srcPath || ''),
-          use: [getExtractMessagesLoaderConfig()]
-        });
-      }
-
-      // Add loader for catalog
-      if (pluginConfig.experimental?.messages) {
-        if (!config.module) config.module = {};
-        if (!config.module.rules) config.module.rules = [];
-        const extension = getFormatExtension(pluginConfig.experimental.messages.format);
-        config.module.rules.push({
-          test: new RegExp(`${extension.replace(/\./g, '\\.')}$`),
-          include: path.resolve(config.context, pluginConfig.experimental.messages.path),
-          use: [getCatalogLoaderConfig()],
-          type: 'javascript/auto'
-        });
-      }
-      if (typeof nextConfig?.webpack === 'function') {
-        return nextConfig.webpack(config, context);
-      }
-      return config;
-    };
-  }
-
-  // Forward config
-  if (nextConfig?.trailingSlash) {
-    nextIntlConfig.env = {
-      ...nextConfig.env,
-      _next_intl_trailing_slash: 'true'
-    };
-  }
-  return Object.assign({}, nextConfig, nextIntlConfig);
-}
-
-function initPlugin(pluginConfig, nextConfig) {
-  if (nextConfig?.i18n != null) {
-    warn("An `i18n` property was found in your Next.js config. This likely causes conflicts and should therefore be removed if you use the App Router.\n\nIf you're in progress of migrating from the Pages Router, you can refer to this example: https://next-intl.dev/examples#app-router-migration\n");
-  }
-  const messagesPathOrPaths = pluginConfig.experimental?.createMessagesDeclaration;
-  if (messagesPathOrPaths) {
-    createMessagesDeclaration(typeof messagesPathOrPaths === 'string' ? [messagesPathOrPaths] : messagesPathOrPaths);
-  }
-  return getNextConfig(pluginConfig, nextConfig);
-}
-function createNextIntlPlugin(i18nPathOrConfig = {}) {
-  const config = typeof i18nPathOrConfig === 'string' ? {
-    requestConfig: i18nPathOrConfig
-  } : i18nPathOrConfig;
-  return function withNextIntl(nextConfig) {
-    return initPlugin(config, nextConfig);
-  };
-}
-
-module.exports = createNextIntlPlugin;
+module.exports = plugin.createNextIntlPlugin;

package/dist/esm/development/extractor/ExtractionCompiler.js

@@ -19,7 +19,7 @@ class ExtractionCompiler {
   }
   [Symbol.dispose]() {
     this.uninstallExitHandlers();
-    this.manager.destroy();
+    this.manager[Symbol.dispose]();
   }
   installExitHandlers() {
     const cleanup = this[Symbol.dispose];

package/dist/esm/development/extractor/catalog/CatalogManager.js

@@ -32,7 +32,8 @@ class CatalogManager {
   // Cached instances
 
   // Resolves when all catalogs are loaded
-  // (but doesn't indicate that project scan is done)
+
+  // Resolves when the initial project scan and processing is complete
 
   constructor(config, opts) {
     this.config = config;
@@ -41,6 +42,9 @@ class CatalogManager {
     this.isDevelopment = opts.isDevelopment ?? false;
     this.extractor = opts.extractor;
     if (this.isDevelopment) {
+      // We kick this off as early as possible, so we get notified about changes
+      // that happen during the initial project scan (while awaiting it to
+      // complete though)
       this.sourceWatcher = new SourceFileWatcher(this.getSrcPaths(), this.handleFileEvents.bind(this));
       void this.sourceWatcher.start();
     }
@@ -87,9 +91,12 @@ class CatalogManager {
     const sourceDiskMessages = await this.loadSourceMessages();
     this.loadCatalogsPromise = this.loadTargetMessages();
     await this.loadCatalogsPromise;
-    const sourceFiles = await SourceFileScanner.getSourceFiles(this.getSrcPaths());
-    await Promise.all(Array.from(sourceFiles).map(async filePath => this.processFile(filePath)));
-    this.mergeSourceDiskMetadata(sourceDiskMessages);
+    this.scanCompletePromise = (async () => {
+      const sourceFiles = await SourceFileScanner.getSourceFiles(this.getSrcPaths());
+      await Promise.all(Array.from(sourceFiles).map(async filePath => this.processFile(filePath)));
+      this.mergeSourceDiskMetadata(sourceDiskMessages);
+    })();
+    await this.scanCompletePromise;
     if (this.isDevelopment) {
       const catalogLocales = this.getCatalogLocales();
       catalogLocales.subscribeLocalesChange(this.onLocalesChange);
@@ -136,12 +143,23 @@ class CatalogManager {
         }
       }
     } else {
-      // For target: disk wins completely
-      const translations = new Map();
-      for (const message of diskMessages) {
-        translations.set(message.id, message);
+      // For target: disk wins completely, BUT preserve existing translations
+      // if we read empty (likely a write in progress by an external tool
+      // that causes the file to temporarily be empty)
+      const existingTranslations = this.translationsByTargetLocale.get(locale);
+      const hasExistingTranslations = existingTranslations && existingTranslations.size > 0;
+      if (diskMessages.length > 0) {
+        // We got content from disk, replace with it
+        const translations = new Map();
+        for (const message of diskMessages) {
+          translations.set(message.id, message);
+        }
+        this.translationsByTargetLocale.set(locale, translations);
+      } else if (hasExistingTranslations) ; else {
+        // We read empty and have no existing translations
+        const translations = new Map();
+        this.translationsByTargetLocale.set(locale, translations);
       }
-      this.translationsByTargetLocale.set(locale, translations);
     }
   }
   mergeSourceDiskMetadata(diskMessages) {
@@ -163,7 +181,12 @@ class CatalogManager {
     let messages = [];
     try {
       const content = await fs.readFile(absoluteFilePath, 'utf8');
-      const extraction = await this.extractor.extract(absoluteFilePath, content);
+      let extraction;
+      try {
+        extraction = await this.extractor.extract(absoluteFilePath, content);
+      } catch {
+        return false;
+      }
       messages = extraction.messages;
     } catch (err) {
       if (err.code !== 'ENOENT') {
@@ -322,8 +345,14 @@ class CatalogManager {
     if (this.loadCatalogsPromise) {
       await this.loadCatalogsPromise;
     }
+
+    // Wait for initial scan to complete to avoid race conditions
+    if (this.scanCompletePromise) {
+      await this.scanCompletePromise;
+    }
     let changed = false;
-    for (const event of events) {
+    const expandedEvents = await this.sourceWatcher.expandDirectoryDeleteEvents(events, Array.from(this.messagesByFile.keys()));
+    for (const event of expandedEvents) {
       const hasChanged = await this.processFile(event.path);
       changed ||= hasChanged;
     }
@@ -331,10 +360,10 @@ class CatalogManager {
       await this.save();
     }
   }
-  destroy() {
+  [Symbol.dispose]() {
     this.sourceWatcher?.stop();
     this.sourceWatcher = undefined;
-    this.saveScheduler.destroy();
+    this.saveScheduler[Symbol.dispose]();
     if (this.catalogLocales && this.isDevelopment) {
       this.catalogLocales.unsubscribeLocalesChange(this.onLocalesChange);
     }

package/dist/esm/development/extractor/catalog/SaveScheduler.js

@@ -71,7 +71,7 @@ class SaveScheduler {
       }
     }
   }
-  destroy() {
+  [Symbol.dispose]() {
     if (this.saveTimeout) {
       clearTimeout(this.saveTimeout);
       this.saveTimeout = undefined;

package/dist/esm/development/extractor/extractionLoader.js

@@ -1,44 +1,24 @@
-import ExtractionCompiler from './ExtractionCompiler.js';
 import MessageExtractor from './extractor/MessageExtractor.js';
 
-// This instance:
-// - Remains available through HMR
-// - Is the same across react-client and react-server
-// - Is only lost when the dev server restarts (e.g. due to change to Next.js config)
-let compiler;
+// Module-level extractor instance for transformation caching.
+// Note: Next.js/Turbopack may create multiple loader instances, but each
+// only handles file transformation. The ExtractionCompiler (which manages
+// catalogs) is initialized separately in createNextIntlPlugin.
 let extractor;
-let extractAllPromise;
 function extractionLoader(source) {
-  const options = this.getOptions();
   const callback = this.async();
   const projectRoot = this.rootContext;
 
   // Avoid rollup's `replace` plugin to compile this away
   const isDevelopment = process.env['NODE_ENV'.trim()] === 'development';
   if (!extractor) {
-    // This instance is shared with the compiler to enable caching
-    // across code transformations and catalog extraction
     extractor = new MessageExtractor({
       isDevelopment,
       projectRoot,
       sourceMap: this.sourceMap
     });
   }
-  if (!compiler) {
-    compiler = new ExtractionCompiler(options, {
-      isDevelopment,
-      projectRoot,
-      sourceMap: this.sourceMap,
-      extractor
-    });
-  }
-  if (!extractAllPromise) {
-    extractAllPromise = compiler.extractAll();
-  }
-  extractor.extract(this.resourcePath, source).then(async result => {
-    if (!isDevelopment) {
-      await extractAllPromise;
-    }
+  extractor.extract(this.resourcePath, source).then(result => {
     callback(null, result.code, result.map);
   }).catch(callback);
 }