fix(Crowdin): whitespace loss after translation#328

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

Merged
ReenigneArcher merged 1 commit into from
Aug 11, 2026
Merged

fix(Crowdin): whitespace loss after translation #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions examples/jekyll/_config.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
- "../dist/crowdin-bootstrap-css.css"
- "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
- "../dist/crowdin.js"
- "/assets/shared-web/crowdin.js"
- "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down
17 changes: 17 additions & 0 deletions examples/jekyll/build.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
'crowdin.js',
'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});
4 changes: 3 additions & 1 deletion examples/jekyll/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
"postinstall": "npm-run-all postinstall:*",
"postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
"postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
"build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
"build": "npm-run-all build:site build:assets",
"build:assets": "node build.js",
"build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
}
}
2 changes: 1 addition & 1 deletion examples/sphinx/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
"scripts": {
"postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
"build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
"lint": "python -m rstcheck -r ."
"lint": "python -m rstcheck -r source"
}
}
9 changes: 6 additions & 3 deletions examples/sphinx/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
'_static',
'../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
# use jsdelivr for an easy way to include the css
# 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
'../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
# use jsdelivr for an easy way to include the script
# 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
'../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
'crowdin.js', # crowdin language selector from the installed shared-web package
'js/crowdin.js', # initialize crowdin language selector
]

Expand Down
140 changes: 140 additions & 0 deletions src/js/crowdin.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
'a',
'abbr',
'b',
'cite',
'code',
'del',
'em',
'i',
'ins',
'kbd',
'mark',
'q',
's',
'samp',
'small',
'span',
'strong',
'sub',
'sup',
'time',
'u',
'var',
].join(',');

/**
* Records whitespace that separates text from inline elements before Crowdin translates the page.
* @returns {Array<{
* node: Text,
* leading: boolean,
* trailing: boolean,
* previousInline: Element|null,
* nextInline: Element|null,
* whitespaceOnly: boolean
* }>} Recorded text-node boundaries.
*/
function _captureCrowdinWhitespaceBoundaries() {
const boundaries = [];
const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
let node = walker.nextNode();

while (node !== null) {
const previousIsInline = node.previousSibling instanceof globalThis.Element &&
node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
const nextIsInline = node.nextSibling instanceof globalThis.Element &&
node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
const leading = previousIsInline && /^\s/.test(node.data);
const trailing = nextIsInline && /\s$/.test(node.data);

if (leading || trailing) {
boundaries.push({
node,
leading,
trailing,
previousInline: previousIsInline ? node.previousSibling : null,
nextInline: nextIsInline ? node.nextSibling : null,
whitespaceOnly: /^\s*$/.test(node.data),
});
}

node = walker.nextNode();
}

return boundaries;
}

/**
* Finds the current text node for a boundary after Crowdin changes the DOM.
* @param {Object} boundary Recorded whitespace boundary.
* @returns {Text|null} Current or recreated text node.
*/
function _resolveCrowdinWhitespaceNode(boundary) {
if (boundary.node.isConnected) return boundary.node;

const previousReplacement = boundary.previousInline?.nextSibling;
if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
boundary.node = previousReplacement;
return boundary.node;
}
const nextReplacement = boundary.nextInline?.previousSibling;
if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
boundary.node = nextReplacement;
return boundary.node;
}
if (!boundary.whitespaceOnly) return null;

const replacement = document.createTextNode('');
if (boundary.previousInline?.isConnected) {
boundary.previousInline.after(replacement);
} else if (boundary.nextInline?.isConnected) {
boundary.nextInline.before(replacement);
} else {
return null;
}

boundary.node = replacement;
return boundary.node;
}

/**
* Restores whitespace that Crowdin removed from translated text-node boundaries.
* @param {Array<Object>} boundaries Recorded text-node boundaries.
*/
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
boundaries.forEach((boundary) => {
const node = _resolveCrowdinWhitespaceNode(boundary);
if (node === null) return;

if (boundary.leading && !/^\s/.test(node.data)) {
node.data = ' ' + node.data;
}
if (boundary.trailing && !/\s$/.test(node.data)) {
node.data += ' ';
}
});
}

/**
* Creates the Website Translator callback and observes later translation mutations.
* @param {Array<Object>} boundaries Recorded text-node boundaries.
* @returns {Function} Website Translator callback.
*/
function _createCrowdinTranslationCallback(boundaries) {
const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

function restoreAndObserve() {
translationObserver.disconnect();
_restoreCrowdinWhitespaceBoundaries(boundaries);
translationObserver.observe(document.body, {
characterData: true,
childList: true,
subtree: true,
});
}

return restoreAndObserve;
}

/**
* Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
let currentBaseUrl = globalThis.location.origin;

// Initialize Crowdin translator
const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

globalThis.proxyTranslator.init({
baseUrl: currentBaseUrl,
callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
distribution: projectSettings[project].distribution,
defaultLanguage: "en",
languageTitles: languageTitles,
Expand Down
84 changes: 84 additions & 0 deletions tests/crowdin.test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
jest.clearAllMocks();
jest.useRealTimers();
delete globalThis.window.proxyTranslator;
delete globalThis.window.i18nextify;
delete globalThis._crowdinMirrorInstalled;
});

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
);
});

it('should only pass supported Website Translator options', () => {
initCrowdIn();

// Simulate script loading
jest.runAllTimers();

const options = globalThis.proxyTranslator.init.mock.calls[0][0];
expect(Object.keys(options).sort()).toEqual([
'baseUrl',
'callback',
'defaultLanguage',
'distribution',
'languageRoutingMethod',
'languageTitles',
'position',
'poweredBy',
'showDefaultLanguageInUrl',
'submenuPosition',
]);
});

it('should restore whitespace around translated inline elements', () => {
globalThis.document.body.innerHTML = `
<p id="translated">
GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
</p>
<p id="detached">Before <i>removed</i></p>
<p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
<p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
`;

initCrowdIn();
jest.runAllTimers();

const options = globalThis.proxyTranslator.init.mock.calls[0][0];
const translated = globalThis.document.getElementById('translated');
const emphasis = translated.querySelector('em');
const strongElements = translated.querySelectorAll('strong');
const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
const nextAnchor = globalThis.document.getElementById('next-anchor');
const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
const noAnchor = globalThis.document.getElementById('no-anchor');

emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
strongElements[0].nextSibling.remove();
detachedBoundary.remove();
nextAnchor.querySelector('i').remove();
nextAnchorWhitespace.remove();
noAnchor.remove();

options.callback();
options.callback();

expect(translated.textContent.trim()).toBe(
'GitHub Discussions are available. Yearly: $14.99, billed.'
);
expect(nextAnchor.textContent).toBe(' kept');
});

it('should restore whitespace after later asynchronous DOM changes', async () => {
globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

initCrowdIn();
jest.runAllTimers();

const options = globalThis.proxyTranslator.init.mock.calls[0][0];
const translated = globalThis.document.getElementById('translated');
const link = translated.querySelector('a');

options.callback();
link.previousSibling.data = link.previousSibling.data.trimEnd();
await Promise.resolve();

expect(translated.textContent).toBe('Use this link here.');

jest.advanceTimersByTime(1000);
link.nextSibling.data = link.nextSibling.data.trimStart();
await Promise.resolve();

expect(translated.textContent).toBe('Use this link here.');
});

it('should initialize proxyTranslator with LizardByte-docs settings', () => {
initCrowdIn('LizardByte-docs');

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(Crowdin): whitespace loss after translation#328

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

 Merged

ReenigneArcher
merged 1 commit into

from

Aug 11, 2026
 Merged


fix(Crowdin): whitespace loss after translation
#328
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
examples/jekyll/_config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,9 @@ page-col: "#303436"
text-col: "#e4e4e4"
mobile-theme-col: "#05FF3B"
site-css:
 - "../dist/crowdin-bootstrap-css.css"
 - "/assets/shared-web/crowdin-bootstrap-css.css"
site-js:
 - "../dist/crowdin.js"
 - "/assets/shared-web/crowdin.js"
 - "/assets/js/crowdin-init.js"

# Advanced settings
Expand Down

17 changes: 17 additions & 0 deletions
examples/jekyll/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
const fs = require('node:fs');
const path = require('node:path');

const exampleDir = __dirname;
const outputRoot = process.env.READTHEDOCS_OUTPUT || path.join(exampleDir, 'build');
const assetDir = path.join(outputRoot, 'html', 'jekyll', 'assets', 'shared-web');
const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
const sharedWebAssets = [
 'crowdin.js',
 'crowdin-bootstrap-css.css',
];

fs.mkdirSync(assetDir, { recursive: true });

sharedWebAssets.forEach((asset) => {
 fs.copyFileSync(path.join(sharedWebDist, asset), path.join(assetDir, asset));
});

4 changes: 3 additions & 1 deletion
examples/jekyll/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@
 "postinstall": "npm-run-all postinstall:*",
 "postinstall:bundler": "echo 'Installing bundler...' && gem install bundler",
 "postinstall:bundle": "echo 'Installing Jekyll dependencies...' && bundle install",
 "build": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 "build": "npm-run-all build:site build:assets",
 "build:assets": "node build.js",
 "build:site": "bundle exec jekyll build --verbose --destination ${READTHEDOCS_OUTPUT:-build/}html/jekyll"
 }
}

2 changes: 1 addition & 1 deletion
examples/sphinx/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,6 @@
 "scripts": {
 "postinstall": "echo 'Installing Python dependencies...' && python -m pip install -r requirements.txt --no-cache-dir",
 "build": "python -m sphinx -b html source ${READTHEDOCS_OUTPUT:-build/}html/sphinx/html",
 "lint": "python -m rstcheck -r ."
 "lint": "python -m rstcheck -r source"
 }
}

9 changes: 6 additions & 3 deletions
examples/sphinx/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,19 +60,22 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [
 '_static',
 '../node_modules/@lizardbyte/shared-web/dist',
]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
 # use jsdelivr for an easy way to include the css
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin-furo-css.css',
 '../../../dist/crowdin-furo-css.css', # crowdin style from the readthedocs build
 'crowdin-furo-css.css', # crowdin style from the installed shared-web package
]
html_js_files = [
 # use jsdelivr for an easy way to include the script
 # 'https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/crowdin.js',
 '../../../dist/crowdin.js', # crowdin language selector from the readthedocs build
 'crowdin.js', # crowdin language selector from the installed shared-web package
 'js/crowdin.js', # initialize crowdin language selector
]

Expand Down

140 changes: 140 additions & 0 deletions
src/js/crowdin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,143 @@ const loadScript = require('./load-script');
const CROWDIN_DIST_MIRROR = 'https://cdn.jsdelivr.net/gh/LizardByte/i18n@dist';
const CROWDIN_PLATFORM_STYLING_MAX_ATTEMPTS = 100;
const CROWDIN_PLATFORM_STYLING_RETRY_DELAY_MS = 50;
const CROWDIN_INLINE_ELEMENT_SELECTOR = [
 'a',
 'abbr',
 'b',
 'cite',
 'code',
 'del',
 'em',
 'i',
 'ins',
 'kbd',
 'mark',
 'q',
 's',
 'samp',
 'small',
 'span',
 'strong',
 'sub',
 'sup',
 'time',
 'u',
 'var',
].join(',');

/**
 * Records whitespace that separates text from inline elements before Crowdin translates the page.
 * @returns {Array<{
 * node: Text,
 * leading: boolean,
 * trailing: boolean,
 * previousInline: Element|null,
 * nextInline: Element|null,
 * whitespaceOnly: boolean
 * }>} Recorded text-node boundaries.
 */
function _captureCrowdinWhitespaceBoundaries() {
 const boundaries = [];
 const walker = document.createTreeWalker(document.body, globalThis.NodeFilter.SHOW_TEXT);
 let node = walker.nextNode();

 while (node !== null) {
 const previousIsInline = node.previousSibling instanceof globalThis.Element &&
 node.previousSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const nextIsInline = node.nextSibling instanceof globalThis.Element &&
 node.nextSibling.matches(CROWDIN_INLINE_ELEMENT_SELECTOR);
 const leading = previousIsInline && /^\s/.test(node.data);
 const trailing = nextIsInline && /\s$/.test(node.data);

 if (leading || trailing) {
 boundaries.push({
 node,
 leading,
 trailing,
 previousInline: previousIsInline ? node.previousSibling : null,
 nextInline: nextIsInline ? node.nextSibling : null,
 whitespaceOnly: /^\s*$/.test(node.data),
 });
 }

 node = walker.nextNode();
 }

 return boundaries;
}

/**
 * Finds the current text node for a boundary after Crowdin changes the DOM.
 * @param {Object} boundary Recorded whitespace boundary.
 * @returns {Text|null} Current or recreated text node.
 */
function _resolveCrowdinWhitespaceNode(boundary) {
 if (boundary.node.isConnected) return boundary.node;

 const previousReplacement = boundary.previousInline?.nextSibling;
 if (previousReplacement instanceof globalThis.Text && previousReplacement.isConnected) {
 boundary.node = previousReplacement;
 return boundary.node;
 }
 const nextReplacement = boundary.nextInline?.previousSibling;
 if (nextReplacement instanceof globalThis.Text && nextReplacement.isConnected) {
 boundary.node = nextReplacement;
 return boundary.node;
 }
 if (!boundary.whitespaceOnly) return null;

 const replacement = document.createTextNode('');
 if (boundary.previousInline?.isConnected) {
 boundary.previousInline.after(replacement);
 } else if (boundary.nextInline?.isConnected) {
 boundary.nextInline.before(replacement);
 } else {
 return null;
 }

 boundary.node = replacement;
 return boundary.node;
}

/**
 * Restores whitespace that Crowdin removed from translated text-node boundaries.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 */
function _restoreCrowdinWhitespaceBoundaries(boundaries) {
 boundaries.forEach((boundary) => {
 const node = _resolveCrowdinWhitespaceNode(boundary);
 if (node === null) return;

 if (boundary.leading && !/^\s/.test(node.data)) {
 node.data = ' ' + node.data;
 }
 if (boundary.trailing && !/\s$/.test(node.data)) {
 node.data += ' ';
 }
 });
}

/**
 * Creates the Website Translator callback and observes later translation mutations.
 * @param {Array<Object>} boundaries Recorded text-node boundaries.
 * @returns {Function} Website Translator callback.
 */
function _createCrowdinTranslationCallback(boundaries) {
 const translationObserver = new globalThis.MutationObserver(restoreAndObserve);

 function restoreAndObserve() {
 translationObserver.disconnect();
 _restoreCrowdinWhitespaceBoundaries(boundaries);
 translationObserver.observe(document.body, {
 characterData: true,
 childList: true,
 subtree: true,
 });
 }

 return restoreAndObserve;
}

/**
 * Monkey-patches globalThis.fetch to redirect Crowdin distribution requests to
Expand DownExpand Up@@ -171,8 +308,11 @@ function initCrowdIn(project = 'LizardByte', platform = null) {
 let currentBaseUrl = globalThis.location.origin;

 // Initialize Crowdin translator
 const whitespaceBoundaries = _captureCrowdinWhitespaceBoundaries();

 globalThis.proxyTranslator.init({
 baseUrl: currentBaseUrl,
 callback: _createCrowdinTranslationCallback(whitespaceBoundaries),
 distribution: projectSettings[project].distribution,
 defaultLanguage: "en",
 languageTitles: languageTitles,
Expand Down

84 changes: 84 additions & 0 deletions
tests/crowdin.test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,7 @@ describe('initCrowdIn', () => {
 jest.clearAllMocks();
 jest.useRealTimers();
 delete globalThis.window.proxyTranslator;
 delete globalThis.window.i18nextify;
 delete globalThis._crowdinMirrorInstalled;
 });

Expand DownExpand Up@@ -114,6 +115,89 @@ describe('initCrowdIn', () => {
 );
 });

 it('should only pass supported Website Translator options', () => {
 initCrowdIn();

 // Simulate script loading
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 expect(Object.keys(options).sort()).toEqual([
 'baseUrl',
 'callback',
 'defaultLanguage',
 'distribution',
 'languageRoutingMethod',
 'languageTitles',
 'position',
 'poweredBy',
 'showDefaultLanguageInUrl',
 'submenuPosition',
 ]);
 });

 it('should restore whitespace around translated inline elements', () => {
 globalThis.document.body.innerHTML = `
 <p id="translated">
 GitHub <em>Discussions</em> are available. <strong>Yearly:</strong> <strong>$14.99</strong>, billed.
 </p>
 <p id="detached">Before <i>removed</i></p>
 <p id="next-anchor"><i>gone</i> <strong>kept</strong></p>
 <p id="no-anchor"><i>gone</i> <strong>also gone</strong></p>
 `;

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const emphasis = translated.querySelector('em');
 const strongElements = translated.querySelectorAll('strong');
 const detachedBoundary = globalThis.document.querySelector('#detached i').previousSibling;
 const nextAnchor = globalThis.document.getElementById('next-anchor');
 const nextAnchorWhitespace = nextAnchor.querySelector('i').nextSibling;
 const noAnchor = globalThis.document.getElementById('no-anchor');

 emphasis.previousSibling.replaceWith(document.createTextNode('GitHub'));
 emphasis.nextSibling.replaceWith(document.createTextNode('are available. '));
 strongElements[0].nextSibling.remove();
 detachedBoundary.remove();
 nextAnchor.querySelector('i').remove();
 nextAnchorWhitespace.remove();
 noAnchor.remove();

 options.callback();
 options.callback();

 expect(translated.textContent.trim()).toBe(
 'GitHub Discussions are available. Yearly: $14.99, billed.'
 );
 expect(nextAnchor.textContent).toBe(' kept');
 });

 it('should restore whitespace after later asynchronous DOM changes', async () => {
 globalThis.document.body.innerHTML = '<p id="translated">Use <a href="#">this link</a> here.</p>';

 initCrowdIn();
 jest.runAllTimers();

 const options = globalThis.proxyTranslator.init.mock.calls[0][0];
 const translated = globalThis.document.getElementById('translated');
 const link = translated.querySelector('a');

 options.callback();
 link.previousSibling.data = link.previousSibling.data.trimEnd();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');

 jest.advanceTimersByTime(1000);
 link.nextSibling.data = link.nextSibling.data.trimStart();
 await Promise.resolve();

 expect(translated.textContent).toBe('Use this link here.');
 });

 it('should initialize proxyTranslator with LizardByte-docs settings', () => {
 initCrowdIn('LizardByte-docs');

Expand Down