Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[localize-tools] Preserve existing placeholder id/index on extract #4503

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
augustjk merged 4 commits into from
Jan 18, 2024
Merged

[localize-tools] Preserve existing placeholder id/index on extract #4503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
525a14d
Add regression test
augustjk Jan 17, 2024
f784da8
Use existing index for placeholder id
augustjk Jan 18, 2024
21992af
Add changeset
augustjk Jan 18, 2024
478e693
Apply fix to xlb mode
augustjk Jan 18, 2024
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
5 changes: 5 additions & 0 deletions .changeset/mean-cars-appear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@lit/localize-tools': patch
---

Fix an issue where running `extract` on an existing translation target would rewrite the "id" for placeholders signifying the expression index, which breaks translation targets where the expressions need to be reordered.
5 changes: 2 additions & 3 deletions packages/localize-tools/src/formatters/xlb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,13 @@ class XlbFormatter implements Formatter {
}
indent(messagesNode, 2);
messagesNode.appendChild(messageNode);
let phIdx = 0;
for (const content of contents) {
if (typeof content === 'string') {
messageNode.appendChild(doc.createTextNode(content));
} else {
const {untranslatable} = content;
const {untranslatable, index} = content;
const ph = doc.createElement('ph');
ph.setAttribute('name', String(phIdx++));
ph.setAttribute('name', String(index));
ph.appendChild(doc.createTextNode(untranslatable));
messageNode.appendChild(ph);
}
Expand Down
11 changes: 5 additions & 6 deletions packages/localize-tools/src/formatters/xliff.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,25 +278,24 @@ export class XliffFormatter implements Formatter {
*/
private encodeContents(doc: Document, contents: Message['contents']): Node[] {
const nodes = [];
// We need a unique ID within each source for each placeholder. The index
// will do.
let phIdx = 0;
for (const content of contents) {
if (typeof content === 'string') {
nodes.push(doc.createTextNode(content));
} else {
nodes.push(this.createPlaceholder(doc, String(phIdx++), content));
nodes.push(this.createPlaceholder(doc, content));
}
}
return nodes;
}

private createPlaceholder(
doc: Document,
id: string,
{untranslatable}: Placeholder
{untranslatable, index}: Placeholder
): HTMLElement {
const style = this.xliffConfig.placeholderStyle ?? 'x';
// We need a unique ID within each source for each placeholder. The index
// will do.
const id = String(index);
if (style === 'x') {
// https://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html#x
const el = doc.createElement('x');
Expand Down
2 changes: 2 additions & 0 deletions packages/localize-tools/testdata/extract-xliff-merge/goldens/foo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
import {msg, str} from '@lit/localize';

const who = 'World';
const kind = 'Small';
msg(str`I am translated. Hello ${who}.`, {desc: 'Description of translated'});
msg(str`I am translated with swapped order. Hello ${kind} ish ${who}.`);
msg('I am not translated', {desc: 'Description of not translated'});
msg('I am translated with a note', {desc: 'Happy note'});
msg('My note needs to be migrated', {desc: 'Existing note'});
4 changes: 4 additions & 0 deletions packages/localize-tools/testdata/extract-xliff-merge/goldens/xliff/es-419.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
<target state="translated">Estoy traducido. Hola <ph id="0">${who}</ph>.</target>
<note from="lit-localize">Description of translated</note>
</trans-unit>
<trans-unit id="s648aae3daabd8fcc">
<source>I am translated with swapped order. Hello <ph id="0">${kind}</ph> ish <ph id="1">${who}</ph>.</source>
<target state="translated">Estoy traducido con orden intercambiada. Hola <ph id="1">${who}</ph> más o menos <ph id="0">${kind}</ph>.</target>
</trans-unit>
<trans-unit id="s18fa8e4d6470399d">
<source foo:attribute="bar">I am translated with a note</source>
<target state="translated">Estoy traducido con una nota</target>
Expand Down
2 changes: 2 additions & 0 deletions packages/localize-tools/testdata/extract-xliff-merge/input/foo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
import {msg, str} from '@lit/localize';

const who = 'World';
const kind = 'Small';
msg(str`I am translated. Hello ${who}.`, {desc: 'Description of translated'});
msg(str`I am translated with swapped order. Hello ${kind} ish ${who}.`);
msg('I am not translated', {desc: 'Description of not translated'});
msg('I am translated with a note', {desc: 'Happy note'});
msg('My note needs to be migrated', {desc: 'Existing note'});
4 changes: 4 additions & 0 deletions packages/localize-tools/testdata/extract-xliff-merge/input/xliff/es-419.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
<source>I was translated. Hello <ph id="0">${who}</ph>.</source>
<target state="translated">Estoy traducido. Hola <ph id="0">${who}</ph>.</target>
</trans-unit>
<trans-unit id="s648aae3daabd8fcc">
<source>I am translated with swapped order. Hello <ph id="0">${kind}</ph> ish <ph id="1">${who}</ph>.</source>
<target state="translated">Estoy traducido con orden intercambiada. Hola <ph id="1">${who}</ph> más o menos <ph id="0">${kind}</ph>.</target>
</trans-unit>
<trans-unit id="s18fa8e4d6470399d">
<source foo:attribute="bar">I am translated with a note</source>
<target state="translated">Estoy traducido con una nota</target>
Expand Down