properties-file 2.0.9 → 2.1.2

package/lib/content/index.js

@@ -13,7 +13,7 @@ var property_line_1 = require("../property-line");
  */
 function getProperties(content) {
     // Remove BOM character if present and create an array from lines.
-    var lines = (content.charCodeAt(0) === 0xfeff ? content.slice(1) : content).split(/\r?\n/);
+    var lines = (content.codePointAt(0) === 0xfeff ? content.slice(1) : content).split(/\r?\n/);
     /** Line number while parsing properties file content. */
     var lineNumber = 0;
     /** The current property object being parsed. */

package/lib/file/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.propertiesToJson = exports.getProperties = void 0;
-var fs_1 = require("fs");
+var node_fs_1 = require("node:fs");
 var content_1 = require("../content/");
 /**
  * Get a `Properties` object from the content of a `.properties` file.
@@ -12,10 +12,10 @@ var content_1 = require("../content/");
  * @returns A `Properties` object representing the content of a `.properties` file.
  */
 function getProperties(filePath, encoding) {
-    if (!(0, fs_1.existsSync)(filePath)) {
-        throw Error("file not found at ".concat(filePath));
+    if (!(0, node_fs_1.existsSync)(filePath)) {
+        throw new Error("file not found at ".concat(filePath));
     }
-    return (0, content_1.getProperties)((0, fs_1.readFileSync)(filePath, encoding ? encoding : 'utf-8'));
+    return (0, content_1.getProperties)((0, node_fs_1.readFileSync)(filePath, encoding !== null && encoding !== void 0 ? encoding : 'utf8'));
 }
 exports.getProperties = getProperties;
 /**

package/lib/properties.d.ts

@@ -4,10 +4,10 @@ import { Property } from './property';
  * A class representing the content of a .properties file.
  */
 export declare class Properties {
-    /** Object associating keys with their starting line numbers. */
-    keyLineNumbers: KeyLineNumbers;
     /** 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.
      *
@@ -16,16 +16,16 @@ export declare class Properties {
      * @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;
-    /**
-     * Get keys that have collisions (more than one occurrence).
-     */
-    getKeyCollisions(): KeyCollisions[];
 }
 /**
  * Object associating keys with their line numbers.

package/lib/properties.js

@@ -6,10 +6,10 @@ exports.KeyCollisions = exports.Properties = void 0;
  */
 var Properties = /** @class */ (function () {
     function Properties() {
-        /** Object associating keys with their starting line numbers. */
-        this.keyLineNumbers = {};
         /** 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.
@@ -38,18 +38,6 @@ var Properties = /** @class */ (function () {
         this.collection.push(property);
         return undefined;
     };
-    /**
-     * 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;
-    };
     /**
      * Get keys that have collisions (more than one occurrence).
      */
@@ -63,6 +51,18 @@ var Properties = /** @class */ (function () {
         }
         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;

package/lib/property-line.d.ts

@@ -4,14 +4,14 @@
 export declare class PropertyLine {
     /** The line content, minus the trailing \ that identifies that the line continues. */
     content: string;
-    /** Is the line object a continuation from a previous line? */
-    isMultiline: boolean;
     /** True if the line continues, otherwise false. */
     continues: boolean;
-    /** True if the line is a comment, otherwise false. */
-    isComment: 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.
      *

package/lib/property-line.js

@@ -14,20 +14,20 @@ var PropertyLine = /** @class */ (function () {
     function PropertyLine(line, isMultiline) {
         /** True if the line continues, otherwise false. */
         this.continues = false;
-        /** True if the line is a comment, otherwise false. */
-        this.isComment = false;
         /** True if the line is blank, otherwise false. */
         this.isBlank = false;
+        /** True if the line is a comment, otherwise false. */
+        this.isComment = false;
         this.content = line.trimStart();
         this.isMultiline = isMultiline;
-        if (!this.content.length) {
+        if (this.content.length === 0) {
             // Line is blank.
             this.isBlank = true;
         }
         else {
             if (!this.isMultiline) {
                 // Line is a comment.
-                this.isComment = !!this.content.match(/^[!#]/);
+                this.isComment = !!/^[!#]/.test(this.content);
             }
             if (!this.isComment) {
                 // Otherwise, check if the line continues on the next line.

package/lib/property.d.ts

@@ -3,28 +3,28 @@ import { PropertyLine } from './property-line';
  * Object representing a property (key/value).
  */
 export declare class Property {
-    /** The line number at which the property starts. */
-    startingLineNumber: number;
-    /** The content of one or multiple lines when applicable. */
-    linesContent: string;
-    /** Positions of the newline characters if any. */
-    newlinePositions: number[];
-    /** Starting line numbers of property objects with the same key. */
-    keyCollisionLines: number[];
-    /** The starting position of the delimiter separating the key from the value. */
-    delimiterPosition: number | undefined;
     /** The length of the delimiter, including its whitespace characters. */
     delimiterLength: number | undefined;
+    /** The starting position of the delimiter separating the key from the value. */
+    delimiterPosition: number | undefined;
     /** The property key, including its escaped characters. */
     escapedKey: string;
     /** The property value, including its escaped characters. */
     escapedValue: string;
+    /** Was the property's key used more than once? */
+    hasKeyCollisions: boolean;
     /** The property key (unescaped). */
     key: string;
+    /** Starting line numbers of property objects with the same key. */
+    keyCollisionLines: number[];
+    /** The content of one or multiple lines when applicable. */
+    linesContent: string;
+    /** Positions of the newline characters if any. */
+    newlinePositions: number[];
+    /** The line number at which the property starts. */
+    startingLineNumber: number;
     /** The property value (unescaped). */
     value: string;
-    /** Was the property's key used more than once? */
-    hasKeyCollisions: boolean;
     /** Does the key definition spread across multiple lines? */
     private hasMultilineKey;
     /** Is the key empty? */

package/lib/property.js

@@ -12,20 +12,20 @@ var Property = /** @class */ (function () {
      * @param startingLineNumber - The line number at which the property starts.
      */
     function Property(propertyLine, startingLineNumber) {
-        /** Positions of the newline characters if any. */
-        this.newlinePositions = [];
-        /** Starting line numbers of property objects with the same key. */
-        this.keyCollisionLines = [];
         /** The property key, including its escaped characters. */
         this.escapedKey = '';
         /** The property value, including its escaped characters. */
         this.escapedValue = '';
+        /** Was the property's key used more than once? */
+        this.hasKeyCollisions = false;
         /** The property key (unescaped). */
         this.key = '';
+        /** Starting line numbers of property objects with the same key. */
+        this.keyCollisionLines = [];
+        /** Positions of the newline characters if any. */
+        this.newlinePositions = [];
         /** The property value (unescaped). */
         this.value = '';
-        /** Was the property's key used more than once? */
-        this.hasKeyCollisions = false;
         /** Does the key definition spread across multiple lines? */
         this.hasMultilineKey = false;
         /** Is the key empty? */
@@ -41,7 +41,7 @@ var Property = /** @class */ (function () {
      * @param propertyLine - A property line object.
      */
     Property.prototype.addLine = function (propertyLine) {
-        if (this.linesContent.length) {
+        if (this.linesContent.length > 0) {
             this.newlinePositions.push(this.linesContent.length);
         }
         this.linesContent += propertyLine.content;
@@ -54,12 +54,12 @@ var Property = /** @class */ (function () {
         if (this.delimiterPosition !== undefined && this.delimiterLength !== undefined) {
             // Set key if present.
             if (!this.hasNoKey) {
-                this.escapedKey = this.linesContent.substring(0, this.delimiterPosition);
+                this.escapedKey = this.linesContent.slice(0, this.delimiterPosition);
                 this.key = this.unescape(this.escapedKey, this.startingLineNumber);
             }
             // Set value if present.
             if (!this.hasNoValue) {
-                this.escapedValue = this.linesContent.substring(this.delimiterPosition + this.delimiterLength);
+                this.escapedValue = this.linesContent.slice(this.delimiterPosition + this.delimiterLength);
                 this.value = this.unescape(this.escapedValue, this.startingLineNumber);
             }
         }
@@ -79,43 +79,50 @@ var Property = /** @class */ (function () {
      */
     Property.prototype.unescape = function (escapedContent, startingLineNumber) {
         var unescapedContent = '';
-        for (var position = 0, character = escapedContent[0]; position < escapedContent.length; position++, character = escapedContent[position]) {
+        for (var character = escapedContent[0], position = 0; position < escapedContent.length; position++, character = escapedContent[position]) {
             if (character === '\\') {
                 var nextCharacter = escapedContent[position + 1];
-                if (nextCharacter === 'f') {
-                    // Formfeed/
-                    unescapedContent += '\f';
-                    position++;
-                }
-                else if (nextCharacter === 'n') {
-                    // Newline.
-                    unescapedContent += '\n';
-                    position++;
-                }
-                else if (nextCharacter === 'r') {
-                    // Carriage return.
-                    unescapedContent += '\r';
-                    position++;
-                }
-                else if (nextCharacter === 't') {
-                    // Tab.
-                    unescapedContent += '\t';
-                    position++;
-                }
-                else if (nextCharacter === 'u') {
-                    // Unicode character.
-                    var codePoint = escapedContent.substring(position + 2, position + 6);
-                    if (!/[0-9a-f]{4}/i.test(codePoint)) {
-                        // Code point can only be within Unicode's Multilingual Plane (BMP).
-                        throw new Error("malformed escaped unicode characters '\\u".concat(codePoint, "' in property starting at line ").concat(startingLineNumber));
+                switch (nextCharacter) {
+                    case 'f': {
+                        // Formfeed/
+                        unescapedContent += '\f';
+                        position++;
+                        break;
+                    }
+                    case 'n': {
+                        // Newline.
+                        unescapedContent += '\n';
+                        position++;
+                        break;
+                    }
+                    case 'r': {
+                        // Carriage return.
+                        unescapedContent += '\r';
+                        position++;
+                        break;
+                    }
+                    case 't': {
+                        // Tab.
+                        unescapedContent += '\t';
+                        position++;
+                        break;
+                    }
+                    case 'u': {
+                        // Unicode character.
+                        var codePoint = escapedContent.slice(position + 2, position + 6);
+                        if (!/[\da-f]{4}/i.test(codePoint)) {
+                            // Code point can only be within Unicode's Multilingual Plane (BMP).
+                            throw new Error("malformed escaped unicode characters '\\u".concat(codePoint, "' in property starting at line ").concat(startingLineNumber));
+                        }
+                        unescapedContent += String.fromCodePoint(Number.parseInt(codePoint, 16));
+                        position += 5;
+                        break;
+                    }
+                    default: {
+                        // Otherwise the escape character is not required.
+                        unescapedContent += nextCharacter;
+                        position++;
                     }
-                    unescapedContent += String.fromCharCode(parseInt(codePoint, 16));
-                    position += 5;
-                }
-                else {
-                    // Otherwise the escape character is not required.
-                    unescapedContent += nextCharacter;
-                    position++;
                 }
             }
             else {
@@ -134,14 +141,14 @@ var Property = /** @class */ (function () {
         if (this.hasNoKey || this.hasNoValue || this.delimiterPosition) {
             return;
         }
-        for (var position = 0, character = this.linesContent[0]; position < this.linesContent.length; position++, character = this.linesContent[position]) {
+        for (var character = this.linesContent[0], position = 0; position < this.linesContent.length; position++, character = this.linesContent[position]) {
             // If the character is not a delimiter, check the next one.
-            if (!/[ \t\f=:]/.test(character)) {
+            if (!/[\t\f :=]/.test(character)) {
                 continue;
             }
             // Check if the delimiter might be escaped.
-            var prefix = !position ? '' : this.linesContent.substring(0, position);
-            if (prefix.length) {
+            var prefix = !position ? '' : this.linesContent.slice(0, position);
+            if (prefix.length > 0) {
                 var backslashMatch = prefix.match(/(?<backslashes>\\+)$/);
                 if (backslashMatch === null || backslashMatch === void 0 ? void 0 : backslashMatch.groups) {
                     var delimiterIsEscaped = !!(backslashMatch.groups.backslashes.length % 2);
@@ -153,20 +160,20 @@ var Property = /** @class */ (function () {
             }
             var delimiter = '';
             this.delimiterPosition = position;
-            this.hasMultilineKey = !!(this.newlinePositions.length && this.newlinePositions[0] > position);
+            this.hasMultilineKey = !!(this.newlinePositions.length > 0 && this.newlinePositions[0] > position);
             // Check if the delimiter starts with a whitespace.
-            var nextContent = this.linesContent.substring(position);
+            var nextContent = this.linesContent.slice(position);
             var leadingWhitespaceMatch = nextContent.match(/^(?<whitespace>\s+)/);
             var leadingWhitespace = ((_a = leadingWhitespaceMatch === null || leadingWhitespaceMatch === void 0 ? void 0 : leadingWhitespaceMatch.groups) === null || _a === void 0 ? void 0 : _a.whitespace) || '';
             // If there is a whitespace, move to the next character.
-            if (leadingWhitespace.length) {
+            if (leadingWhitespace.length > 0) {
                 delimiter += leadingWhitespace;
-                nextContent = nextContent.substring(leadingWhitespace.length);
+                nextContent = nextContent.slice(leadingWhitespace.length);
             }
             // Check if there is an equal or colon character.
-            if (/[=:]/.test(nextContent[0])) {
+            if (/[:=]/.test(nextContent[0])) {
                 delimiter += nextContent[0];
-                nextContent = nextContent.substring(1);
+                nextContent = nextContent.slice(1);
                 // If an equal or colon character was found, try to get trailing whitespace.
                 var trailingWhitespaceMatch = nextContent.match(/^(?<whitespace>\s+)/);
                 var trailingWhitespace = ((_b = trailingWhitespaceMatch === null || trailingWhitespaceMatch === void 0 ? void 0 : trailingWhitespaceMatch.groups) === null || _b === void 0 ? void 0 : _b.whitespace) || '';
@@ -185,7 +192,7 @@ var Property = /** @class */ (function () {
         }
         else {
             // If the delimiter is after the first newline, mark the key as multiline.
-            if (this.newlinePositions.length) {
+            if (this.newlinePositions.length > 0) {
                 var firstLinePosition = this.newlinePositions[0];
                 if (firstLinePosition > this.delimiterPosition) {
                     this.hasMultilineKey = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "properties-file",
-  "version": "2.0.9",
+  "version": "2.1.2",
   "description": ".properties file parser, JSON converter and Webpack loader.",
   "author": "Avansai (https://avansai.com)",
   "repository": {
@@ -42,33 +42,39 @@
     "internationalization"
   ],
   "scripts": {
-    "build": "rm -Rf ./lib && tsc && npm run add-import-type && npm run lint && npm test",
-    "lint": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx --fix .",
+    "build": "npm run prettier && npm run lint-fix && rm -Rf ./lib && tsc && npm run add-import-type && npm run test",
+    "lint-fix": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx --fix .",
+    "lint-check": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx .",
     "lint-print-config": "eslint --print-config ./eslintrc.yaml",
     "prettier": "prettier --write .",
-    "add-import-type": "node ./src/add-import-type",
+    "add-import-type": "node ./src/add-import-type.mjs",
     "test": "jest --coverage",
     "release": "dotenv -- release-it --only-version"
   },
   "devDependencies": {
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^28.1.6",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
+    "@release-it/conventional-changelog": "^5.1.0",
+    "@types/jest": "^28.1.7",
+    "@typescript-eslint/eslint-plugin": "^5.34.0",
+    "@typescript-eslint/parser": "^5.34.0",
     "dotenv-cli": "^6.0.0",
-    "eslint": "^8.21.0",
+    "eslint": "^8.22.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-node": "^0.3.6",
-    "eslint-import-resolver-typescript": "^3.3.0",
+    "eslint-import-resolver-typescript": "^3.5.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^26.7.0",
+    "eslint-plugin-jest": "^26.8.7",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-unicorn": "^43.0.2",
     "jest": "^28.1.3",
     "prettier": "^2.7.1",
-    "prettier-plugin-organize-imports": "^3.0.0",
-    "release-it": "^15.2.0",
-    "ts-jest": "^28.0.7",
+    "prettier-plugin-organize-imports": "^3.1.0",
+    "prettier-plugin-sh": "^0.12.8",
+    "release-it": "^15.3.0",
+    "ts-jest": "^28.0.8",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"
+  },
+  "engines": {
+    "node": "^14.18.1 || ^16.0.0"
   }
 }