properties-file 2.2.4 → 3.1.0

package/lib/property.d.ts

@@ -3,41 +3,57 @@ import { PropertyLine } from './property-line';
  * Object representing a property (key/value).
  */
 export declare class Property {
-    /** 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 content of one or multiple lines when applicable. */
+    linesContent: string;
     /** The property key (unescaped). */
     key: string;
+    /** The property key, including its escaped characters. */
+    escapedKey: string;
+    /** Is the key empty? */
+    private hasNoKey;
+    /** Does the key definition spread across multiple lines? */
+    private hasMultilineKey;
     /** 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;
+    /** Was the property's key used more than once? */
+    hasKeyCollisions: boolean;
+    /** The key/value pair separator */
+    separator: string | undefined;
+    /** The length of the key/value pair separator, including its whitespace characters. */
+    separatorLength: number | undefined;
+    /** The starting position of the key/value pair separator. */
+    separatorPosition: number | undefined;
     /** The property value (unescaped). */
     value: string;
-    /** Does the key definition spread across multiple lines? */
-    private hasMultilineKey;
-    /** Is the key empty? */
-    private hasNoKey;
+    /** The starting position of the value. */
+    valuePosition: number | undefined;
+    /** The property value, including its escaped characters. */
+    escapedValue: string;
     /** Is the value empty? */
     private hasNoValue;
+    /** Positions of the newline characters if any. */
+    newlinePositions: number[];
+    /** The line number at which the property starts. */
+    readonly startingLineNumber: number;
+    /** The line number at which the property ends. */
+    endingLineNumber: number;
+    /** The previous property object if it exists. */
+    readonly previousProperty?: Property;
+    /** The next property object if it exists. */
+    nextProperty?: Property;
     /**
      * Create a new property object.
      *
      * @param propertyLine - A property line object.
      * @param startingLineNumber - The line number at which the property starts.
      */
-    constructor(propertyLine: PropertyLine, startingLineNumber: number);
+    constructor(propertyLine: PropertyLine, startingLineNumber: number, previousProperty?: Property);
+    /**
+     * Set the next property object.
+     *
+     * @param property - The next property object
+     */
+    setNextProperty(property: Property): void;
     /**
      * Add the a line to a multiline property object.
      *
@@ -61,7 +77,7 @@ export declare class Property {
      */
     private unescapeLine;
     /**
-     * Find the delimiting characters separating the key from the value.
+     * Find the character separating the key from the value.
      */
-    private findDelimiter;
+    private findSeparator;
 }

package/lib/property.js

@@ -12,30 +12,41 @@ var Property = /** @class */ (function () {
      * @param propertyLine - A property line object.
      * @param startingLineNumber - The line number at which the property starts.
      */
-    function Property(propertyLine, startingLineNumber) {
-        /** 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;
+    function Property(propertyLine, startingLineNumber, previousProperty) {
         /** The property key (unescaped). */
         this.key = '';
+        /** The property key, including its escaped characters. */
+        this.escapedKey = '';
+        /** Is the key empty? */
+        this.hasNoKey = false;
+        /** Does the key definition spread across multiple lines? */
+        this.hasMultilineKey = false;
         /** Starting line numbers of property objects with the same key. */
         this.keyCollisionLines = [];
-        /** Positions of the newline characters if any. */
-        this.newlinePositions = [];
+        /** Was the property's key used more than once? */
+        this.hasKeyCollisions = false;
         /** The property value (unescaped). */
         this.value = '';
-        /** Does the key definition spread across multiple lines? */
-        this.hasMultilineKey = false;
-        /** Is the key empty? */
-        this.hasNoKey = false;
+        /** The property value, including its escaped characters. */
+        this.escapedValue = '';
         /** Is the value empty? */
         this.hasNoValue = false;
+        /** Positions of the newline characters if any. */
+        this.newlinePositions = [];
         this.linesContent = propertyLine.content;
         this.startingLineNumber = startingLineNumber;
+        this.endingLineNumber = startingLineNumber;
+        this.previousProperty = previousProperty;
+        previousProperty === null || previousProperty === void 0 ? void 0 : previousProperty.setNextProperty(this);
     }
+    /**
+     * Set the next property object.
+     *
+     * @param property - The next property object
+     */
+    Property.prototype.setNextProperty = function (property) {
+        this.nextProperty = property;
+    };
     /**
      * Add the a line to a multiline property object.
      *
@@ -44,6 +55,7 @@ var Property = /** @class */ (function () {
     Property.prototype.addLine = function (propertyLine) {
         if (this.linesContent.length > 0) {
             this.newlinePositions.push(this.linesContent.length);
+            this.endingLineNumber++;
         }
         this.linesContent += propertyLine.content;
     };
@@ -51,21 +63,21 @@ var Property = /** @class */ (function () {
      * Set the property's key and value.
      */
     Property.prototype.setKeyAndValue = function () {
-        this.findDelimiter();
-        if (this.delimiterPosition !== undefined && this.delimiterLength !== undefined) {
+        this.findSeparator();
+        if (this.separatorPosition !== undefined && this.separatorLength !== undefined) {
             // Set key if present.
             if (!this.hasNoKey) {
-                this.escapedKey = this.linesContent.slice(0, this.delimiterPosition);
+                this.escapedKey = this.linesContent.slice(0, this.separatorPosition);
                 this.key = this.unescapeLine(this.escapedKey, this.startingLineNumber);
             }
             // Set value if present.
             if (!this.hasNoValue) {
-                this.escapedValue = this.linesContent.slice(this.delimiterPosition + this.delimiterLength);
+                this.escapedValue = this.linesContent.slice(this.separatorPosition + this.separatorLength);
                 this.value = this.unescapeLine(this.escapedValue, this.startingLineNumber);
             }
         }
         else if (this.hasNoValue) {
-            // Set key if present (no delimiter).
+            // Set key if present (no separator).
             this.escapedKey = this.linesContent;
             this.key = this.unescapeLine(this.escapedKey, this.startingLineNumber);
         }
@@ -90,71 +102,68 @@ var Property = /** @class */ (function () {
         }
     };
     /**
-     * Find the delimiting characters separating the key from the value.
+     * Find the character separating the key from the value.
      */
-    Property.prototype.findDelimiter = function () {
+    Property.prototype.findSeparator = function () {
         var _a, _b;
-        // If the delimiter was already found, skip.
-        if (this.hasNoKey || this.hasNoValue || this.delimiterPosition) {
+        // If the separator was already found, skip.
+        if (this.hasNoKey || this.hasNoValue || this.separatorPosition) {
             return;
         }
         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 the character is not a separator, check the next one.
             if (!/[\t\f :=]/.test(character)) {
                 continue;
             }
-            // Check if the delimiter might be escaped.
+            // Check if the separator might be escaped.
             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);
-                    if (delimiterIsEscaped) {
-                        // If the delimiter is escaped, check the next character.
+                    var separatorIsEscaped = !!(backslashMatch.groups.backslashes.length % 2);
+                    if (separatorIsEscaped) {
+                        // If the separator is escaped, check the next character.
                         continue;
                     }
                 }
             }
-            var delimiter = '';
-            this.delimiterPosition = position;
-            this.hasMultilineKey = !!(this.newlinePositions.length > 0 && this.newlinePositions[0] > position);
-            // Check if the delimiter starts with a whitespace.
+            var separator = '';
+            this.separatorPosition = position;
+            // Check if the separator starts with a whitespace.
             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 > 0) {
-                delimiter += leadingWhitespace;
+                separator += leadingWhitespace;
                 nextContent = nextContent.slice(leadingWhitespace.length);
             }
             // Check if there is an equal or colon character.
             if (/[:=]/.test(nextContent[0])) {
-                delimiter += nextContent[0];
+                separator += nextContent[0];
                 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) || '';
-                delimiter += trailingWhitespace;
+                separator += trailingWhitespace;
             }
-            this.delimiterLength = delimiter.length;
-            // If the line starts with a delimiter, the property has no key.
+            this.separatorLength = separator.length;
+            this.valuePosition = this.separatorPosition + this.separatorLength;
+            this.separator = this.linesContent.slice(this.separatorPosition, this.separatorPosition + this.separatorLength);
+            // If the line starts with a separator, the property has no key.
             if (!position) {
                 this.hasNoKey = true;
             }
             break;
         }
-        // If there was no delimiter found, the property has no value.
-        if (this.delimiterPosition === undefined) {
+        if (this.separatorPosition === undefined) {
+            // If there was no separator found, the property has no value.
             this.hasNoValue = true;
         }
-        else {
-            // If the delimiter is after the first newline, mark the key as multiline.
-            if (this.newlinePositions.length > 0) {
-                var firstLinePosition = this.newlinePositions[0];
-                if (firstLinePosition > this.delimiterPosition) {
-                    this.hasMultilineKey = true;
-                }
-            }
+        else if (this.newlinePositions.length > 0 &&
+            this.newlinePositions[0] < this.separatorPosition) {
+            // If the separator is after the first newline, the key is on multiple lines.
+            this.hasMultilineKey = true;
         }
     };
     return Property;

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "properties-file",
-  "version": "2.2.4",
-  "description": ".properties file parser, JSON converter and Webpack loader.",
+  "version": "3.1.0",
+  "description": ".properties file parser, editor, formatter and Webpack loader.",
   "keywords": [
     ".properties",
     "properties",
     ".properties file",
     "properties file",
     "parser",
+    "editor",
+    "formatter",
     "Java",
     "intl",
     "i18n",
@@ -23,7 +25,7 @@
   "author": "Avansai (https://avansai.com)",
   "exports": {
     ".": "./lib/index.js",
-    "./content": "./lib/content/index.js",
+    "./editor": "./lib/editor/index.js",
     "./escape": "./lib/escape/index.js",
     "./unescape": "./lib/unescape/index.js",
     "./webpack-loader": "./lib/loader/webpack.js"
@@ -32,8 +34,8 @@
   "types": "lib/index.d.ts",
   "typesVersions": {
     "*": {
-      "content": [
-        "lib/content/index.d.ts"
+      "editor": [
+        "lib/editor/index.d.ts"
       ],
       "escape": [
         "lib/escape/index.d.ts"
@@ -50,9 +52,9 @@
     "lib"
   ],
   "scripts": {
-    "add-import-type": "node ./src/add-import-type.mjs",
+    "add-import-type": "ts-node ./src/add-import-type.ts && rm -f ./lib/add-import-type.*",
     "build": "npm run prettier && npm run lint-fix && rm -Rf ./lib && tsc && npm run add-import-type && npm run test",
-    "ci": "npm run lint-check && rm -Rf ./lib && tsc && npm run add-import-type && npm run test",
+    "ci": "npm run build",
     "lint-check": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx --ext .json .",
     "lint-fix": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx --ext .json --fix .",
     "lint-print-config": "eslint --print-config ./eslintrc.yaml",
@@ -62,11 +64,11 @@
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "5.1.1",
-    "@types/jest": "29.5.0",
-    "@typescript-eslint/eslint-plugin": "5.58.0",
-    "@typescript-eslint/parser": "5.58.0",
+    "@types/jest": "29.5.1",
+    "@typescript-eslint/eslint-plugin": "5.59.1",
+    "@typescript-eslint/parser": "5.59.1",
     "dotenv-cli": "7.2.1",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-import-resolver-node": "0.3.7",
     "eslint-import-resolver-typescript": "3.5.5",
@@ -78,7 +80,7 @@
     "eslint-plugin-tsdoc": "0.2.17",
     "eslint-plugin-unicorn": "46.0.0",
     "jest": "29.5.0",
-    "prettier": "2.8.7",
+    "prettier": "2.8.8",
     "prettier-plugin-organize-imports": "3.2.2",
     "prettier-plugin-sh": "0.12.8",
     "release-it": "15.10.1",

package/lib/content/index.d.ts

@@ -1,18 +0,0 @@
-import { KeyValueObject } from '../';
-import { Properties } from '../properties';
-/**
- * Get a `Properties` object from the content of a `.properties` file.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A `Properties` object representing the content of a `.properties` file.
- */
-export declare const getProperties: (content: string) => Properties;
-/**
- * Converts the content of a `.properties` file to JSON.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A (JSON) key/value object representing the content of a `.properties` file.
- */
-export declare const propertiesToJson: (content: string) => KeyValueObject;

package/lib/content/index.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.propertiesToJson = exports.getProperties = void 0;
-var properties_1 = require("../properties");
-var property_1 = require("../property");
-var property_line_1 = require("../property-line");
-/**
- * Get a `Properties` object from the content of a `.properties` file.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A `Properties` object representing the content of a `.properties` file.
- */
-var getProperties = function (content) {
-    // Remove BOM character if present and create an array from lines.
-    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. */
-    var property;
-    /** The collection of property objects. */
-    var properties = new properties_1.Properties();
-    for (var _i = 0, lines_1 = lines; _i < lines_1.length; _i++) {
-        var line = lines_1[_i];
-        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);
-            if (propertyLine.isContinuing) {
-                continue; // Continue parsing the next line.
-            }
-        }
-        // If the line does not continue, add the property to the collection.
-        property = properties.add(property);
-    }
-    return properties;
-};
-exports.getProperties = getProperties;
-/**
- * Converts the content of a `.properties` file to JSON.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A (JSON) key/value object representing the content of a `.properties` file.
- */
-var propertiesToJson = function (content) { return (0, exports.getProperties)(content).toJson(); };
-exports.propertiesToJson = propertiesToJson;

package/lib/file/index.d.ts

@@ -1,21 +0,0 @@
-/// <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 const 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 const propertiesToJson: (filePath: string, encoding?: BufferEncoding) => KeyValueObject;

package/lib/file/index.js

@@ -1,30 +0,0 @@
-"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.
- */
-var getProperties = function (filePath, encoding) {
-    // No need to check if the file exists first since this will already throw an error.
-    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.
- */
-var propertiesToJson = function (filePath, encoding) {
-    return (0, exports.getProperties)(filePath, encoding).toJson();
-};
-exports.propertiesToJson = propertiesToJson;