@docusaurus/theme-translations/src/index.ts

Docusaurus theme translations.

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import path from 'path';
import fs from 'fs-extra';
import type {CodeTranslations} from '@docusaurus/types';

function getDefaultLocalesDirPath(): string {
  return path.join(__dirname, '../locales');
}

// Return an ordered list of locales we should try
export function codeTranslationLocalesToTry(locale: string): string[] {
  const intlLocale = new Intl.Locale(locale);
  // If locale is just a simple language like "pt", we want to fallback to
  // "pt-BR" (not "pt-PT"!)
  // See https://github.com/facebook/docusaurus/pull/4536#issuecomment-810088783
  const maximizedLocale = intlLocale.maximize(); // "pt-Latn-BR"
  return [
    // May be "zh", "zh-CN", "zh-Hans", "zh-cn", or anything: very likely to be
    // unresolved except for simply locales
    locale,
    // "zh-CN" / "pt-BR"
    `${maximizedLocale.language!}-${maximizedLocale.region!}`,
    // "zh-Hans" / "pt-Latn"
    `${maximizedLocale.language!}-${maximizedLocale.script!}`,
    // "zh" / "pt"
    maximizedLocale.language!,
  ];
}

// Useful to implement getDefaultCodeTranslationMessages() in themes
export async function readDefaultCodeTranslationMessages({
  dirPath = getDefaultLocalesDirPath(),
  locale,
  name,
}: {
  dirPath?: string;
  locale: string;
  name: string;
}): Promise<CodeTranslations> {
  const localesToTry = codeTranslationLocalesToTry(locale);

  // Return the content of the first file that match
  // fr_FR.json => fr.json => nothing
  for (const localeToTry of localesToTry) {
    const filePath = path.resolve(dirPath, localeToTry, `${name}.json`);

    if (await fs.pathExists(filePath)) {
      return fs.readJSON(filePath) as Promise<CodeTranslations>;
    }
  }

  return {};
}