mirror of
https://github.com/FreeTubeApp/FreeTube.git
synced 2025-12-05 01:10:31 +00:00
77109c87a5
* Fix template strings * add script to make it easier to find issues with template strings * switch to sync fs, exclude non yaml files, add jsdoc comment * Don't fail on duplicate templates in the same string We should only need to validate if the key is in the string, not how many times the key is in the string
87 lines
3.0 KiB
JavaScript
87 lines
3.0 KiB
JavaScript
import { readdirSync, readFileSync, writeFileSync } from 'node:fs'
|
|
import { join } from 'node:path'
|
|
import { load as loadYaml } from 'js-yaml'
|
|
|
|
const localesPath = join(import.meta.dirname, '..', 'static', 'locales')
|
|
const defaultLocale = 'en-US.yaml'
|
|
|
|
const errors = [
|
|
|
|
]
|
|
|
|
const defaultData = loadYaml(readFileSync(`${localesPath}/${defaultLocale}`, { encoding: 'utf-8' }))
|
|
const defaultKeys = Object.keys(defaultData)
|
|
|
|
const filesInLocaleDir = readdirSync(localesPath)
|
|
|
|
for (const file of filesInLocaleDir) {
|
|
if (file !== defaultLocale && file.endsWith('.yaml')) {
|
|
const fileData = loadYaml(readFileSync(`${localesPath}/${file}`, { encoding: 'utf-8' }))
|
|
const fileDataKeys = Object.keys(fileData)
|
|
addErrors(defaultData, fileData, defaultKeys, fileDataKeys, file)
|
|
}
|
|
}
|
|
|
|
writeFileSync('locale-errors.json', JSON.stringify(errors, null, 2))
|
|
|
|
if (errors.length > 0) {
|
|
console.error(errors)
|
|
} else {
|
|
console.log('no issues found')
|
|
}
|
|
|
|
/**
|
|
* @param {unknown} originalData - data from en-US converted to a JavaScript object
|
|
* @param {unknown} newData - data from the file we are analyzing converted to a JavaScript object
|
|
* @param {string[]} originalKeys - keys from en-US file
|
|
* @param {string[]} newKeys - keys from the file we are currently analyzing
|
|
* @param {string} file - the file we are currently analyzing
|
|
*/
|
|
function addErrors(originalData, newData, originalKeys, newKeys, file) {
|
|
newKeys.forEach(newKey => {
|
|
if (originalKeys.includes(newKey)) {
|
|
if (typeof originalData[newKey] === 'object') {
|
|
addErrors(originalData[newKey], newData[newKey], Object.keys(originalData[newKey]), Object.keys(newData[newKey]), file)
|
|
} else if (isMissingInterpolation(originalData[newKey], newData[newKey], file)) {
|
|
errors.push({ fileName: file, error: 'value is missing a template or has an extra template', key: newKey, defaultValue: originalData[newKey], value: newData[newKey] })
|
|
}
|
|
} else {
|
|
// The key doesn't exist in the en-US file but exists in current yaml file.
|
|
// We should go through this eventually but it's not as important as invalid templates
|
|
|
|
// errors.push({ fileName: file, error: 'extra key found', key: fdk })
|
|
}
|
|
})
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {String} defaultValue
|
|
* @param {String} otherValue
|
|
*/
|
|
function isMissingInterpolation(defaultValue, otherValue, filename) {
|
|
if (otherValue === '') {
|
|
// not translated yet, we don't care
|
|
return false
|
|
}
|
|
const defaultMatches = Array.from(new Set(defaultValue.match(/{[^}]*}/g)))
|
|
const otherMatches = Array.from(new Set(otherValue.match(/{[^}]*}/g)))
|
|
|
|
if (defaultMatches) {
|
|
if (!otherMatches) {
|
|
// no templates found.
|
|
return true
|
|
}
|
|
defaultMatches.sort()
|
|
otherMatches.sort()
|
|
|
|
const defaultMatchesStringified = JSON.stringify(defaultMatches)
|
|
const otherMatchesStringified = JSON.stringify(otherMatches)
|
|
// check if templates match.
|
|
return defaultMatchesStringified !== otherMatchesStringified
|
|
} else if (otherMatches) {
|
|
// extra template found
|
|
return true
|
|
}
|
|
}
|