Skip to content

fix(i18n): handle utf-8 escape sequences in message bundle properties files #12784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pskelin wants to merge 2 commits into
base: main
Choose a base branch
from
+24 −1
Open

fix(i18n): handle utf-8 escape sequences in message bundle properties files #12784

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4fde69
fix(i18n): handle utf-8 escape sequences in message bundle properties…
pskelin Dec 10, 2025
e5d43d5
chore: improve func call
pskelin Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/tools/lib/i18n/toJSON.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,32 @@ const assets = require('../../assets-meta.js');

const allLanguages = assets.languages.all;

/**
* The translation system has a configuration whether to return UTF-8 sequences
* or the actual characters. This function inlines UTF-8 sequences to actual characters.
*
* For example, it converts "Keine Produkte erf\u00FCgbar" to "Keine Produkte verfügbar"
* This makes the JSON files more readable and smaller.
*/
function inlineUTF(properties) {
for (const key in properties) {
if (Object.prototype.hasOwnProperty.call(properties, key)) {
try {
// escape double quotes to avoid JSON parse error
const escaped = properties[key].replaceAll("\"", "\\\"");
properties[key] = JSON.parse(`"${escaped}"`); // utilize JSON parser to decode UTF-8 sequences
} catch (e) {
// in case of error, just keep the original string
console.log(`Warning: failed to inline UTF-8 for key "${key}" with value "${properties[key]}"`);
}
}
}
return properties;
}

const convertToJSON = async (file, distPath) => {
const properties = PropertiesReader(file)._properties;
inlineUTF(properties);
Copy link
Contributor

@nnaydenow nnaydenow Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: Lets assign that to properties because it's not very intuitive that properties will be object

const filename = path.basename(file, path.extname(file));
const language = filename.match(/^messagebundle_(.*?)$/)[1];
if (!allLanguages.includes(language)) {
Expand Down
Loading