microsoft/vscode-nls-dev

Need a way to provide a comment/hint in package.nls.json

Colengms opened this issue · 5 comments

This is a request to provide support for specifying a comment/hint in package.nls.json, for translators

We'd like to start using the markdownDescription field for some of our extension settings. We'd like to be able to provide a comment/hint to translators that these strings (in package.nls.json) contain markdown, so translators are aware of it and avoid removing or corrupting the markdown syntax.

I don't see any comment/hint field handled for package.nls.json, in the implementation of createXlfFiles(). I see that it supports specifying an object with a message field instead of a string field. But, I don't see anywhere that it also handles a comment/hint field in that object.

Makes sense. PR welcome.

I published 4.0.0-next.1 which contains support form comments in messages.

Will there be a replacement for createXlfFiles() on 4.0.0 as part of removing Transifex support? Or is the removed support related only to import/export?

Not sure I understand this since createXlfFiles is still there and independent of Transifex.