properties-file 2.2.4 → 3.0.0

package/lib/editor/index.js

@@ -0,0 +1,249 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertiesEditor = exports.DEFAULT_COMMENT_DELIMITER = exports.DEFAULT_SEPARATOR = void 0;
+var escape_1 = require("../escape");
+var properties_1 = require("../properties");
+/** The default separator between keys and values. */
+exports.DEFAULT_SEPARATOR = '=';
+/** The default character used as comment delimiter. */
+exports.DEFAULT_COMMENT_DELIMITER = '#';
+/**
+ * A .properties file editor.
+ */
+var PropertiesEditor = /** @class */ (function (_super) {
+    __extends(PropertiesEditor, _super);
+    /**
+     * Create `PropertiesEditor` object.
+     *
+     * @param content - The content of a `.properties` file.
+     */
+    function PropertiesEditor(content) {
+        return _super.call(this, content) || this;
+    }
+    /**
+     * Insert a new property in the existing object (by default it will be at the end).
+     *
+     * @param key - A property key (unescaped).
+     * @param value - A property value (unescaped).
+     * @param options - Additional options.
+     */
+    PropertiesEditor.prototype.insert = function (key, value, options) {
+        var _a;
+        var _b, _c;
+        var escapeUnicode = (options === null || options === void 0 ? void 0 : options.escapeUnicode) || false;
+        var separator = (options === null || options === void 0 ? void 0 : options.separator)
+            ? options.separator === ' '
+                ? ' '
+                : " ".concat(options.separator, " ")
+            : " ".concat(exports.DEFAULT_SEPARATOR, " ").replace('  ', ' ');
+        var referenceKey = options === null || options === void 0 ? void 0 : options.referenceKey;
+        var position = (options === null || options === void 0 ? void 0 : options.position) || 'after';
+        // Allow to add multiline keys.
+        var multilineKey = key
+            .split(/\r?\n/)
+            .map(function (key) { return (0, escape_1.escapeKey)(key, escapeUnicode); })
+            .join('\\\n');
+        // Allow to add multiline values.
+        var multilineValue = value
+            .split(/\r?\n/)
+            .map(function (value) { return (0, escape_1.escapeValue)(value, escapeUnicode); })
+            .join('\\\n');
+        // Allow to add multiline comments.
+        var commentPrefix = "".concat((options === null || options === void 0 ? void 0 : options.commentDelimiter) || exports.DEFAULT_COMMENT_DELIMITER, " ");
+        var multilineComment = (options === null || options === void 0 ? void 0 : options.comment) === undefined
+            ? ''
+            : "".concat("".concat(commentPrefix).concat(options.comment).split(/\r?\n/).join("\n".concat(commentPrefix)), "\n");
+        var newLines = "".concat(multilineComment).concat(multilineKey).concat(separator).concat(multilineValue).split(/\n/);
+        if (referenceKey === undefined) {
+            // Insert the new property at the end if the reference key was not defined.
+            (_a = this.lines).push.apply(_a, __spreadArray([], __read(newLines), false));
+            this.parseLines();
+        }
+        else {
+            // Find the last occurrence of the reference key.
+            var property = __spreadArray([], __read(this.collection), false).reverse()
+                .find(function (property) { return property.key === referenceKey; });
+            // Insert the new property when a reference key defined only when found.
+            if (property) {
+                var insertPosition = position === 'after'
+                    ? property.endingLineNumber
+                    : (_c = (_b = property.previousProperty) === null || _b === void 0 ? void 0 : _b.endingLineNumber) !== null && _c !== void 0 ? _c : 0;
+                this.lines = __spreadArray(__spreadArray(__spreadArray([], __read(this.lines.slice(0, insertPosition)), false), __read(newLines), false), __read(this.lines.slice(insertPosition)), false);
+                this.parseLines();
+            }
+        }
+    };
+    /**
+     * Insert a new comment in the existing object (by default it will be at the end).
+     *
+     * @param comment - The comment to add.
+     * @param options - Additional options.
+     */
+    PropertiesEditor.prototype.insertComment = function (comment, options) {
+        var _a;
+        var _b, _c;
+        var referenceKey = options === null || options === void 0 ? void 0 : options.referenceKey;
+        var position = (options === null || options === void 0 ? void 0 : options.position) || 'after';
+        // Allow to add multiline comments.
+        var commentPrefix = "".concat((options === null || options === void 0 ? void 0 : options.commentDelimiter) || exports.DEFAULT_COMMENT_DELIMITER, " ");
+        var newLines = "".concat(commentPrefix).concat(comment)
+            .replace(/\r?\n/g, "\n".concat(commentPrefix))
+            .split(/\n/);
+        if (referenceKey === undefined) {
+            // Insert the new comment at the end if the reference key was not defined.
+            (_a = this.lines).push.apply(_a, __spreadArray([], __read(newLines), false));
+            this.parseLines();
+        }
+        else {
+            // Find the last occurrence of the reference key.
+            var property = __spreadArray([], __read(this.collection), false).reverse()
+                .find(function (property) { return property.key === referenceKey; });
+            // Insert the new comment when a reference key defined only when found.
+            if (property) {
+                var insertPosition = position === 'after'
+                    ? property.endingLineNumber
+                    : (_c = (_b = property.previousProperty) === null || _b === void 0 ? void 0 : _b.endingLineNumber) !== null && _c !== void 0 ? _c : 0;
+                this.lines = __spreadArray(__spreadArray(__spreadArray([], __read(this.lines.slice(0, insertPosition)), false), __read(newLines), false), __read(this.lines.slice(insertPosition)), false);
+                this.parseLines();
+            }
+        }
+    };
+    /**
+     * Remove the last occurrence of a given key from the existing object.
+     *
+     * @param key - The name of the key to remove.
+     * @param removeCommentsAndWhiteSpace - By default, comments and white-space characters before the key will be removed.
+     */
+    PropertiesEditor.prototype.remove = function (key, removeCommentsAndWhiteSpace) {
+        var _a, _b;
+        if (removeCommentsAndWhiteSpace === void 0) { removeCommentsAndWhiteSpace = true; }
+        // Find the last occurrence of the key.
+        var property = __spreadArray([], __read(this.collection), false).reverse().find(function (property) { return property.key === key; });
+        if (property) {
+            var startLine = removeCommentsAndWhiteSpace
+                ? (_b = (_a = property.previousProperty) === null || _a === void 0 ? void 0 : _a.endingLineNumber) !== null && _b !== void 0 ? _b : 0
+                : property.startingLineNumber - 1;
+            var endLine = property.endingLineNumber;
+            this.lines = __spreadArray(__spreadArray([], __read(this.lines.slice(0, startLine)), false), __read(this.lines.slice(endLine)), false);
+            this.parseLines();
+        }
+    };
+    /**
+     * Restore the original newline characters of a key.
+     *
+     * @param property - A property object.
+     *
+     * @returns The key with its original newlines characters restored.
+     */
+    PropertiesEditor.prototype.getKeyWithNewlines = function (property) {
+        return property.newlinePositions.length === 0
+            ? property.key
+            : // eslint-disable-next-line unicorn/no-array-reduce
+                __spreadArray([], __read(property.key), false).reduce(function (accumulator, character, index) {
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    return "".concat(accumulator).concat(property.newlinePositions.includes(index) ? '\n' : '').concat(character);
+                }, '');
+    };
+    /**
+     * Restore the original newline characters of a value.
+     *
+     * @param property - A property object.
+     *
+     * @returns The value with its original newlines characters restored.
+     */
+    PropertiesEditor.prototype.getValueWithNewlines = function (property) {
+        return property.newlinePositions.length === 0 || property.valuePosition === undefined
+            ? property.value
+            : // eslint-disable-next-line unicorn/no-array-reduce
+                __spreadArray([], __read(property.value), false).reduce(function (accumulator, character, index) {
+                    return "".concat(accumulator).concat(property.newlinePositions.includes(index + property.valuePosition)
+                        ? '\n'
+                        : ''
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    ).concat(character);
+                }, '');
+    };
+    /**
+     * Edit the last occurrence of a given key from the existing object.
+     *
+     * @param key - The name of the key to edit.
+     * @param options - Additional options.
+     */
+    PropertiesEditor.prototype.edit = function (key, options) {
+        var _a, _b, _c, _d;
+        // Find the last occurrence of the key to edit.
+        var property = __spreadArray([], __read(this.collection), false).reverse().find(function (property) { return property.key === key; });
+        if (!property) {
+            return;
+        }
+        var escapeUnicode = (options === null || options === void 0 ? void 0 : options.escapeUnicode) || false;
+        var separator = (options === null || options === void 0 ? void 0 : options.separator)
+            ? options.separator === ' '
+                ? ' '
+                : " ".concat(options.separator, " ")
+            : property.separator || " ".concat(exports.DEFAULT_SEPARATOR, " ").replace('  ', ' ');
+        // Allow to edit multiline keys.
+        var multilineKey = ((_a = options === null || options === void 0 ? void 0 : options.newKey) !== null && _a !== void 0 ? _a : this.getKeyWithNewlines(property))
+            .split(/\r?\n/)
+            .map(function (key) { return (0, escape_1.escapeKey)(key, escapeUnicode); })
+            .join('\\\n');
+        // Allow to edit multiline values.
+        var multilineValue = ((_b = options === null || options === void 0 ? void 0 : options.newValue) !== null && _b !== void 0 ? _b : this.getValueWithNewlines(property))
+            .split(/\r?\n/)
+            .map(function (value) { return (0, escape_1.escapeValue)(value, escapeUnicode); })
+            .join('\\\n');
+        // Allow to edit multiline comments.
+        var commentPrefix = "".concat((options === null || options === void 0 ? void 0 : options.commentDelimiter) || exports.DEFAULT_COMMENT_DELIMITER, " ");
+        var multilineComment = (options === null || options === void 0 ? void 0 : options.newComment) === undefined
+            ? ''
+            : "".concat("".concat(commentPrefix).concat(options.newComment).split(/\r?\n/).join("\n".concat(commentPrefix)), "\n");
+        var newLines = "".concat(multilineComment).concat(multilineKey).concat(separator).concat(multilineValue).split(/\n/);
+        // Replace the existing property with the new one.
+        this.lines = __spreadArray(__spreadArray(__spreadArray([], __read(this.lines.slice(0, (options === null || options === void 0 ? void 0 : options.newComment) === undefined
+            ? property.startingLineNumber - 1
+            : (_d = (_c = property.previousProperty) === null || _c === void 0 ? void 0 : _c.endingLineNumber) !== null && _d !== void 0 ? _d : 0)), false), __read(newLines), false), __read(this.lines.slice(property.endingLineNumber)), false);
+        this.parseLines();
+    };
+    return PropertiesEditor;
+}(properties_1.Properties));
+exports.PropertiesEditor = PropertiesEditor;

package/lib/index.d.ts

@@ -1,12 +1,18 @@
 /// <reference types="./properties-file" />
 
-export { getProperties, propertiesToJson } from './file';
-export { KeyLineNumbers, Properties } from './properties';
-export { Property } from './property';
-export { PropertyLine } from './property-line';
+/// <reference types="node" />
+export { Properties } from './properties';
 /**
- * A simple "key/value" object.
+ * A key-value pair object.
  */
-export type KeyValueObject = {
+export type KeyValuePairObject = {
     [key: string]: string;
 };
+/**
+ * Converts the content of a `.properties` file to a key-value pair object.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns A key/value object representing the content of a `.properties` file.
+ */
+export declare const getProperties: (content: string | Buffer) => KeyValuePairObject;

package/lib/index.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyLine = exports.Property = exports.Properties = exports.propertiesToJson = exports.getProperties = void 0;
-var file_1 = require("./file");
-Object.defineProperty(exports, "getProperties", { enumerable: true, get: function () { return file_1.getProperties; } });
-Object.defineProperty(exports, "propertiesToJson", { enumerable: true, get: function () { return file_1.propertiesToJson; } });
+exports.getProperties = exports.Properties = void 0;
 var properties_1 = require("./properties");
-Object.defineProperty(exports, "Properties", { enumerable: true, get: function () { return properties_1.Properties; } });
-var property_1 = require("./property");
-Object.defineProperty(exports, "Property", { enumerable: true, get: function () { return property_1.Property; } });
-var property_line_1 = require("./property-line");
-Object.defineProperty(exports, "PropertyLine", { enumerable: true, get: function () { return property_line_1.PropertyLine; } });
+var properties_2 = require("./properties");
+Object.defineProperty(exports, "Properties", { enumerable: true, get: function () { return properties_2.Properties; } });
+/**
+ * Converts the content of a `.properties` file to a key-value pair object.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns A key/value object representing the content of a `.properties` file.
+ */
+var getProperties = function (content) {
+    return new properties_1.Properties(content).toObject();
+};
+exports.getProperties = getProperties;

package/lib/loader/webpack.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var content_1 = require("../content");
+var __1 = require("..");
 /**
  * Webpack file loader for `.properties` files.
  *
@@ -9,6 +9,6 @@ var content_1 = require("../content");
  * @returns A Webpack file loader string containing the content of  a `.properties` file.
  */
 var webpackLoader = function (content) {
-    return "module.exports = ".concat(JSON.stringify((0, content_1.propertiesToJson)(content)), ";");
+    return "module.exports = ".concat(JSON.stringify((0, __1.getProperties)(content)), ";");
 };
 exports.default = webpackLoader;

package/lib/properties.d.ts

@@ -1,13 +1,37 @@
-import { KeyValueObject } from './';
+/// <reference types="node" />
+import { KeyValuePairObject } from '.';
 import { Property } from './property';
+/**
+ * Byte-order mark.
+ */
+export declare const BOM = "\uFEFF";
+export declare const BOM_CODE_POINT: number | undefined;
+/** The default end of line character. */
+export declare const DEFAULT_END_OF_LINE_CHARACTER = "\n";
 /**
  * A class representing the content of a .properties file.
  */
 export declare class Properties {
+    /** Does the .properties content starts with a BOM character? */
+    readonly hasBom: boolean;
+    /** The end of line character. */
+    readonly eolCharacter: string;
+    /** `.properties` content split by line. */
+    protected lines: string[];
     /** The collection of property object. */
     collection: Property[];
     /** Object associating keys with their starting line numbers. */
     keyLineNumbers: KeyLineNumbers;
+    /**
+     * Create `Properties` object.
+     *
+     * @param content - The content of a `.properties` file.
+     */
+    constructor(content: string | Buffer);
+    /**
+     * Parse the `.properties` content line by line.
+     */
+    protected parseLines(): void;
     /**
      * Add a property object into a properties object collection.
      *
@@ -15,17 +39,25 @@ export declare class Properties {
      *
      * @returns Undefined so that we conveniently overwrite the property object.
      */
-    add(property: Property | undefined): undefined;
+    private addToCollection;
     /**
      * Get keys that have collisions (more than one occurrence).
      */
     getKeyCollisions(): KeyCollisions[];
     /**
-     * Get the JSON (key/value) representation of the properties.
+     * Get the key/value object representing the properties.
+     *
+     * @returns A key/value object representing the properties.
+     */
+    toObject(): KeyValuePairObject;
+    /**
+     * Format the object in `.properties`.
+     *
+     * @param endOfLineCharacter - The character used for end of lines.
      *
-     * @returns A key/value representing the properties of the object.
+     * @returns The object in `.properties` format.
      */
-    toJson(): KeyValueObject;
+    format(endOfLineCharacter?: '\n' | '\r\n'): string;
 }
 /**
  * Object associating keys with their line numbers.

package/lib/properties.js

@@ -1,16 +1,125 @@
 "use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyCollisions = exports.Properties = void 0;
+exports.KeyCollisions = exports.Properties = exports.DEFAULT_END_OF_LINE_CHARACTER = exports.BOM_CODE_POINT = exports.BOM = void 0;
+var property_1 = require("./property");
+var property_line_1 = require("./property-line");
+/**
+ * Byte-order mark.
+ */
+exports.BOM = '\uFEFF';
+exports.BOM_CODE_POINT = exports.BOM.codePointAt(0);
+/** The default end of line character. */
+exports.DEFAULT_END_OF_LINE_CHARACTER = '\n';
+/**
+ * Get the first end of line (EOL) character from multiline content.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns The multiline content's first end of line (EOL) character.
+ */
+var getFirstEolCharacter = function (content) {
+    var newlineIndex = content.indexOf('\n');
+    return newlineIndex < 0 ? undefined : "".concat(content[newlineIndex - 1] === '\r' ? '\r' : '', "\n");
+};
 /**
  * A class representing the content of a .properties file.
  */
 var Properties = /** @class */ (function () {
-    function Properties() {
+    /**
+     * Create `Properties` object.
+     *
+     * @param content - The content of a `.properties` file.
+     */
+    function Properties(content) {
+        var _a;
         /** The collection of property object. */
         this.collection = [];
         /** Object associating keys with their starting line numbers. */
         this.keyLineNumbers = {};
+        var stringContent = Buffer.isBuffer(content) ? content.toString() : content;
+        this.hasBom = stringContent.codePointAt(0) === exports.BOM_CODE_POINT;
+        this.eolCharacter = (_a = getFirstEolCharacter(stringContent)) !== null && _a !== void 0 ? _a : exports.DEFAULT_END_OF_LINE_CHARACTER;
+        this.lines = (this.hasBom ? stringContent.slice(1) : stringContent).split(/\r?\n/);
+        this.parseLines();
     }
+    /**
+     * Parse the `.properties` content line by line.
+     */
+    Properties.prototype.parseLines = function () {
+        var e_1, _a;
+        /** reset existing object properties to their initial values. */
+        this.collection = [];
+        this.keyLineNumbers = {};
+        /** Line number while parsing properties file content. */
+        var lineNumber = 0;
+        /** The current property object being parsed. */
+        var property;
+        /** The previous property object that was parsed. */
+        var previousProperty;
+        try {
+            for (var _b = __values(this.lines), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var line = _c.value;
+                lineNumber++;
+                var propertyLine = new property_line_1.PropertyLine(line, !!property);
+                if (property) {
+                    // Continue parsing an existing property.
+                    property.addLine(propertyLine);
+                    if (propertyLine.isContinuing) {
+                        continue;
+                    }
+                }
+                else {
+                    // Check if the line is a new property.
+                    if (propertyLine.isComment || propertyLine.isBlank) {
+                        continue; // Skip line if its a comment or blank.
+                    }
+                    // The line is a new property.
+                    property = new property_1.Property(propertyLine, lineNumber, previousProperty);
+                    if (propertyLine.isContinuing) {
+                        continue; // Continue parsing the next line.
+                    }
+                }
+                // If the line does not continue, add the property to the collection.
+                this.addToCollection(property);
+                previousProperty = property;
+                property = undefined;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    };
     /**
      * Add a property object into a properties object collection.
      *
@@ -18,11 +127,8 @@ var Properties = /** @class */ (function () {
      *
      * @returns Undefined so that we conveniently overwrite the property object.
      */
-    Properties.prototype.add = function (property) {
+    Properties.prototype.addToCollection = function (property) {
         var _a;
-        if (property === undefined) {
-            return undefined;
-        }
         property.setKeyAndValue();
         if ((_a = this.keyLineNumbers[property.key]) === null || _a === void 0 ? void 0 : _a.length) {
             this.keyLineNumbers[property.key].push(property.startingLineNumber);
@@ -37,33 +143,52 @@ var Properties = /** @class */ (function () {
         }
         // Add the property to the collection.
         this.collection.push(property);
-        return undefined;
     };
     /**
      * Get keys that have collisions (more than one occurrence).
      */
     Properties.prototype.getKeyCollisions = function () {
+        var e_2, _a;
         var keyCollisions = [];
-        for (var _i = 0, _a = Object.entries(this.keyLineNumbers); _i < _a.length; _i++) {
-            var _b = _a[_i], key = _b[0], startingLineNumbers = _b[1];
-            if (startingLineNumbers.length > 1) {
-                keyCollisions.push(new KeyCollisions(key, startingLineNumbers));
+        try {
+            for (var _b = __values(Object.entries(this.keyLineNumbers)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var _d = __read(_c.value, 2), key = _d[0], startingLineNumbers = _d[1];
+                if (startingLineNumbers.length > 1) {
+                    keyCollisions.push(new KeyCollisions(key, startingLineNumbers));
+                }
             }
         }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
         return keyCollisions;
     };
     /**
-     * Get the JSON (key/value) representation of the properties.
+     * Get the key/value object representing the properties.
      *
-     * @returns A key/value representing the properties of the object.
+     * @returns A key/value object representing the properties.
      */
-    Properties.prototype.toJson = function () {
+    Properties.prototype.toObject = function () {
         var keyValueObject = {};
         this.collection.forEach(function (property) {
             keyValueObject[property.key] = property.value;
         });
         return keyValueObject;
     };
+    /**
+     * Format the object in `.properties`.
+     *
+     * @param endOfLineCharacter - The character used for end of lines.
+     *
+     * @returns The object in `.properties` format.
+     */
+    Properties.prototype.format = function (endOfLineCharacter) {
+        return "".concat(this.hasBom ? exports.BOM : '').concat(this.lines.join(endOfLineCharacter || this.eolCharacter));
+    };
     return Properties;
 }());
 exports.Properties = Properties;