@esgettext/tools 1.0.0 → 1.2.0

package/dist/pot/catalog.js

@@ -1,21 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Catalog = void 0;
-var entry_1 = require("./entry");
-var Catalog = (function () {
-    function Catalog(properties) {
-        if (properties === void 0) { properties = {}; }
+const entry_1 = require("./entry");
+/**
+ * An entire message catalog that is subsequently filled.
+ */
+class Catalog {
+    constructor(properties = {}) {
         this.properties = properties;
         this.cache = {};
         this.entries = new Array();
-        var barePkg;
+        let barePkg;
         if (typeof properties.package === 'undefined') {
             barePkg = 'PACKAGE';
             properties.package = 'PACKAGE VERSION';
         }
         else {
             barePkg = properties.package.replace(/\n/g, '\\n');
-            ;
             if (typeof properties.version !== 'undefined') {
                 properties.package += ' ' + properties.version;
             }
@@ -27,41 +28,60 @@ var Catalog = (function () {
             properties.msgidBugsAddress = 'MSGID_BUGS_ADDRESS';
         }
         if (typeof properties.date === 'undefined') {
-            var now = new Date();
-            var year = now.getFullYear().toString();
+            const now = new Date();
+            // Avoid if/else, so we do not spoil our test coverage. :)
+            let year = now.getFullYear().toString();
             year = '0'.repeat(4 - year.length) + year;
-            var month = (1 + now.getMonth()).toString();
+            let month = (1 + now.getMonth()).toString();
             month = '0'.repeat(2 - month.length) + month;
-            var mday = now.getDate().toString();
+            let mday = now.getDate().toString();
             mday = '0'.repeat(2 - mday.length) + mday;
-            var hour = now.getHours().toString();
+            let hour = now.getHours().toString();
             hour = '0'.repeat(2 - hour.length) + hour;
-            var minutes = now.getMinutes().toString();
+            let minutes = now.getMinutes().toString();
             minutes = '0'.repeat(2 - minutes.length) + minutes;
-            var offset = now.getTimezoneOffset();
-            var sign = ['+', '-'][Math.sign(offset) + 1];
+            // Do not depend on the timezone for test coverage.
+            let offset = now.getTimezoneOffset();
+            const sign = ['+', '-'][Math.sign(offset) + 1];
             offset = Math.abs(offset);
-            var offsetHours = Math.floor(offset / 60).toString();
+            let offsetHours = Math.floor(offset / 60).toString();
             offsetHours = '0'.repeat(2 - offsetHours.length) + offsetHours;
-            var offsetMinutes = (offset % 60).toString();
+            let offsetMinutes = (offset % 60).toString();
             offsetMinutes = '0'.repeat(2 - offsetMinutes.length) + offsetMinutes;
             properties.date =
                 [year, month, mday].join('-') +
-                    " ".concat(hour, ":").concat(minutes) +
-                    "".concat(sign).concat(offsetHours).concat(offsetMinutes);
-        }
-        var pkg = properties.package.replace(/\n/g, '\\n');
-        var msgidBugsAddress = properties.msgidBugsAddress.replace(/\n/g, '\\n');
-        var copyrightHolder = properties.copyrightHolder.replace(/\n/g, '\\n');
-        var header = "Project-Id-Version: ".concat(pkg, "\nReport-Msgid-Bugs-To: ").concat(msgidBugsAddress, "\nPOT-Creation-Date: ").concat(properties.date, "\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\nLast-Translator: FULL NAME <EMAIL@ADDRESS>\nLanguage-Team: LANGUAGE <LL@li.org>\nLanguage: \nMIME-Version: 1.0\nContent-Type: text/plain; charset=CHARSET\nContent-Transfer-Encoding: 8bit\n");
-        var comment;
+                    ` ${hour}:${minutes}` +
+                    `${sign}${offsetHours}${offsetMinutes}`;
+        }
+        const pkg = properties.package.replace(/\n/g, '\\n');
+        const msgidBugsAddress = properties.msgidBugsAddress.replace(/\n/g, '\\n');
+        const copyrightHolder = properties.copyrightHolder.replace(/\n/g, '\\n');
+        const header = `Project-Id-Version: ${pkg}
+Report-Msgid-Bugs-To: ${msgidBugsAddress}
+POT-Creation-Date: ${properties.date}
+PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
+Last-Translator: FULL NAME <EMAIL@ADDRESS>
+Language-Team: LANGUAGE <LL@li.org>
+Language:\u0020
+MIME-Version: 1.0
+Content-Type: text/plain; charset=CHARSET
+Content-Transfer-Encoding: 8bit
+`;
+        let comment;
         if (properties.foreignUser) {
-            comment = "SOME DESCRIPTIVE TITLE\nThis file is put in the public domain.\nFIRST AUTHOR <EMAIL@ADDRESS>, YEAR.\n";
+            comment = `SOME DESCRIPTIVE TITLE
+This file is put in the public domain.
+FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+`;
         }
         else {
-            comment = "SOME DESCRIPTIVE TITLE\nCopyright (C) YEAR ".concat(copyrightHolder, "\nThis file is distributed under the same license as the ").concat(barePkg, " package.\nFIRST AUTHOR <EMAIL@ADDRESS>, YEAR.\n");
+            comment = `SOME DESCRIPTIVE TITLE
+Copyright (C) YEAR ${copyrightHolder}
+This file is distributed under the same license as the ${barePkg} package.
+FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+`;
         }
-        var headerEntry = new entry_1.POTEntry({
+        const headerEntry = new entry_1.POTEntry({
             msgid: '',
             msgstr: header,
             flags: ['fuzzy'],
@@ -70,33 +90,46 @@ var Catalog = (function () {
         });
         this.addEntry(headerEntry);
     }
-    Catalog.prototype.toString = function (options) {
-        if (options === void 0) { options = {}; }
-        var width = options && typeof options.width !== 'undefined' ? options.width : 76;
-        var isNotHeader = function (entry) {
+    /**
+     * Render the entire catalog.
+     *
+     * @param renderOptions - options for rendering
+     *
+     * The following options are supported:
+     *
+     * width: wrap lines to that page width (default: 76)
+     *
+     * @returns the catalog rendered as a po(t) file
+     */
+    toString(options = {}) {
+        const width = options && typeof options.width !== 'undefined' ? options.width : 76;
+        const isNotHeader = (entry) => {
             return !(entry.properties.msgid === '' &&
                 typeof entry.properties.msgctxt === 'undefined');
         };
-        var isHeader = function (entry) {
+        const isHeader = (entry) => {
             return !isNotHeader(entry);
         };
-        var header = options.omitHeader
+        const header = options.omitHeader
             ? undefined
             : this.entries
                 .filter(isHeader)
-                .map(function (entry) { return entry.toString(width); })
+                .map(entry => entry.toString(width))
                 .join('\n');
-        var body = '';
+        let body = '';
         if (options.sortOutput) {
             body = this.entries
                 .filter(isNotHeader)
-                .sort(function (a, b) {
-                var cmp = a.properties.msgid.localeCompare(b.properties.msgid);
+                .sort((a, b) => {
+                const cmp = a.properties.msgid.localeCompare(b.properties.msgid);
                 if (cmp) {
                     return cmp;
                 }
-                var actx = a.properties.msgctxt;
-                var bctx = b.properties.msgctxt;
+                const actx = a.properties.msgctxt;
+                const bctx = b.properties.msgctxt;
+                // It is impossible that both msgctxts are undefined
+                // because that would mean that the msgids are identical
+                // which is prevented.
                 if (typeof bctx === 'undefined') {
                     return +1;
                 }
@@ -105,34 +138,35 @@ var Catalog = (function () {
                 }
                 return actx.localeCompare(bctx);
             })
-                .map(function (entry) { return entry.toString(width); })
+                .map(entry => entry.toString(width))
                 .join('\n');
         }
         else if (options.sortByFile) {
-            var copy = this.copy(this.properties);
-            var splitRef_1 = function (ref) {
-                var parts = ref.split(':');
-                var lineno = Number.parseInt(parts.pop(), 10);
-                var filename = parts.join(':');
-                return { filename: filename, lineno: lineno };
+            const copy = this.copy(this.properties);
+            const splitRef = (ref) => {
+                const parts = ref.split(':');
+                const lineno = Number.parseInt(parts.pop(), 10);
+                const filename = parts.join(':');
+                return { filename, lineno };
             };
-            copy.entries.forEach(function (entry) {
+            // First order all references
+            copy.entries.forEach(entry => {
                 if (entry.properties.references) {
                     entry.properties.references = entry.properties.references
-                        .map(splitRef_1)
-                        .sort(function (a, b) {
+                        .map(splitRef)
+                        .sort((a, b) => {
                         return (a.filename.localeCompare(b.filename) ||
                             Math.sign(a.lineno - b.lineno));
                     })
-                        .map(function (ref) { return "".concat(ref.filename, ":").concat(ref.lineno); });
+                        .map(ref => `${ref.filename}:${ref.lineno}`);
                 }
             });
-            var compareSplitRefs = function (a, b) {
-                var arefs = a.refs;
-                var brefs = b.refs;
-                var min = Math.min(arefs.length, brefs.length);
-                for (var i = 0; i < min; ++i) {
-                    var cmp = arefs[i].filename.localeCompare(brefs[i].filename) ||
+            const compareSplitRefs = (a, b) => {
+                const arefs = a.refs;
+                const brefs = b.refs;
+                const min = Math.min(arefs.length, brefs.length);
+                for (let i = 0; i < min; ++i) {
+                    const cmp = arefs[i].filename.localeCompare(brefs[i].filename) ||
                         Math.sign(arefs[i].lineno - brefs[i].lineno);
                     if (cmp) {
                         return cmp;
@@ -140,35 +174,45 @@ var Catalog = (function () {
                 }
                 return Math.sign(arefs.length - brefs.length);
             };
-            var splitRefs_1 = function (refs) {
-                return refs ? refs.map(splitRef_1) : [];
+            const splitRefs = (refs) => {
+                return refs ? refs.map(splitRef) : [];
             };
             body = copy.entries
                 .filter(isNotHeader)
-                .map(function (entry) {
-                return { refs: splitRefs_1(entry.properties.references), entry: entry };
+                .map(entry => {
+                return {
+                    refs: splitRefs(entry.properties.references),
+                    entry,
+                };
             })
                 .sort(compareSplitRefs)
-                .map(function (split) { return split.entry; })
-                .map(function (entry) { return entry.toString(width); })
+                .map(split => split.entry)
+                .map(entry => entry.toString(width))
                 .join('\n');
         }
         else {
             body = this.entries
                 .filter(isNotHeader)
-                .map(function (entry) { return entry.toString(width); })
+                .map(entry => entry.toString(width))
                 .join('\n');
         }
         if (body && header) {
-            return "".concat(header, "\n").concat(body);
+            return `${header}\n${body}`;
         }
         else {
             return header || body || '';
         }
-    };
-    Catalog.prototype.addEntry = function (entry) {
-        var msgid = entry.properties.msgid;
-        var msgctxt = entry.properties.msgctxt;
+    }
+    /**
+     * Add an entry to the catalog. If an entry with the same msgid
+     * and msgctxt already exists, the entry is merged into
+     * the existing one instead.
+     *
+     * @param entry - the `POTEntry` to add
+     */
+    addEntry(entry) {
+        const msgid = entry.properties.msgid;
+        const msgctxt = entry.properties.msgctxt;
         if (!Object.prototype.hasOwnProperty.call(this.cache, msgid)) {
             this.cache[msgid] = {};
         }
@@ -179,32 +223,39 @@ var Catalog = (function () {
         else {
             this.cache[msgid][msgctxt].merge(entry);
         }
-    };
-    Catalog.prototype.deleteEntry = function (msgid, msgctxt) {
+    }
+    deleteEntry(msgid, msgctxt) {
         if (!this.cache[msgid]) {
             return;
         }
-        var entry = this.cache[msgid][msgctxt];
+        const entry = this.cache[msgid][msgctxt];
         if (!entry) {
             return;
         }
         delete this.cache[msgid][msgctxt];
-        this.entries = this.entries.filter(function (other) { return other !== entry; });
-    };
-    Catalog.prototype.copy = function (properties) {
-        var other = new Catalog(properties);
-        this.entries.forEach(function (entry) { return other.addEntry(entry); });
+        this.entries = this.entries.filter(other => other !== entry);
+    }
+    /**
+     * Copy a catalog with other options. This is for testing only.
+     *
+     * @returns a deep copy of the catalog.
+     */
+    copy(properties) {
+        const other = new Catalog(properties);
+        this.entries.forEach(entry => other.addEntry(entry));
         return other;
-    };
-    Catalog.prototype.makePOT = function () {
-        this.entries.forEach(function (entry) {
+    }
+    /**
+     * Removes all translations from a catalog, so that it can be used as
+     * a .pot file.
+     */
+    makePOT() {
+        this.entries.forEach(entry => {
             if (!(entry.properties.msgid === '' &&
                 typeof entry.properties.msgctxt === 'undefined')) {
                 delete entry.properties.msgstr;
             }
         });
-    };
-    return Catalog;
-}());
+    }
+}
 exports.Catalog = Catalog;
-//# sourceMappingURL=catalog.js.map