Bert Verhelst
4 years ago
committed by
GitHub
GitHub
11 changed files with 289 additions and 149 deletions
@ -0,0 +1,99 @@ |
|||
const findInFiles = require("find-in-files"); |
|||
const _ = require("lodash"); |
|||
const fs = require("fs/promises"); |
|||
const JSON5 = require("json5"); |
|||
|
|||
// Extract translations from $t() functions in the source code and add the missing translations to all language files in src/languages/*.js
|
|||
async function extractTranslations() { |
|||
// Load all ES6 module translation files into a commonJS process
|
|||
const languageList = {}; |
|||
const filesNames = await fs.readdir("src/languages"); |
|||
for (let fileName of filesNames) { |
|||
if (fileName.endsWith("js") && fileName !== "index.js") { |
|||
const content = (await fs.readFile("src/languages/" + fileName)).toString("utf-8"); |
|||
const json = content.replace("export default {", "{").replace("};", "}"); |
|||
languageList[fileName.split(".")[0]] = JSON5.parse(json); |
|||
} |
|||
} |
|||
|
|||
const en = languageList.en; |
|||
|
|||
const englishExtracted = []; |
|||
|
|||
// Search the source code for usages of $t(...)
|
|||
const tFuncResults = await findInFiles.find({ |
|||
term: "\\$t\\(([^)]+?)\\)", |
|||
flags: "g", |
|||
}, "./src", "\\.(vue|js)"); |
|||
|
|||
// Add the found strings to the englishExtracted list
|
|||
const warnings = []; |
|||
Object.values(tFuncResults).map(result => { |
|||
result.matches.map(match => { |
|||
const functionParams = match.substring(3, match.length - 1).trim(); |
|||
const firstChar = functionParams[0]; |
|||
if (!["\"", "'"].includes(firstChar)) { |
|||
// Variable => cannot extract => output warning
|
|||
warnings.push("Cannot extract non string values in " + match); |
|||
} else { |
|||
// Actual string
|
|||
const content = _.trim(functionParams.split(firstChar)[1], "\"' "); |
|||
englishExtracted.push(content); |
|||
} |
|||
}); |
|||
}); |
|||
|
|||
// Search the source code for usages of <i18n-t tag="..." keypath="...">
|
|||
const i18nTTagResults = await findInFiles.find({ |
|||
term: "<i18n-t[^>]+keypath=\"([^\"]+)\"[^>]*>", |
|||
flags: "g", |
|||
}, "./src", "\\.vue"); |
|||
|
|||
// Add the found strings to the englishExtracted list
|
|||
Object.values(i18nTTagResults).map(result => { |
|||
result.matches.map(match => { |
|||
const content = _.trim(match.split("keypath")[1].split("\"")[1], "\"' "); |
|||
englishExtracted.push(content); |
|||
}); |
|||
}); |
|||
|
|||
// Update all languages with the missing strings
|
|||
for (let extractedTranslation of englishExtracted) { |
|||
for (let langDict of Object.values(languageList)) { |
|||
if (!Object.keys(langDict).includes(extractedTranslation)) { |
|||
langDict[extractedTranslation] = en[extractedTranslation] || extractedTranslation; |
|||
} |
|||
} |
|||
} |
|||
|
|||
// Check for translations in other language files that are not in the English file and output warnings for them
|
|||
const englishKeys = Object.keys(en); |
|||
for (let langName of Object.keys(languageList)) { |
|||
if (langName !== "en") { |
|||
const langKeys = Object.keys(languageList[langName]); |
|||
const unusedKeys = _.without(langKeys, ...englishKeys); |
|||
if (unusedKeys.length) { |
|||
warnings.push(`Language file ${langName} contains keys that are not used: ["${unusedKeys.join("\", \"")}"]`); |
|||
} |
|||
} |
|||
} |
|||
|
|||
// Write the translation string json back to files
|
|||
for (let langName of Object.keys(languageList)) { |
|||
const translationsString = JSON5.stringify(languageList[langName], { |
|||
quote: "\"", |
|||
space: 4, |
|||
}) |
|||
.replace(/"$/m, "\","); // Add comma to the last line
|
|||
await fs.writeFile(`./src/languages/${_.kebabCase(langName)}.js`, `export default ${translationsString};\n`); |
|||
} |
|||
|
|||
// Output warnings if there are any
|
|||
if (warnings.length) { |
|||
console.log("Extraction successful with warnings: \n\t" + warnings.join("\n\t")); |
|||
} else { |
|||
console.log("Extraction successful"); |
|||
} |
|||
} |
|||
|
|||
extractTranslations(); |
|||
@ -1,3 +0,0 @@ |
|||
package-lock.json |
|||
test.js |
|||
languages/ |
|||
@ -1,86 +0,0 @@ |
|||
// Need to use ES6 to read language files
|
|||
|
|||
import fs from "fs"; |
|||
import path from "path"; |
|||
import util from "util"; |
|||
|
|||
// https://stackoverflow.com/questions/13786160/copy-folder-recursively-in-node-js
|
|||
/** |
|||
* Look ma, it's cp -R. |
|||
* @param {string} src The path to the thing to copy. |
|||
* @param {string} dest The path to the new copy. |
|||
*/ |
|||
const copyRecursiveSync = function (src, dest) { |
|||
let exists = fs.existsSync(src); |
|||
let stats = exists && fs.statSync(src); |
|||
let isDirectory = exists && stats.isDirectory(); |
|||
|
|||
if (isDirectory) { |
|||
fs.mkdirSync(dest); |
|||
fs.readdirSync(src).forEach(function (childItemName) { |
|||
copyRecursiveSync(path.join(src, childItemName), |
|||
path.join(dest, childItemName)); |
|||
}); |
|||
} else { |
|||
fs.copyFileSync(src, dest); |
|||
} |
|||
}; |
|||
|
|||
console.log("Arguments:", process.argv); |
|||
const baseLangCode = process.argv[2] || "en"; |
|||
console.log("Base Lang: " + baseLangCode); |
|||
if (fs.existsSync("./languages")) { |
|||
fs.rmdirSync("./languages", { recursive: true }); |
|||
} |
|||
copyRecursiveSync("../../src/languages", "./languages"); |
|||
|
|||
const en = (await import("./languages/en.js")).default; |
|||
const baseLang = (await import(`./languages/${baseLangCode}.js`)).default; |
|||
const files = fs.readdirSync("./languages"); |
|||
console.log("Files:", files); |
|||
|
|||
for (const file of files) { |
|||
if (!file.endsWith(".js")) { |
|||
console.log("Skipping " + file); |
|||
continue; |
|||
} |
|||
|
|||
console.log("Processing " + file); |
|||
const lang = await import("./languages/" + file); |
|||
|
|||
let obj; |
|||
|
|||
if (lang.default) { |
|||
obj = lang.default; |
|||
} else { |
|||
console.log("Empty file"); |
|||
obj = { |
|||
languageName: "<Your Language name in your language (not in English)>" |
|||
}; |
|||
} |
|||
|
|||
// En first
|
|||
for (const key in en) { |
|||
if (! obj[key]) { |
|||
obj[key] = en[key]; |
|||
} |
|||
} |
|||
|
|||
if (baseLang !== en) { |
|||
// Base second
|
|||
for (const key in baseLang) { |
|||
if (! obj[key]) { |
|||
obj[key] = key; |
|||
} |
|||
} |
|||
} |
|||
|
|||
const code = "export default " + util.inspect(obj, { |
|||
depth: null, |
|||
}); |
|||
|
|||
fs.writeFileSync(`../../src/languages/${file}`, code); |
|||
} |
|||
|
|||
fs.rmdirSync("./languages", { recursive: true }); |
|||
console.log("Done. Fixing formatting by ESLint..."); |
|||
@ -1,12 +0,0 @@ |
|||
{ |
|||
"name": "update-language-files", |
|||
"type": "module", |
|||
"version": "1.0.0", |
|||
"description": "", |
|||
"main": "index.js", |
|||
"scripts": { |
|||
"test": "echo \"Error: no test specified\" && exit 1" |
|||
}, |
|||
"author": "", |
|||
"license": "ISC" |
|||
} |
|||
Loading…
Reference in new issue