properties-file 2.1.1 → 2.1.4

package/lib/file/index.d.ts

@@ -1,21 +1,21 @@
-/// <reference types="node" />
-import { KeyValueObject, Properties } from '../';
-export { KeyValueObject } from '../';
-/**
- * Get a `Properties` object from the content of a `.properties` file.
- *
- * @param filePath - The file path of the `.properties` file.
- * @param encoding - The encoding of the file to parse (default is UTF-8).
- *
- * @returns A `Properties` object representing the content of a `.properties` file.
- */
-export declare function getProperties(filePath: string, encoding?: BufferEncoding): Properties;
-/**
- * Converts the content of a `.properties` file to JSON.
- *
- * @param filePath - The file path of the `.properties` file.
- * @param encoding - The encoding of the file to parse (default is UTF-8).
- *
- * @returns A (JSON) key/value object representing the content of a `.properties` file.
- */
-export declare function propertiesToJson(filePath: string, encoding?: BufferEncoding): KeyValueObject;
+/// <reference types="node" />
+import { KeyValueObject, Properties } from '../';
+export { KeyValueObject } from '../';
+/**
+ * Get a `Properties` object from the content of a `.properties` file.
+ *
+ * @param filePath - The file path of the `.properties` file.
+ * @param encoding - The encoding of the file to parse (default is UTF-8).
+ *
+ * @returns A `Properties` object representing the content of a `.properties` file.
+ */
+export declare function getProperties(filePath: string, encoding?: BufferEncoding): Properties;
+/**
+ * Converts the content of a `.properties` file to JSON.
+ *
+ * @param filePath - The file path of the `.properties` file.
+ * @param encoding - The encoding of the file to parse (default is UTF-8).
+ *
+ * @returns A (JSON) key/value object representing the content of a `.properties` file.
+ */
+export declare function propertiesToJson(filePath: string, encoding?: BufferEncoding): KeyValueObject;

package/lib/file/index.js

@@ -1,32 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.propertiesToJson = exports.getProperties = void 0;
-var node_fs_1 = require("node:fs");
-var content_1 = require("../content/");
-/**
- * Get a `Properties` object from the content of a `.properties` file.
- *
- * @param filePath - The file path of the `.properties` file.
- * @param encoding - The encoding of the file to parse (default is UTF-8).
- *
- * @returns A `Properties` object representing the content of a `.properties` file.
- */
-function getProperties(filePath, encoding) {
-    if (!(0, node_fs_1.existsSync)(filePath)) {
-        throw new Error("file not found at ".concat(filePath));
-    }
-    return (0, content_1.getProperties)((0, node_fs_1.readFileSync)(filePath, encoding !== null && encoding !== void 0 ? encoding : 'utf8'));
-}
-exports.getProperties = getProperties;
-/**
- * Converts the content of a `.properties` file to JSON.
- *
- * @param filePath - The file path of the `.properties` file.
- * @param encoding - The encoding of the file to parse (default is UTF-8).
- *
- * @returns A (JSON) key/value object representing the content of a `.properties` file.
- */
-function propertiesToJson(filePath, encoding) {
-    return getProperties(filePath, encoding).toJson();
-}
-exports.propertiesToJson = propertiesToJson;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propertiesToJson = exports.getProperties = void 0;
+var node_fs_1 = require("node:fs");
+var content_1 = require("../content/");
+/**
+ * Get a `Properties` object from the content of a `.properties` file.
+ *
+ * @param filePath - The file path of the `.properties` file.
+ * @param encoding - The encoding of the file to parse (default is UTF-8).
+ *
+ * @returns A `Properties` object representing the content of a `.properties` file.
+ */
+function getProperties(filePath, encoding) {
+    if (!(0, node_fs_1.existsSync)(filePath)) {
+        throw new Error("file not found at ".concat(filePath));
+    }
+    return (0, content_1.getProperties)((0, node_fs_1.readFileSync)(filePath, encoding !== null && encoding !== void 0 ? encoding : 'utf8'));
+}
+exports.getProperties = getProperties;
+/**
+ * Converts the content of a `.properties` file to JSON.
+ *
+ * @param filePath - The file path of the `.properties` file.
+ * @param encoding - The encoding of the file to parse (default is UTF-8).
+ *
+ * @returns A (JSON) key/value object representing the content of a `.properties` file.
+ */
+function propertiesToJson(filePath, encoding) {
+    return getProperties(filePath, encoding).toJson();
+}
+exports.propertiesToJson = propertiesToJson;

package/lib/index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="./properties-file" />
 
-export { getProperties, propertiesToJson } from './file';
-export { KeyLineNumbers, Properties } from './properties';
-export { Property } from './property';
-export { PropertyLine } from './property-line';
-/**
- * A simple "key/value" object.
- */
-export declare type KeyValueObject = {
-    [key: string]: string;
-};
+export { getProperties, propertiesToJson } from './file';
+export { KeyLineNumbers, Properties } from './properties';
+export { Property } from './property';
+export { PropertyLine } from './property-line';
+/**
+ * A simple "key/value" object.
+ */
+export declare type KeyValueObject = {
+    [key: string]: string;
+};

package/lib/index.js

@@ -1,12 +1,12 @@
-"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; } });
-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; } });
+"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; } });
+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; } });

package/lib/loader/webpack.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="../properties-file" />
 
-/**
- * Webpack file loader for `.properties` files.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A Webpack file loader string containing the content of  a `.properties` file.
- */
-export default function (content: string): string;
+/**
+ * Webpack file loader for `.properties` files.
+ *
+ * @param content - the content of a `.properties` file.
+ *
+ * @returns A Webpack file loader string containing the content of  a `.properties` file.
+ */
+export default function (content: string): string;

package/lib/loader/webpack.js

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

package/lib/properties-file.d.ts

@@ -1,7 +1,7 @@
-/** This allows to get the correct type when using `import` on `.properties` files. */
-declare module '*.properties' {
-  const properties: {
-    readonly [key: string]: string
-  }
-  export default properties
-}
+/** This allows to get the correct type when using `import` on `.properties` files. */
+declare module '*.properties' {
+  const properties: {
+    readonly [key: string]: string
+  }
+  export default properties
+}

package/lib/properties.d.ts

@@ -1,55 +1,55 @@
-import { KeyValueObject } from './';
-import { Property } from './property';
-/**
- * A class representing the content of a .properties file.
- */
-export declare class Properties {
-    /** The collection of property object. */
-    collection: Property[];
-    /** Object associating keys with their starting line numbers. */
-    keyLineNumbers: KeyLineNumbers;
-    /**
-     * Add a property object into a properties object collection.
-     *
-     * @param property - A property object, or undefined.
-     *
-     * @returns Undefined so that we conveniently overwrite the property object.
-     */
-    add(property: Property | undefined): undefined;
-    /**
-     * Get keys that have collisions (more than one occurrence).
-     */
-    getKeyCollisions(): KeyCollisions[];
-    /**
-     * Get the JSON (key/value) representation of the properties.
-     *
-     * @returns A key/value representing the properties of the object.
-     */
-    toJson(): KeyValueObject;
-}
-/**
- * Object associating keys with their line numbers.
- */
-export declare type KeyLineNumbers = {
-    [key: string]: number[];
-};
-/**
- * A class representing key within a .properties file that had collisions (more than one occurrence).
- */
-export declare class KeyCollisions {
-    /** The key with collisions. */
-    key: string;
-    /** The starting line numbers where collisions are found. */
-    startingLineNumbers: number[];
-    /**
-     * Create a new key collision object.
-     *
-     * @param key - The key with collisions.
-     * @param startingLineNumbers - The starting line numbers where collisions are found.
-     */
-    constructor(key: string, startingLineNumbers: number[]);
-    /**
-     * Get the number of the line from which the value will be used.
-     */
-    getApplicableLineNumber(): number;
-}
+import { KeyValueObject } from './';
+import { Property } from './property';
+/**
+ * A class representing the content of a .properties file.
+ */
+export declare class Properties {
+    /** The collection of property object. */
+    collection: Property[];
+    /** Object associating keys with their starting line numbers. */
+    keyLineNumbers: KeyLineNumbers;
+    /**
+     * Add a property object into a properties object collection.
+     *
+     * @param property - A property object, or undefined.
+     *
+     * @returns Undefined so that we conveniently overwrite the property object.
+     */
+    add(property: Property | undefined): undefined;
+    /**
+     * Get keys that have collisions (more than one occurrence).
+     */
+    getKeyCollisions(): KeyCollisions[];
+    /**
+     * Get the JSON (key/value) representation of the properties.
+     *
+     * @returns A key/value representing the properties of the object.
+     */
+    toJson(): KeyValueObject;
+}
+/**
+ * Object associating keys with their line numbers.
+ */
+export declare type KeyLineNumbers = {
+    [key: string]: number[];
+};
+/**
+ * A class representing key within a .properties file that had collisions (more than one occurrence).
+ */
+export declare class KeyCollisions {
+    /** The key with collisions. */
+    key: string;
+    /** The starting line numbers where collisions are found. */
+    startingLineNumbers: number[];
+    /**
+     * Create a new key collision object.
+     *
+     * @param key - The key with collisions.
+     * @param startingLineNumbers - The starting line numbers where collisions are found.
+     */
+    constructor(key: string, startingLineNumbers: number[]);
+    /**
+     * Get the number of the line from which the value will be used.
+     */
+    getApplicableLineNumber(): number;
+}

package/lib/properties.js

@@ -1,91 +1,91 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyCollisions = exports.Properties = void 0;
-/**
- * A class representing the content of a .properties file.
- */
-var Properties = /** @class */ (function () {
-    function Properties() {
-        /** The collection of property object. */
-        this.collection = [];
-        /** Object associating keys with their starting line numbers. */
-        this.keyLineNumbers = {};
-    }
-    /**
-     * Add a property object into a properties object collection.
-     *
-     * @param property - A property object, or undefined.
-     *
-     * @returns Undefined so that we conveniently overwrite the property object.
-     */
-    Properties.prototype.add = 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);
-            property.hasKeyCollisions = true;
-            property.keyCollisionLines = this.keyLineNumbers[property.key];
-            // Remove collision so that we can overwrite it with the latest object.
-            this.collection = this.collection.filter(function (existingPropertyObject) { return existingPropertyObject.key !== property.key; });
-        }
-        else {
-            // Initialize the key line numbers.
-            this.keyLineNumbers[property.key] = [property.startingLineNumber];
-        }
-        // 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 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));
-            }
-        }
-        return keyCollisions;
-    };
-    /**
-     * Get the JSON (key/value) representation of the properties.
-     *
-     * @returns A key/value representing the properties of the object.
-     */
-    Properties.prototype.toJson = function () {
-        var keyValueObject = {};
-        this.collection.forEach(function (property) {
-            keyValueObject[property.key] = property.value;
-        });
-        return keyValueObject;
-    };
-    return Properties;
-}());
-exports.Properties = Properties;
-/**
- * A class representing key within a .properties file that had collisions (more than one occurrence).
- */
-var KeyCollisions = /** @class */ (function () {
-    /**
-     * Create a new key collision object.
-     *
-     * @param key - The key with collisions.
-     * @param startingLineNumbers - The starting line numbers where collisions are found.
-     */
-    function KeyCollisions(key, startingLineNumbers) {
-        this.key = key;
-        this.startingLineNumbers = startingLineNumbers;
-    }
-    /**
-     * Get the number of the line from which the value will be used.
-     */
-    KeyCollisions.prototype.getApplicableLineNumber = function () {
-        return this.startingLineNumbers.slice(-1)[0];
-    };
-    return KeyCollisions;
-}());
-exports.KeyCollisions = KeyCollisions;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyCollisions = exports.Properties = void 0;
+/**
+ * A class representing the content of a .properties file.
+ */
+var Properties = /** @class */ (function () {
+    function Properties() {
+        /** The collection of property object. */
+        this.collection = [];
+        /** Object associating keys with their starting line numbers. */
+        this.keyLineNumbers = {};
+    }
+    /**
+     * Add a property object into a properties object collection.
+     *
+     * @param property - A property object, or undefined.
+     *
+     * @returns Undefined so that we conveniently overwrite the property object.
+     */
+    Properties.prototype.add = 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);
+            property.hasKeyCollisions = true;
+            property.keyCollisionLines = this.keyLineNumbers[property.key];
+            // Remove collision so that we can overwrite it with the latest object.
+            this.collection = this.collection.filter(function (existingPropertyObject) { return existingPropertyObject.key !== property.key; });
+        }
+        else {
+            // Initialize the key line numbers.
+            this.keyLineNumbers[property.key] = [property.startingLineNumber];
+        }
+        // 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 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));
+            }
+        }
+        return keyCollisions;
+    };
+    /**
+     * Get the JSON (key/value) representation of the properties.
+     *
+     * @returns A key/value representing the properties of the object.
+     */
+    Properties.prototype.toJson = function () {
+        var keyValueObject = {};
+        this.collection.forEach(function (property) {
+            keyValueObject[property.key] = property.value;
+        });
+        return keyValueObject;
+    };
+    return Properties;
+}());
+exports.Properties = Properties;
+/**
+ * A class representing key within a .properties file that had collisions (more than one occurrence).
+ */
+var KeyCollisions = /** @class */ (function () {
+    /**
+     * Create a new key collision object.
+     *
+     * @param key - The key with collisions.
+     * @param startingLineNumbers - The starting line numbers where collisions are found.
+     */
+    function KeyCollisions(key, startingLineNumbers) {
+        this.key = key;
+        this.startingLineNumbers = startingLineNumbers;
+    }
+    /**
+     * Get the number of the line from which the value will be used.
+     */
+    KeyCollisions.prototype.getApplicableLineNumber = function () {
+        return this.startingLineNumbers.slice(-1)[0];
+    };
+    return KeyCollisions;
+}());
+exports.KeyCollisions = KeyCollisions;

package/lib/property-line.d.ts

@@ -1,22 +1,22 @@
-/**
- * Object representing a line from the content of .properties file.
- */
-export declare class PropertyLine {
-    /** The line content, minus the trailing \ that identifies that the line continues. */
-    content: string;
-    /** True if the line continues, otherwise false. */
-    continues: boolean;
-    /** True if the line is blank, otherwise false. */
-    isBlank: boolean;
-    /** True if the line is a comment, otherwise false. */
-    isComment: boolean;
-    /** Is the line object a continuation from a previous line? */
-    isMultiline: boolean;
-    /**
-     * Create a new line object.
-     *
-     * @param line - The raw content of a line.
-     * @param isMultiline - Is the line spreading on multiple lines?
-     */
-    constructor(line: string, isMultiline: boolean);
-}
+/**
+ * Object representing a line from the content of .properties file.
+ */
+export declare class PropertyLine {
+    /** The line content, minus the trailing \ that identifies that the line continues. */
+    content: string;
+    /** True if the line continues, otherwise false. */
+    continues: boolean;
+    /** True if the line is blank, otherwise false. */
+    isBlank: boolean;
+    /** True if the line is a comment, otherwise false. */
+    isComment: boolean;
+    /** Is the line object a continuation from a previous line? */
+    isMultiline: boolean;
+    /**
+     * Create a new line object.
+     *
+     * @param line - The raw content of a line.
+     * @param isMultiline - Is the line spreading on multiple lines?
+     */
+    constructor(line: string, isMultiline: boolean);
+}