@connectedcars/po2json
Advanced tools
Convert PO files to Javascript objects or JSON strings. The result is Jed-compatible.
Install the module with: npm install po2json
var po2json = require('po2json');
po2json translation.po translation.json
If you are using Jed >= 1.1.0, be sure to specify that format specifically.
po2json translation.po translation.json -f jed1.x
po2json has 3 methods, all of which take exactly the same options. The main function is parse which actually does the parsing to JSON. The 2 others - parseFile and parseFileSync are convenience functions to directly read PO data from a file and convert it to JSON.
Parse a PO buffer to JSON
po2json.parse(buf[, options])
buf - a po file as a Buffer or an unicode string.options - an optional object with the following possible parameters:
fuzzy Whether to include fuzzy translation in JSON or not. Should be either true or false. Defaults to false.stringify If true, returns a JSON string. Otherwise returns a plain Javascript object. Defaults to false.pretty If true, the resulting JSON string will be pretty-printed. Has no effect when stringify is false. Defaults to falseformat Defaults to raw.
raw produces a "raw" JSON outputjed produces an output that is 100% compatible with Jed >= 1.1.0jedold produces an output that is 100% compatible with Jed < 1.1.0mf produces simple key:value output.domain - the domain the messages will be wrapped inside. Only has effect if format: 'jed'.fallback-to-msgid If true, for those entries that would be omitted (fuzzy entries without the fuzzy flag) and for those
that are empty, the msgid will be used as translation in the json file. If the entry is plural, msgid_plural will be used for
msgstr[1]. This means that this option makes sense only for those languages that have nplurals=2.Parse a PO file to JSON
po2json.parseFile(fileName[,options], cb)
fileName - path to the po fileoptions - same as for po2json.parsecb - a function that receives 2 arguments: err and jsonDataParse a PO file to JSON (synchronous)
po2json.parseFileSync(fileName[, options])
fileName - path to the po fileoptions - same as for po2json.parsepo2json in command-line parametrization support added to allow override default options.
Note: 'format': 'mf' means the json format used by messageFormatter in github.com/SlexAxton/messageformat.js
and jedold refers to Jed formats below 1.1.0
var po2json = require('po2json'),
fs = require('fs');
fs.readFile('messages.po', function (err, buffer) {
var jsonData = po2json.parse(buffer);
// do something interesting ...
});
var po2json = require('po2json');
po2json.parseFile('messages.po', function (err, jsonData) {
// do something interesting ...
});
var po2json = require('po2json');
var jsonData = '';
try {
jsonData = po2json.parseFileSync('messages.po');
// do something interesting ...
} catch (e) {}
var po2json = require('po2json'),
MessageFormat = require('messageformat');
po2json.parseFile('es.po', { format: 'mf' }, function (err, translations) {
var pFunc = function (n) {
return (n==1 ? 'p0' : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 'p1' : 'p2');
};
pFunc.cardinal = [ 'p0', 'p1', 'p2' ];
var mf = new MessageFormat(
{
'es': pFunc
}
);
var i18n = mf.compile( translations );
});
var po2json = require('po2json'),
MessageFormat = require('messageformat');
po2json.parseFile('messages.po', { format: 'mf', fullMF: true }, function (err, jsonData) {
var mf = new MessageFormat(
{ [jsonData.headers.language]: jsonData.pluralFunction }
);
var i18n = mf.compile( jsonData.translations );
});
var po2json = require('po2json'),
Jed = require('jed');
po2json.parseFile('messages.po', { format: 'jed' }, function (err, jsonData) {
var i18n = new Jed( jsonData );
});
If you are using an older version of Jed, be sure to specify this format specifically.
var po2json = require('po2json'),
Jed = require('jed');
po2json.parseFile('messages.po', { format: 'jedold' }, function (err, jsonData) {
var i18n = new Jed( jsonData );
});
npm test
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
jed now refers to versions >= 1.1.0.NB! This release is NOT backwards-compatible! It has the following breaking changes:
po2json.parse_po has been replaced with po2json.parsepo2json.parse has been replaced with po2json.parseFilepo2json.parseSync has been replaced with po2json.parseFileSyncOther changes in this release:
Copyright (c) 2012 Joshua I. Miller Licensed under the GNU, Library, General, Public, License licenses.
FAQs
Convert PO files to JSON
We found that @connectedcars/po2json demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 30 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.