Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
107 changed files
with
5,465 additions
and
667 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| # | ||
| # Your Crowdin credentials | ||
| # | ||
| 'project_id': '416738' | ||
| 'api_token_env': 'CROWDIN_PERSONAL_TOKEN' | ||
| 'base_path': '.' | ||
| 'base_url': 'https://api.crowdin.com' | ||
|
|
||
| # | ||
| # Choose file structure in Crowdin | ||
| # e.g. true or false | ||
| # | ||
| 'preserve_hierarchy': true | ||
|
|
||
| # | ||
| # Files configuration | ||
| # | ||
| files: | ||
| [ | ||
| { | ||
| 'source': '/website/i18n/en/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/**/%original_file_name%', | ||
| 'ignore': ['/**/.DS_Store'], | ||
| }, | ||
| { | ||
| 'source': '/website/docs/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%', | ||
| 'ignore': ['/**/.DS_Store'], | ||
| }, | ||
| { | ||
| 'source': '/website/community/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs-community/current/**/%original_file_name%', | ||
| 'ignore': ['/**/.DS_Store'], | ||
| }, | ||
| { | ||
| 'source': '/website/versioned_docs/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%', | ||
| 'ignore': ['/**/.DS_Store'], | ||
| }, | ||
| { | ||
| 'source': '/website-1.x/blog/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%', | ||
| 'ignore': ['/**/.DS_Store'], | ||
| }, | ||
| { | ||
| 'source': '/website/src/pages/**/*', | ||
| 'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-pages/**/%original_file_name%', | ||
| 'ignore': | ||
| [ | ||
| '/**/*.js', | ||
| '/**/*.jsx', | ||
| '/**/*.ts', | ||
| '/**/*.tsx', | ||
| '/**/*.css', | ||
| '/**/.DS_Store', | ||
| ], | ||
| }, | ||
| ] | ||
| # | ||
| # Source files filter | ||
| # e.g. "/resources/en/*.json" | ||
| # | ||
| #"source" : "/website/docs/**/*.md", | ||
| # | ||
| # Where translations will be placed | ||
| # e.g. "/resources/docs/%two_letters_code%/%original_file_name%" | ||
| # | ||
| #"translation" : "/website/i18n/%language%/docs/current/%original_file_name%", | ||
| # | ||
| # Files or directories for ignore | ||
| # e.g. ["/**/?.txt", "/**/[0-9].txt", "/**/*\?*.txt"] | ||
| # | ||
| #"ignore" : [], | ||
| # | ||
| # The dest allows you to specify a file name in Crowdin | ||
| # e.g. "/messages.json" | ||
| # | ||
| #"dest" : "", | ||
| # | ||
| # File type | ||
| # e.g. "json" | ||
| # | ||
| #"type" : "", | ||
| # | ||
| # The parameter "update_option" is optional. If it is not set, after the files update the translations for changed strings will be removed. Use to fix typos and for minor changes in the source strings | ||
| # e.g. "update_as_unapproved" or "update_without_changes" | ||
| # | ||
| #"update_option" : "", | ||
| # | ||
| # Start block (for XML only) | ||
| # | ||
| # | ||
| # Defines whether to translate tags attributes. | ||
| # e.g. 0 or 1 (Default is 1) | ||
| # | ||
| # "translate_attributes" : 1, | ||
| # | ||
| # Defines whether to translate texts placed inside the tags. | ||
| # e.g. 0 or 1 (Default is 1) | ||
| # | ||
| # "translate_content" : 1, | ||
| # | ||
| # This is an array of strings, where each item is the XPaths to DOM element that should be imported | ||
| # e.g. ["/content/text", "/content/text[@value]"] | ||
| # | ||
| # "translatable_elements" : [], | ||
| # | ||
| # Defines whether to split long texts into smaller text segments | ||
| # e.g. 0 or 1 (Default is 1) | ||
| # | ||
| # "content_segmentation" : 1, | ||
| # | ||
| # End block (for XML only) | ||
| # | ||
| # | ||
| # Start .properties block | ||
| # | ||
| # | ||
| # Defines whether single quote should be escaped by another single quote or backslash in exported translations | ||
| # e.g. 0 or 1 or 2 or 3 (Default is 3) | ||
| # 0 - do not escape single quote; | ||
| # 1 - escape single quote by another single quote; | ||
| # 2 - escape single quote by backslash; | ||
| # 3 - escape single quote by another single quote only in strings containing variables ( {0} ). | ||
| # | ||
| # "escape_quotes" : 3, | ||
| # | ||
| # Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations. | ||
| # e.g. 0 or 1 (Default is 0) | ||
| # 0 - do not escape special characters | ||
| # 1 - escape special characters by a backslash | ||
| # | ||
| # "escape_special_characters": 0 | ||
| # | ||
| # | ||
| # End .properties block | ||
| # | ||
| # | ||
| # Often software projects have custom names for the directories where translations are placed. crowdin-cli allows you to map your own languages to be understandable by Crowdin. | ||
| # | ||
| #"languages_mapping" : { | ||
| # "two_letters_code" : { | ||
| # "crowdin_language_code" : "local_name" | ||
| # } | ||
| #}, | ||
| # | ||
| # Does the first line contain header? | ||
| # e.g. true or false | ||
| # | ||
| #"first_line_contains_header" : true, | ||
| # | ||
| # for spreadsheets | ||
| # e.g. "identifier,source_phrase,context,uk,ru,fr" | ||
| # | ||
| # "scheme" : "", |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
...blog/src/__tests__/__fixtures__/website/blog-with-ref/post-with-broken-links.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: This post links to another one! | ||
| --- | ||
|
|
||
| [Good link 1](2018-12-14-Happy-First-Birthday-Slash.md) | ||
|
|
||
| [Good link 2](./2018-12-14-Happy-First-Birthday-Slash.md) | ||
|
|
||
| [Bad link 1](postNotExist1.md) | ||
|
|
||
| [Bad link 1](./postNotExist2.mdx) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,4 @@ | |
| title: Happy 1st Birthday Slash! | ||
| --- | ||
|
|
||
| pattern name | ||
| Happy birthday! | ||
5 changes: 5 additions & 0 deletions
5
...i18n/en/docusaurus-plugin-content-blog/2018-12-14-Happy-First-Birthday-Slash.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Happy 1st Birthday Slash! (translated) | ||
| --- | ||
|
|
||
| Happy birthday! (translated) |
Oops, something went wrong.