feat(v2): core v2 i18n support + Docusaurus site Crowdin integration (#3325)

* docs i18n initial poc

* docs i18n initial poc

* docs i18n initial poc

* docs i18n initial poc

* crowdin-v2 attempt

* fix source

* use crowdin env variable

* try to install crowdin on netlify

* try to install crowdin on netlify

* try to use crowdin jar directly

* try to curl the crowdin jar

* add java version cmd

* try to run crowdin jar in netlify

* fix translatedDocsDirPath

* fix loadContext issue due to site baseUrl not being modified in generted config file

* real validateLocalesFile

* add locale option to deploy command

* better LocalizationFile type

* create util getPluginI18nPath

* better core localization context loading code

* More explicit VersionMetadata type for localized docs folders

* Ability to translate blog posts with Crowdin!

* blog: refactor markdown loader + report broken links + try to get linkify working better

* upgrade crowdin config to upload all docs folder files except source code related files

* try to support translated pages

* make markdown pages translation work

* add write-translations cli command template

* fix site not  reloaded with correct options

* refactor a bit the read/write of @generated/i18n.json file

* Add <Translate> + translate() API + use it on the docusaurus homepage

* watch locale translation dir

* early POC of adding babel parsing for translation extraction

* fs.stat => pathExists

* add install:fast script

* TSC: noUnusedLocals false as it's already checked  by eslint

* POC of extracting translations from source code

* minor typo

* fix extracted key to code

* initial docs extracted translations

* stable plugin translations POC

* add crowdin commands

* quickfix for i18n deployment

* POC  of themeConfig translation

* add ability to have localized site without path prefix

* sidebar typo

* refactor translation system to output multiple translation files

* translate properly  the docs plugin

* improve theme classic translation

* rework translation extractor to handle new Chrome I18n JSON format (include id/description)

* writeTranslations: allow to pass locales cli arg

* fix ThemeConfig TS issues

* fix localizePath errors

* temporary add write-translations to netlify deploy preview

* complete example of french translated folder

* update fr folder

* remove all translations from repo

* minor translation  refactors

* fix all docs-related tests

* fix blog feed tests

* fix last blog tests

* refactor i18n context a bit, extract codeTranslations in an extra generated file

* improve @generated/i18n type

* fix some i18n todos

* minor refactor

* fix logo typing issue after merge

* move i18n.json to siteConfig instead

* try to fix windows CI build

* fix config test

* attempt to fix windows non-posix path

* increase v1 minify css jest timeout due to flaky test

* proper support for localizePath on windows

* remove non-functional install:fast

* docs, fix docsDirPathLocalized

* fix Docs i18n / md linkify issues

* ensure theme-classic swizzling will use "nextjs" sources (transpiled less aggressively, to make them human readable)

* fix some snapshots

* improve themeConfig translation code

* refactor a bit getPluginI18nPath

* readTranslationFileContent => ensure files are valid, fail fast

* fix versions tests

* add extractSourceCodeAstTranslations comments/resource links

* ignore eslint: packages/docusaurus-theme-classic/lib-next/

* fix windows CI with cross-env

* crowdin ignore .DS_Store

* improve writeTranslations + add exhaustive tests for translations.ts

* remove typo

* Wire currentLocale to algolia search

* improve i18n locale error

* Add tests for translationsExtractor.ts

* better code translation extraction regarding statically evaluable code

* fix typo

* fix typo

* improve theme-classic transpilation

* refactor  +  add i18n tests

* typo

* test new utils

* add missing snapshots

* fix snapshot

* blog onBrokenMarkdownLink

* add sidebars tests

* theme-classic index should now use ES modules

* tests for theme-classic translations

* useless comment

* add more translation tests

* simplify/cleanup writeTranslations

* try to fix Netlify fr deployment

* blog: test translated md is used during feed generation

* blog: better i18n tests regarding editUrl + md translation application

* more i18n tests for docs plugin

* more i18n tests for docs plugin

* Add tests for pages i18n

* polish docusaurus build i18n logs

packages/docusaurus-plugin-content-docs/src/versions.ts

@@ -22,7 +22,7 @@ import {
 
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 import {LoadContext} from '@docusaurus/types';
-import {normalizeUrl} from '@docusaurus/utils';
+import {getPluginI18nPath, normalizeUrl} from '@docusaurus/utils';
 import {difference} from 'lodash';
 import chalk from 'chalk';
 
@@ -137,9 +137,12 @@ function getVersionMetadataPaths({
   options,
 }: {
   versionName: string;
-  context: Pick<LoadContext, 'siteDir'>;
+  context: Pick<LoadContext, 'siteDir' | 'i18n'>;
   options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath'>;
-}): Pick<VersionMetadata, 'docsDirPath' | 'sidebarFilePath'> {
+}): Pick<
+  VersionMetadata,
+  'docsDirPath' | 'docsDirPathLocalized' | 'sidebarFilePath'
+> {
   const isCurrentVersion = versionName === CURRENT_VERSION_NAME;
 
   const docsDirPath = isCurrentVersion
@@ -149,6 +152,18 @@ function getVersionMetadataPaths({
         `version-${versionName}`,
       );
 
+  const docsDirPathLocalized = getPluginI18nPath({
+    siteDir: context.siteDir,
+    locale: context.i18n.currentLocale,
+    pluginName: 'docusaurus-plugin-content-docs',
+    pluginId: options.id,
+    subPaths: [
+      versionName === CURRENT_VERSION_NAME
+        ? CURRENT_VERSION_NAME
+        : `version-${versionName}`,
+    ],
+  });
+
   const sidebarFilePath = isCurrentVersion
     ? path.resolve(context.siteDir, options.sidebarPath)
     : path.join(
@@ -156,7 +171,7 @@ function getVersionMetadataPaths({
         `version-${versionName}-sidebars.json`,
       );
 
-  return {docsDirPath, sidebarFilePath};
+  return {docsDirPath, docsDirPathLocalized, sidebarFilePath};
 }
 
 function createVersionMetadata({
@@ -167,13 +182,17 @@ function createVersionMetadata({
 }: {
   versionName: string;
   isLast: boolean;
-  context: Pick<LoadContext, 'siteDir' | 'baseUrl'>;
+  context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
   options: Pick<
     PluginOptions,
     'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'versions'
   >;
 }): VersionMetadata {
-  const {sidebarFilePath, docsDirPath} = getVersionMetadataPaths({
+  const {
+    sidebarFilePath,
+    docsDirPath,
+    docsDirPathLocalized,
+  } = getVersionMetadataPaths({
     versionName,
     context,
     options,
@@ -210,6 +229,7 @@ function createVersionMetadata({
     routePriority,
     sidebarFilePath,
     docsDirPath,
+    docsDirPathLocalized,
   };
 }
 
@@ -322,7 +342,7 @@ export function readVersionsMetadata({
   context,
   options,
 }: {
-  context: Pick<LoadContext, 'siteDir' | 'baseUrl'>;
+  context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
   options: Pick<
     PluginOptions,
     | 'id'
@@ -356,3 +376,15 @@ export function readVersionsMetadata({
   versionsMetadata.forEach(checkVersionMetadataPaths);
   return versionsMetadata;
 }
+
+// order matter!
+// Read in priority the localized path, then the unlocalized one
+// We want the localized doc to "override" the unlocalized one
+export function getDocsDirPaths(
+  versionMetadata: Pick<
+    VersionMetadata,
+    'docsDirPath' | 'docsDirPathLocalized'
+  >,
+): [string, string] {
+  return [versionMetadata.docsDirPathLocalized, versionMetadata.docsDirPath];
+}