Release v1.1.0

rewrite typescript definition file

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "pofile",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "authors": [
     "Ruben Vermeersch <ruben@rocketeer.be>"
   ],

dist/pofile.js

@@ -1,4 +1,4 @@
-require=(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+require=(function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
 
 },{}],"pofile":[function(require,module,exports){
 var fs = require('fs');
@@ -11,6 +11,7 @@ var PO = function () {
     this.comments = [];
     this.extractedComments = [];
     this.headers = {};
+    this.headerOrder = [];
     this.items = [];
 };
 
@@ -23,21 +24,36 @@ PO.prototype.toString = function () {
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
-            lines.push('# ' + comment);
+            lines.push(('# ' + comment).trim());
         });
     }
     if (this.extractedComments) {
         this.extractedComments.forEach(function (comment) {
-            lines.push('#. ' + comment);
+            lines.push(('#. ' + comment).trim());
         });
     }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
 
-    var keys = Object.keys(this.headers);
     var self = this;
+    var headerOrder = [];
+
+    this.headerOrder.forEach(function (key) {
+        if (key in self.headers) {
+            headerOrder.push(key);
+        }
+    });
+
+    var keys = Object.keys(this.headers);
+
     keys.forEach(function (key) {
+        if (headerOrder.indexOf(key) === -1) {
+            headerOrder.push(key);
+        }
+    });
+
+    headerOrder.forEach(function (key) {
         lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
@@ -91,6 +107,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -114,6 +131,7 @@ PO.parse = function (data) {
             var name = p.shift().trim();
             var value = p.join(':').trim();
             po.headers[name] = value;
+            po.headerOrder.push(name);
         }
     });
 
@@ -215,6 +233,7 @@ PO.parse = function (data) {
         } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
+            context = 'msgctxt';
             noCommentLineCount++;
         } else { // Probably multiline string or blank
             if (line.length > 0) {
@@ -225,6 +244,8 @@ PO.parse = function (data) {
                     item.msgid += extract(line);
                 } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
+                } else if (context === 'msgctxt') {
+                    item.msgctxt += extract(line);
                 }
             }
         }
@@ -316,6 +337,15 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    //handle \n in single-line texts (can not be handled in _escape)
+    var _processLineBreak = function (keyword, text, index) {
+        var processed = _process(keyword, text, index);
+        for (var i = 1; i < processed.length - 1; i++) {
+            processed[i] = processed[i].slice(0, -1) + '\\n"';
+        }
+        return processed;
+    };
+
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
@@ -351,7 +381,8 @@ PO.Item.prototype.toString = function () {
 
             if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+                    var processed = _processLineBreak(keyword, t, i);
+                    lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
                 });
             } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
                 for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
@@ -362,11 +393,7 @@ PO.Item.prototype.toString = function () {
                     0 :
                     undefined;
                 text = Array.isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text, index);
+                var processed = _processLineBreak(keyword, text, index);
-                //handle \n in single-line texts (can not be handled in _escape)
-                for (var i = 1; i < processed.length - 1; i++) {
-                    processed[i] = processed[i].slice(0, -1) + '\\n"';
-                }
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }

lib/po.js

@@ -8,6 +8,7 @@ var PO = function () {
     this.comments = [];
     this.extractedComments = [];
     this.headers = {};
+    this.headerOrder = [];
     this.items = [];
 };
 
@@ -20,21 +21,36 @@ PO.prototype.toString = function () {
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
-            lines.push('# ' + comment);
+            lines.push(('# ' + comment).trim());
         });
     }
     if (this.extractedComments) {
         this.extractedComments.forEach(function (comment) {
-            lines.push('#. ' + comment);
+            lines.push(('#. ' + comment).trim());
         });
     }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
 
-    var keys = Object.keys(this.headers);
     var self = this;
+    var headerOrder = [];
+
+    this.headerOrder.forEach(function (key) {
+        if (key in self.headers) {
+            headerOrder.push(key);
+        }
+    });
+
+    var keys = Object.keys(this.headers);
+
     keys.forEach(function (key) {
+        if (headerOrder.indexOf(key) === -1) {
+            headerOrder.push(key);
+        }
+    });
+
+    headerOrder.forEach(function (key) {
         lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
@@ -88,6 +104,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -111,6 +128,7 @@ PO.parse = function (data) {
             var name = p.shift().trim();
             var value = p.join(':').trim();
             po.headers[name] = value;
+            po.headerOrder.push(name);
         }
     });
 
@@ -212,6 +230,7 @@ PO.parse = function (data) {
         } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
+            context = 'msgctxt';
             noCommentLineCount++;
         } else { // Probably multiline string or blank
             if (line.length > 0) {
@@ -222,6 +241,8 @@ PO.parse = function (data) {
                     item.msgid += extract(line);
                 } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
+                } else if (context === 'msgctxt') {
+                    item.msgctxt += extract(line);
                 }
             }
         }
@@ -313,6 +334,15 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    //handle \n in single-line texts (can not be handled in _escape)
+    var _processLineBreak = function (keyword, text, index) {
+        var processed = _process(keyword, text, index);
+        for (var i = 1; i < processed.length - 1; i++) {
+            processed[i] = processed[i].slice(0, -1) + '\\n"';
+        }
+        return processed;
+    };
+
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
@@ -348,7 +378,8 @@ PO.Item.prototype.toString = function () {
 
             if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+                    var processed = _processLineBreak(keyword, t, i);
+                    lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
                 });
             } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
                 for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
@@ -359,11 +390,7 @@ PO.Item.prototype.toString = function () {
                     0 :
                     undefined;
                 text = Array.isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text, index);
+                var processed = _processLineBreak(keyword, text, index);
-                //handle \n in single-line texts (can not be handled in _escape)
-                for (var i = 1; i < processed.length - 1; i++) {
-                    processed[i] = processed[i].slice(0, -1) + '\\n"';
-                }
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
@@ -20,6 +20,7 @@
     "url": "http://github.com/rubenv/pofile.git"
   },
   "main": "./lib/po",
+  "types": "./pofile.d.ts",
   "keywords": [
     "i18n",
     "l10n",

pofile.d.ts

@@ -0,0 +1,45 @@
+declare interface IHeaders {
+    'Project-Id-Version': string;
+    'Report-Msgid-Bugs-To': string;
+    'POT-Creation-Date': string;
+    'PO-Revision-Date': string;
+    'Last-Translator': string;
+    'Language': string;
+    'Language-Team': string;
+    'Content-Type': string;
+    'Content-Transfer-Encoding': string;
+    'Plural-Forms': string;
+    [name: string]: string;
+}
+
+declare class Item {
+    public msgid: string;
+    public msgctxt?: string;
+    public references: string[];
+    public msgid_plural?: string;
+    public msgstr: string[];
+    public comments: string[];
+    public extractedComments: string[];
+    public flags: Record<string, boolean | undefined>;
+    private nplurals: number;
+    private obsolete: boolean;
+
+    public toString(): string;
+}
+
+declare class PO {
+    public comments: string[];
+    public extractedComments: string[];
+    public items: Item[];
+    public headers: Partial<IHeaders>
+
+    public static parse(data: string): PO;
+    public static parsePluralForms(forms: string): PO;
+    public static load(fileName: string, callback: (err: NodeJS.ErrnoException, po: PO) => void): void;
+    public static Item: typeof Item;
+
+    public save(fileName: string, callback: (err: NodeJS.ErrnoException) => void): void;
+    public toString(): string;
+}
+
+export = PO

test/fixtures/big.po

@@ -296,3 +296,9 @@ msgstr "This folder is empty."
 msgctxt "folder action"
 msgid "Empty folder"
 msgstr "Make this folder empty."
+
+msgctxt ""
+"folder "
+"meta"
+msgid "Created Date"
+msgstr "Date de création"

test/fixtures/c-strings.po

@@ -57,3 +57,17 @@ msgid ""
 msgstr ""
 "\a\b\t\n"
 "\v\f\r"
+
+# plural text must suport \n
+msgid ""
+"Test.\n"
+" multiline."
+msgid_plural ""
+"Test\n"
+" multiline plural."
+msgstr[0] ""
+"Test.\n"
+" mehrzeilig."
+msgstr[1] ""
+"Test.\n"
+" mehrzeilig Plural."

test/parse.js

@@ -6,7 +6,7 @@ describe('Parse', function () {
     it('Parses the big po file', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8'));
         assert.notEqual(po, null);
-        assert.equal(po.items.length, 69);
+        assert.equal(po.items.length, 70);
 
         var item = po.items[0];
         assert.equal(item.msgid, 'Title');
@@ -121,6 +121,17 @@ describe('Parse', function () {
         assert.equal(ambiguousItems[1].msgctxt, 'folder action');
     });
 
+    it('Parses item multiline context', function () {
+        var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8'));
+
+        var item = po.items.find(function (item) {
+            return item.msgid === 'Created Date' && item.msgctxt === 'folder meta';
+        });
+
+        assert.notEqual(item, undefined);
+        assert.equal(item.msgctxt, 'folder meta');
+    });
+
     it('Handles obsolete items', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/commented.po', 'utf8'));
 

test/write.js

@@ -2,12 +2,13 @@ var assert = require('assert');
 var fs = require('fs');
 var PO = require('..');
 
-function assertHasLine(str, line) {
+function assertHasLine(str, line, doNotTrim) {
     var lines = str.split('\n');
     var found = false;
 
     for (var i = 0; i < lines.length; i++) {
-        if (lines[i].trim() === line) {
+        var lineToCompare = doNotTrim ? lines[i] : lines[i].trim();
+        if (lineToCompare === line) {
             found = true;
             break;
         }
@@ -53,6 +54,13 @@ describe('Write', function () {
         assertHasLine(str, '#, fuzzy');
     });
 
+    it('write empty comment without an unecessary space', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+        assertHasLine(str, '#', true);
+    });
+
     it('write flags only when true', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
@@ -496,4 +504,26 @@ describe('Write', function () {
             assert.ok(po.toString().indexOf('msgctxt') >= 0);
         });
     });
+
+    it('should keep the header order', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+
+        assertHasContiguousLines(str, [
+            'msgid ""',
+            'msgstr ""',
+            '"Project-Id-Version: Link (6.x-2.9)\\n"',
+            '"POT-Creation-Date: 2011-12-31 23:39+0000\\n"',
+            '"PO-Revision-Date: 2013-12-17 14:21+0100\\n"',
+            '"Language-Team: French\\n"',
+            '"MIME-Version: 1.0\\n"',
+            '"Content-Type: text/plain; charset=UTF-8\\n"',
+            '"Content-Transfer-Encoding: 8bit\\n"',
+            '"Plural-Forms: nplurals=2; plural=(n > 1);\\n"',
+            '"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\\n"',
+            '"Language: fr\\n"',
+            '"X-Generator: Poedit 1.6.2\\n"',
+        ]);
+    });
 });