-
-
Notifications
You must be signed in to change notification settings - Fork 467
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DX] Allow using
br tags in translations to avoid confusion (#4380)
- Loading branch information
Showing
51 changed files
with
186 additions
and
67 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /** | ||
| * Script to run some checks against translations | ||
| * | ||
| * run with `pnpm lint-translations` | ||
| * | ||
| * It can flag: | ||
| * - empty strings | ||
| * - translations in language file that are not present in `en` file | ||
| * - translations that add content between indexed content-less tags | ||
| * like `<1></1>` in `en` file but with content in the translation | ||
| * - translations missing content-less tags that are present in `en` | ||
| * file, like a translation missing a `<2></2>` tag | ||
| * | ||
| * It shows a list with the different results of the checks, language | ||
| * and keys compared. | ||
| */ | ||
|
|
||
| import { readdirSync, readFileSync } from 'graceful-fs' | ||
| import { join } from 'path' | ||
|
|
||
| // there are many extra keys in translation files without a matching | ||
| // key in the english file | ||
| // | ||
| // this is not really a problem so these messages are ignored by default | ||
| const printExtraTransations = false | ||
|
|
||
| const localesPath = './public/locales' | ||
|
|
||
| // Read a file as JSON | ||
| function readFile(fileName: string, language: string) { | ||
| try { | ||
| return JSON.parse( | ||
| readFileSync(join(localesPath, language, fileName + '.json')).toString() | ||
| ) | ||
| } catch (error) { | ||
| // console.log(error) | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| // Read the 3 files for a given language | ||
| function readFiles(language: string) { | ||
| return { | ||
| gamepage: readFile('gamepage', language), | ||
| login: readFile('login', language), | ||
| translation: readFile('translation', language) | ||
| } | ||
| } | ||
|
|
||
| const enFiles = readFiles('en') | ||
| let processingLanguage = '' | ||
| let processingFile = '' | ||
|
|
||
| // Run checks in string from translation against original in english file | ||
| function checkStringValueAgainstEnglish( | ||
| trValue: string, | ||
| enValue: string, | ||
| parent?: string | ||
| ) { | ||
| if (trValue === '') { | ||
| console.log( | ||
| `Empty translation for ${processingLanguage}.${processingFile}.${parent}` | ||
| ) | ||
| return | ||
| } | ||
|
|
||
| const i18nTags = enValue.match(/<(\d+)><\/\1>/) | ||
| if (i18nTags) { | ||
| // check content-less tags like `<1></1>` | ||
| const invalidTags: string[] = [] | ||
| const matches = [...enValue.matchAll(/<(\d+)><\/\1>/g)] | ||
| matches.forEach((ma) => { | ||
| const str = ma[0] | ||
| if (!trValue.includes(str)) { | ||
| invalidTags.push(str) | ||
| } | ||
| }) | ||
|
|
||
| if (invalidTags.length) { | ||
| console.log( | ||
| `Missing content in translation, <X></X> tags not matching original for ${processingLanguage}.${processingFile}.${parent}.\nExpected ${enValue}\nGot: ${trValue}\n\n` | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Recursive function traversing objects | ||
| function checkValueAgainstEnglish( | ||
| trValue: string | object, | ||
| enValue: string | object, | ||
| parent?: string | ||
| ) { | ||
| if (typeof enValue === 'undefined') { | ||
| if (printExtraTransations) { | ||
| console.log( | ||
| `Extra translation not present in english for ${processingLanguage}.${processingFile}.${parent}` | ||
| ) | ||
| } | ||
| } else { | ||
| if (typeof trValue === 'string') { | ||
| checkStringValueAgainstEnglish(trValue, enValue as string, parent) | ||
| } else { | ||
| for (const key in trValue) { | ||
| checkValueAgainstEnglish(trValue[key], enValue[key], `${parent}.${key}`) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // entry point to check a single translation file | ||
| function checkFileAgainstEnglish(translations: object) { | ||
| for (const key in translations) { | ||
| checkValueAgainstEnglish( | ||
| translations[key], | ||
| enFiles[processingFile][key], | ||
| key | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| // entry point to check a single language | ||
| function checkLanguage(language: string) { | ||
| const langFiles = readFiles(language) | ||
|
|
||
| for (const file in langFiles) { | ||
| const content = langFiles[file] | ||
| if (!content) continue | ||
|
|
||
| processingFile = file | ||
| checkFileAgainstEnglish(content) | ||
| } | ||
| } | ||
|
|
||
| // loop through all translations and compare to english | ||
| readdirSync(localesPath).forEach((dir) => { | ||
| if (dir === 'en') return | ||
|
|
||
| processingLanguage = dir | ||
| checkLanguage(dir) | ||
| }) |
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
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
Oops, something went wrong.