3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 07:18:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor(theme-translations): improve typing for update script (#6225)

Browse source 
* refactor(theme-translations): improve typing for update script

* Remove
This commit is contained in:
Joshua Chen 2021-12-30 17:28:57 +08:00 • committed by GitHub
parent 83fbdb0037
commit 218789f85e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-theme-translations/package.json
View file

@ -16,7 +16,7 @@
"scripts": {
"build": "tsc",
"watch": "tsc --watch",
"update": "node -e 'require(\"./update.js\").run()'"
"update": "node ./update.js"
},
"dependencies": {
"fs-extra": "^10.0.0",

41
packages/docusaurus-theme-translations/update.js
View file

@ -43,6 +43,9 @@ const AllThemesSrcDirs = Themes.flatMap((theme) => theme.src);
logger.info`Will scan folders for code translations:path=${AllThemesSrcDirs}`;
/**
* @param {string} packageName
*/
function getPackageCodePath(packageName) {
const packagePath = path.join(__dirname, '..', packageName);
const packageJsonPath = path.join(packagePath, 'package.json');
@ -54,17 +57,27 @@ function getPackageCodePath(packageName) {
: packageSrcPath;
}
/**
* @param {string} locale
* @param {string} themeName
*/
function getThemeLocalePath(locale, themeName) {
return path.join(LocalesDirPath, locale, `${themeName}.json`);
}
/**
* @param {string} key
*/
function removeDescriptionSuffix(key) {
if (key.replace('___DESCRIPTION')) {
if (key.replace('___DESCRIPTION', '')) {
return key.replace('___DESCRIPTION', '');
}
return key;
}
/**
* @param {Record<string, string>} obj
*/
function sortObjectKeys(obj) {
let keys = Object.keys(obj);
keys = orderBy(keys, [(k) => removeDescriptionSuffix(k)]);
@ -119,6 +132,10 @@ ${warning}
return translations;
}
/**
* @param {string} filePath
* @returns {Promise<Record<string, string>>}
*/
async function readMessagesFile(filePath) {
if (!(await fs.pathExists(filePath))) {
logger.info`File path=${filePath} not found. Creating new translation base file.`;
@ -127,6 +144,10 @@ async function readMessagesFile(filePath) {
return JSON.parse((await fs.readFile(filePath)).toString());
}
/**
* @param {string} filePath
* @param {Record<string, string>} messages
*/
async function writeMessagesFile(filePath, messages) {
const sortedMessages = sortObjectKeys(messages);
@ -139,6 +160,9 @@ async function writeMessagesFile(filePath, messages) {
} messages)`}\n`;
}
/**
* @param {string} themeName
*/
async function getCodeTranslationFiles(themeName) {
const baseFile = getThemeLocalePath('base', themeName);
const localesFiles = (await fs.readdir(LocalesDirPath))
@ -149,6 +173,10 @@ async function getCodeTranslationFiles(themeName) {
const DescriptionSuffix = '___DESCRIPTION';
/**
* @param {string} baseFile
* @param {string[]} targetDirs
*/
async function updateBaseFile(baseFile, targetDirs) {
const baseMessagesWithDescriptions = await readMessagesFile(baseFile);
const baseMessages = pickBy(
@ -177,6 +205,7 @@ They won't be removed automatically, so do the cleanup manually if necessary! co
...codeMessages,
};
/** @type {Record<string, string>} */
const newBaseMessagesDescriptions = Object.entries(newBaseMessages).reduce(
(acc, [key]) => {
const codeTranslation = codeExtractedTranslations[key];
@ -200,6 +229,10 @@ They won't be removed automatically, so do the cleanup manually if necessary! co
return newBaseMessages;
}
/**
* @param {string} localeFile
* @param {Record<string, string>} baseFileMessages
*/
async function updateLocaleCodeTranslations(localeFile, baseFileMessages) {
const localeFileMessages = await readMessagesFile(localeFile);
@ -231,9 +264,10 @@ You may want to delete these! code=${unknownMessages}`;
}
async function updateCodeTranslations() {
/** @type {Record<string, {untranslated: number}>} */
const stats = {};
let messageCount = 0;
const [, newLocale] = process.argv;
const {2: newLocale} = process.argv;
// Order is important. The log messages must be in the same order as execution
// eslint-disable-next-line no-restricted-syntax
for (const theme of Themes) {
@ -277,7 +311,7 @@ async function updateCodeTranslations() {
return {stats, messageCount};
}
function run() {
if (require.main === module) {
updateCodeTranslations().then(
(result) => {
logger.success('updateCodeTranslations end\n');
@ -318,5 +352,4 @@ ${messages.join('\n')}`;
);
}
exports.run = run;
exports.extractThemeCodeMessages = extractThemeCodeMessages;