t2ym / xliff-conv Goto Github PK

Support non-string values in todo.value.

Greetings,

In our translation system, we store XLIFF files in git and we don't use the 'state' attribute.

To avoid marking the entire file as changed after merging with a JSON, we'd like to be able to skip the 'state' attribute that is currently being forced.

I'm preparing a pull request with this change.

Thank you,
Felipe

Support AMD global exports

Successive 2 build cycles are required to reflect auto-translated-state annotations to JSON and XLIFF.

Since pattern matching expressions as of 0.0.11 are applied through XLIFF import, JSON todo items for newly added strings are removed, that is, regarded as translated, only after 2 successive build cycles.

Required 2 Successive Build Cycles:

1. HTML with new strings -> JSON with 'add' todo.op (through leverage) -> export XLIFF with 'new' state -> feedback to src XLIFF
2. Import XLIFF with 'new' state -> JSON without todo (expression matching) -> XLIFF with 'translated' state for annotations

This behavior is by design for now. Better solution is under investigation.

approved="yes" attribute is missing when state attribute defaults to "translated" due to unknown todo.op.

_$type$_ prefix is not removed in target strings

Empty strings in JSON are not updated by XLIFF.

The root cause is the empty strings unexpectedly treated as inexistent in JSON.

_$type$_ prefix is not removed in generated todo items' source strings.

Add <tool> tag with tool-id, tool-name, tool-version attributes.

Support ES Module

Import

import XliffConv from 'xliff-conv/esm/xliff-conv.js'; // .js extension

import XliffConv from 'xliff-conv/xliff-conv.mjs'; // .mjs extension

Files

Build

# generate esm/xliff-conv.js, xliff-conv.mjs, xliff-conv.js from src/xliff-conv.js
npm run build # (= node build.js)

Customize logger functions.

XliffConv(options):
options.logger - information logger; defaults to console.log
options.warnLogger - warning logger; defaults to console.warn
options.errorLogger - error logger; defaults to console.error

Implement pattern matching expression [value~=pattern]

pattern can be named, predefined, and customizable.

Add XLIFF and JSON statistics on parseXliff() as its second callback argument

Exception is thrown due to Array.contains() polyfill at _todoOps().

for (var i = 0; i < array.length; i++) should be used instead of for (var i in array)

Add XLIFF statistics on parseJSON() as its second callback argument

Illegal invocation on loggers

this must be console for console.log(), console.warn(), and console.error() functions.

Default unapproved state has to be 'needs-translation'.

The state has to be mapped to todo.op 'replace'.

README state table has to be updated as well.

Exception on missing meta.todo object.

Support the special empty value "" to remove attribute

var xliffOptions =
{ xliffStates: {
  'add'    : [ 'new' ],
  'replace': [ 'needs-translation', 'needs-adaptation', 'needs-l10n' ],
  'approve' : [ '""', 'needs-review-translation', 'needs-review-adaptation', 'needs-review-l10n', 
        '[!approved&&state:=""&&approved:=no]' ],
  'default': [ '', 'translated', 'signed-off', 'final', '[approved]' ]
} };

As xliff2bundlejson is unaware of todo items in JSON and state attributes in XLIFF, todo items are likely to be removed manually or by the finalize option in gulp-i18n-leverage.

For xliff-conv, handy migration from such xliff2bundlejson configurations has to be provided.

The finalize option should be enabled only for production builds (without feedback task) and todo items in JSON files have to be kept intact through development cycles.

Add file attribute values in XLIFF stats

stats.xliff.file = { "source-language": "en", ... }

Add todoUpdated stats counter for parseXliff()

The counter is incremented whenever a meta.todo item is added, removed, or updated.

Add valueUpdated stats counter for parseXliff()

The counter is incremented if the new value is different from the old value.

Our translation workflow involves the use of XLIFF-supported tags not present in xliff-conv such as <note/>. We also don't care much about <header/> and usually prefer version 1.2 to 1.0.

All those differences can be addressed by supporting custom templates as parameters to parseJSON().

I'm preparing a pull request that adds this support.

Thank you,
Felipe

Support cancelling approval of approved items.

todo items for unapproved items have to be re-populated.

Set attribute values in XLIFF at export.

tag.attribute:=value

Put higher priorities in expressions than static XLIFF states instead of matching static XLIFF states first.

With this enhancement, expressions can override existing XLIFF states.