properties-file 3.3.18 → 3.4.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Avansai
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Avansai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,281 +1,281 @@
-# properties-file
-
-[![License](https://img.shields.io/npm/l/make-coverage-badge.svg?color=brightgreen)](https://opensource.org/licenses/MIT)
-[![npm download](https://img.shields.io/npm/dw/properties-file.svg?color=brightgreen)](https://www.npmjs.com/package/properties-file)
-![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg)
-![Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)
-
-`.properties` file parser, editor, formatter and Webpack loader.
-
-## Installation 💻
-
-> ⚠ In April 2023, we released version 3 of this package, which includes breaking changes. Please refer to the [upgrade guide](./V2-TO-V3-UPGRADE-GUIDE.md) before upgrading.
-
-Add the package as a dependency:
-
-```
-npm install properties-file
-```
-
-## What's in it for me? 🤔
-
-- A modern library written entirely in TypeScript that exactly reproduces the [Properties Java implementation](/assets/java-implementation.md).
-- Works for both Node.js applications and browsers that support at least [ES5](https://www.w3schools.com/js/js_es5.asp).
-- Flexible APIs:
-  - `getProperties` converts the content of `.properties` files to a key-value pair object.
-  - A `Properties` class provides insights into parsing data.
-  - A `PropertiesEditor` class enables the addition, edition, and removal of entries.
-  - `escapeKey` and `escapeValue` allow the conversion of any content to a `.properties` compatible format.
-  - The library also includes a Webpack loader to import `.properties` files directly into your application.
-- Tiny ([under 4kB compressed](https://bundlephobia.com/package/properties-file)) with 0 dependencies.
-- 100% test coverage based on the output from a Java implementation.
-- Active maintenance (many popular `.properties` packages have been inactive for years).
-
-## Usage 🎬
-
-We have put a lot of effort into incorporating [TSDoc](https://tsdoc.org/) into all our APIs. If you are unsure about how to use certain APIs provided in our examples, please check directly in your IDE.
-
-### `getProperties` (converting `.properties` to an object)
-
-The most common use case for `.properties` files is for Node.js applications that need to read the file's content into a simple key-value pair object. Here is how this can be done with a single API call:
-
-```ts
-import { readFileSync } from 'node:fs'
-import { getProperties } from 'properties-file'
-
-console.log(getProperties(readFileSync('hello-world.properties')))
-```
-
-Output:
-
-```js
-{ hello: 'hello', world: 'world' }
-```
-
-### `Properties` (using parsing metadata)
-
-The `Properties` object is what makes `getProperties` work under the hood, but when using it directly, you can access granular parsing metadata. Here is an example of how the object can be used to find key collisions:
-
-```ts
-import { Properties } from 'properties-file'
-
-const properties = new Properties(
-  'hello = hello1\nworld = world1\nworld = world2\nhello = hello2\nworld = world3'
-)
-console.log(properties.format())
-
-/**
- * Outputs:
- *
- * hello = hello1
- * world = world1
- * world = world2
- * hello = hello2
- * world = world3
- */
-
-properties.collection.forEach((property) => {
-  console.log(`${property.key} = ${property.value}`)
-})
-
-/**
- * Outputs:
- *
- * hello = hello2
- * world = world3
- */
-
-const keyCollisions = properties.getKeyCollisions()
-
-keyCollisions.forEach((keyCollision) => {
-  console.warn(
-    `Found a key collision for key '${
-      keyCollision.key
-    }' on lines ${keyCollision.startingLineNumbers.join(
-      ', '
-    )} (will use the value at line ${keyCollision.getApplicableLineNumber()}).`
-  )
-})
-
-/**
- * Outputs:
- *
- * Found a key collision for key 'hello' on lines 1, 4 (will use the value at line 4).
- * Found a key collision for key 'world' on lines 2, 3, 5 (will use the value at line 5).
- */
-```
-
-For purposes where you require more parsing metadata, such as building a syntax highlighter, it is recommended that you access the `Property` objects included in the `Properties.collection`. These objects provide comprehensive information about each key-value pair.
-
-### `PropertiesEditor` (editing `.properties` content)
-
-In certain scenarios, it may be necessary to modify the content of the `.properties` key-value pair objects. This can be achieved easily using the `Properties` object, with the assistance of the `escapeKey` and `escapeValue` APIs, as demonstrated below:
-
-```ts
-import { Properties } from 'properties-file'
-import { escapeKey, escapeValue } from 'properties-file/escape'
-
-const properties = new Properties('hello = hello\n# This is a comment\nworld = world')
-const newProperties: string[] = []
-
-properties.collection.forEach((property) => {
-  const key = property.key === 'world' ? 'new world' : property.key
-  const value = property.value === 'world' ? 'new world' : property.value
-  newProperties.push(`${escapeKey(key)} = ${escapeValue(value)}`)
-})
-
-console.log(newProperties.join('\n'))
-
-/**
- * Outputs:
- *
- * hello = hello
- * new\ world = new world
- */
-```
-
-The limitation of this approach is that its output contains only valid keys, without any comments or whitespace. However, if you require a more advanced editor that preserves these original elements, then the `PropertiesEditor` object is exactly what you need.
-
-```ts
-import { PropertiesEditor } from 'properties-file/editor'
-
-const properties = new PropertiesEditor('hello = hello\n# This is a comment\nworld = world')
-console.log(properties.format())
-
-/**
- * Outputs:
- *
- * hello = hello
- * # This is a comment
- * world = world
- */
-
-properties.insertComment('This is a multiline\ncomment before `newKey3`')
-properties.insert('newKey3', 'This is my third key')
-
-properties.insert('newKey1', 'This is my first new key', {
-  referenceKey: 'newKey3',
-  position: 'before',
-  comment: 'Below are the new keys being edited',
-  commentDelimiter: '!',
-})
-
-properties.insert('newKey2', 'こんにちは', {
-  referenceKey: 'newKey1',
-  position: 'after',
-  escapeUnicode: true,
-})
-
-properties.delete('hello')
-properties.update('world', {
-  newValue: 'new world',
-})
-console.log(properties.format())
-
-/**
- * Outputs:
- *
- * # This is a comment
- * world = new world
- * ! Below are the new keys being edited
- * newKey1 = This is my first new key
- * newKey2 = \u3053\u3093\u306b\u3061\u306f
- * # This is a multiline
- * # comment before `newKey3`
- * newKey3 = This is my third key
- */
-```
-
-For convenience, we also added an `upsert` method that allows updating a key if it exists or adding it at the end, when it doesn't. Make sure to check in your IDE for all available methods and options in our TSDoc.
-
-### Webpack File Loader
-
-If you would like to import `.properties` directly using `import`, this package comes with its own Webpack file loader located under `properties-file/webpack-loader`. Here is an example of how to configure it:
-
-```js
-// webpack.config.js
-module.exports = {
-  module: {
-    rules: [
-      {
-        test: /\.properties$/i,
-        use: [
-          {
-            loader: 'properties-file/webpack-loader',
-          },
-        ],
-      },
-    ],
-  },
-}
-```
-
-As soon as you configure Webpack, the `.properties` type should be available in your IDE when using `import`. If you ever need to add it manually, you can add a `*.properties` type declaration file at the root of your application, like this:
-
-```js
-// properties-file.d.ts
-declare module '*.properties' {
-  const properties: { readonly [key: string]: string };
-  export default properties;
-}
-```
-
-By adding these configurations you should now be able to import directly `.properties` files just like this:
-
-```ts
-import helloWorld from './hello-world.properties'
-
-console.dir(helloWorld)
-```
-
-Output:
-
-```json
-{ "hello": "world" }
-```
-
-## Why another `.properties` file package?
-
-There are probably over 20 similar packages available, but:
-
-- Many of the most popular packages have had no activity for over 5 years.
-- Most packages will not replicate the current Java implementation.
-- No package offers the same capabilities as this one.
-
-Unfortunately, the `.properties` file specification is not well-documented. One reason for this is that it was originally used in Java to store configurations. Today, most applications handle this using JSON, YAML, or other modern formats because these formats are more flexible.
-
-### So why `.properties` files?
-
-While many options exist today to handle configurations, `.properties` files remain one of the best options to store localizable strings (also known as messages). On the Java side, `PropertyResourceBundle` is how most implementations handle localization today. Because of its simplicity and maturity, `.properties` files remain one of the best options today when it comes to internationalization (i18n):
-
-| File format   | Key/value based  | Supports inline comments | Built for localization | Good linguistic tools support |
-| ------------- | ---------------- | ------------------------ | ---------------------- | ----------------------------- |
-| `.properties` | Yes              | Yes                      | Yes (Resource Bundles) | Yes                           |
-| `JSON`        | No (can do more) | No (requires JSON5)      | No                     | Depends on the schema         |
-| `YAML`        | No (can do more) | Yes                      | No                     | Depends on the schema         |
-
-Having good JavaScript/TypeScript support for `.properties` files offers more internationalization (i18n) options.
-
-### How does this package work?
-
-Basically, our goal was to offer parity with the Java implementation, which is the closest thing to a specification for `.properties` files. Here is the logic behind this package in a nutshell:
-
-1. The content is split by lines, creating an array of strings where each line is an element.
-2. All lines are parsed to create a collection of `Property` objects that:
-   1. Identify key-value pair lines from the other lines (e.g., comments, blank lines, etc.).
-   2. Merge back multiline key-value pairs on single lines by removing trailing backslashes.
-   3. Unescape the keys and values.
-
-Just like Java, if a Unicode-escaped character (`\u`) is malformed, an error will be thrown. However, we do not recommend using Unicode-escaped characters, but rather using UTF-8 encoding that supports more characters.
-
-## Additional references
-
-- Java [Test Sandbox](https://codehs.com/sandbox/id/java-main-FObePj)
-- Java's `Properties` class [documentation](https://docs.oracle.com/javase/9/docs/api/java/util/Properties.html)
-- Java's `PropertyResourceBundle` [documentation](https://docs.oracle.com/javase/9/docs/api/java/util/PropertyResourceBundle.html)
-- Java's Internationalization [Guide](https://docs.oracle.com/en/java/javase/18/intl/internationalization-overview.html)
-- Wikipedia's .properties [page](https://en.wikipedia.org/wiki/.properties)
-
-### Special mention
-
-Thanks to [@calibr](https://github.com/calibr), the creator of [properties-file version 1.0](https://github.com/calibr/properties-file), for letting us use the [https://www.npmjs.com/package/properties-file](https://www.npmjs.com/package/properties-file) package name. We hope that it will make it easier to find our package.
+# properties-file
+
+[![License](https://img.shields.io/npm/l/make-coverage-badge.svg?color=brightgreen)](https://opensource.org/licenses/MIT)
+[![npm download](https://img.shields.io/npm/dw/properties-file.svg?color=brightgreen)](https://www.npmjs.com/package/properties-file)
+![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg)
+![Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)
+
+`.properties` file parser, editor, formatter and Webpack loader.
+
+## Installation 💻
+
+> ⚠ In April 2023, we released version 3 of this package, which includes breaking changes. Please refer to the [upgrade guide](./V2-TO-V3-UPGRADE-GUIDE.md) before upgrading.
+
+Add the package as a dependency:
+
+```
+npm install properties-file
+```
+
+## What's in it for me? 🤔
+
+- A modern library written entirely in TypeScript that exactly reproduces the [Properties Java implementation](/assets/java-implementation.md).
+- Works for both Node.js applications and browsers that support at least [ES5](https://www.w3schools.com/js/js_es5.asp).
+- Flexible APIs:
+  - `getProperties` converts the content of `.properties` files to a key-value pair object.
+  - A `Properties` class provides insights into parsing data.
+  - A `PropertiesEditor` class enables the addition, edition, and removal of entries.
+  - `escapeKey` and `escapeValue` allow the conversion of any content to a `.properties` compatible format.
+  - The library also includes a Webpack loader to import `.properties` files directly into your application.
+- Tiny ([under 4kB compressed](https://bundlephobia.com/package/properties-file)) with 0 dependencies.
+- 100% test coverage based on the output from a Java implementation.
+- Active maintenance (many popular `.properties` packages have been inactive for years).
+
+## Usage 🎬
+
+We have put a lot of effort into incorporating [TSDoc](https://tsdoc.org/) into all our APIs. If you are unsure about how to use certain APIs provided in our examples, please check directly in your IDE.
+
+### `getProperties` (converting `.properties` to an object)
+
+The most common use case for `.properties` files is for Node.js applications that need to read the file's content into a simple key-value pair object. Here is how this can be done with a single API call:
+
+```ts
+import { readFileSync } from 'node:fs'
+import { getProperties } from 'properties-file'
+
+console.log(getProperties(readFileSync('hello-world.properties')))
+```
+
+Output:
+
+```js
+{ hello: 'hello', world: 'world' }
+```
+
+### `Properties` (using parsing metadata)
+
+The `Properties` object is what makes `getProperties` work under the hood, but when using it directly, you can access granular parsing metadata. Here is an example of how the object can be used to find key collisions:
+
+```ts
+import { Properties } from 'properties-file'
+
+const properties = new Properties(
+  'hello = hello1\nworld = world1\nworld = world2\nhello = hello2\nworld = world3'
+)
+console.log(properties.format())
+
+/**
+ * Outputs:
+ *
+ * hello = hello1
+ * world = world1
+ * world = world2
+ * hello = hello2
+ * world = world3
+ */
+
+properties.collection.forEach((property) => {
+  console.log(`${property.key} = ${property.value}`)
+})
+
+/**
+ * Outputs:
+ *
+ * hello = hello2
+ * world = world3
+ */
+
+const keyCollisions = properties.getKeyCollisions()
+
+keyCollisions.forEach((keyCollision) => {
+  console.warn(
+    `Found a key collision for key '${
+      keyCollision.key
+    }' on lines ${keyCollision.startingLineNumbers.join(
+      ', '
+    )} (will use the value at line ${keyCollision.getApplicableLineNumber()}).`
+  )
+})
+
+/**
+ * Outputs:
+ *
+ * Found a key collision for key 'hello' on lines 1, 4 (will use the value at line 4).
+ * Found a key collision for key 'world' on lines 2, 3, 5 (will use the value at line 5).
+ */
+```
+
+For purposes where you require more parsing metadata, such as building a syntax highlighter, it is recommended that you access the `Property` objects included in the `Properties.collection`. These objects provide comprehensive information about each key-value pair.
+
+### `PropertiesEditor` (editing `.properties` content)
+
+In certain scenarios, it may be necessary to modify the content of the `.properties` key-value pair objects. This can be achieved easily using the `Properties` object, with the assistance of the `escapeKey` and `escapeValue` APIs, as demonstrated below:
+
+```ts
+import { Properties } from 'properties-file'
+import { escapeKey, escapeValue } from 'properties-file/escape'
+
+const properties = new Properties('hello = hello\n# This is a comment\nworld = world')
+const newProperties: string[] = []
+
+properties.collection.forEach((property) => {
+  const key = property.key === 'world' ? 'new world' : property.key
+  const value = property.value === 'world' ? 'new world' : property.value
+  newProperties.push(`${escapeKey(key)} = ${escapeValue(value)}`)
+})
+
+console.log(newProperties.join('\n'))
+
+/**
+ * Outputs:
+ *
+ * hello = hello
+ * new\ world = new world
+ */
+```
+
+The limitation of this approach is that its output contains only valid keys, without any comments or whitespace. However, if you require a more advanced editor that preserves these original elements, then the `PropertiesEditor` object is exactly what you need.
+
+```ts
+import { PropertiesEditor } from 'properties-file/editor'
+
+const properties = new PropertiesEditor('hello = hello\n# This is a comment\nworld = world')
+console.log(properties.format())
+
+/**
+ * Outputs:
+ *
+ * hello = hello
+ * # This is a comment
+ * world = world
+ */
+
+properties.insertComment('This is a multiline\ncomment before `newKey3`')
+properties.insert('newKey3', 'This is my third key')
+
+properties.insert('newKey1', 'This is my first new key', {
+  referenceKey: 'newKey3',
+  position: 'before',
+  comment: 'Below are the new keys being edited',
+  commentDelimiter: '!',
+})
+
+properties.insert('newKey2', 'こんにちは', {
+  referenceKey: 'newKey1',
+  position: 'after',
+  escapeUnicode: true,
+})
+
+properties.delete('hello')
+properties.update('world', {
+  newValue: 'new world',
+})
+console.log(properties.format())
+
+/**
+ * Outputs:
+ *
+ * # This is a comment
+ * world = new world
+ * ! Below are the new keys being edited
+ * newKey1 = This is my first new key
+ * newKey2 = \u3053\u3093\u306b\u3061\u306f
+ * # This is a multiline
+ * # comment before `newKey3`
+ * newKey3 = This is my third key
+ */
+```
+
+For convenience, we also added an `upsert` method that allows updating a key if it exists or adding it at the end, when it doesn't. Make sure to check in your IDE for all available methods and options in our TSDoc.
+
+### Webpack File Loader
+
+If you would like to import `.properties` directly using `import`, this package comes with its own Webpack file loader located under `properties-file/webpack-loader`. Here is an example of how to configure it:
+
+```js
+// webpack.config.js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.properties$/i,
+        use: [
+          {
+            loader: 'properties-file/webpack-loader',
+          },
+        ],
+      },
+    ],
+  },
+}
+```
+
+As soon as you configure Webpack, the `.properties` type should be available in your IDE when using `import`. If you ever need to add it manually, you can add a `*.properties` type declaration file at the root of your application, like this:
+
+```js
+// properties-file.d.ts
+declare module '*.properties' {
+  const properties: { readonly [key: string]: string };
+  export default properties;
+}
+```
+
+By adding these configurations you should now be able to import directly `.properties` files just like this:
+
+```ts
+import helloWorld from './hello-world.properties'
+
+console.dir(helloWorld)
+```
+
+Output:
+
+```json
+{ "hello": "world" }
+```
+
+## Why another `.properties` file package?
+
+There are probably over 20 similar packages available, but:
+
+- Many of the most popular packages have had no activity for over 5 years.
+- Most packages will not replicate the current Java implementation.
+- No package offers the same capabilities as this one.
+
+Unfortunately, the `.properties` file specification is not well-documented. One reason for this is that it was originally used in Java to store configurations. Today, most applications handle this using JSON, YAML, or other modern formats because these formats are more flexible.
+
+### So why `.properties` files?
+
+While many options exist today to handle configurations, `.properties` files remain one of the best options to store localizable strings (also known as messages). On the Java side, `PropertyResourceBundle` is how most implementations handle localization today. Because of its simplicity and maturity, `.properties` files remain one of the best options today when it comes to internationalization (i18n):
+
+| File format   | Key/value based  | Supports inline comments | Built for localization | Good linguistic tools support |
+| ------------- | ---------------- | ------------------------ | ---------------------- | ----------------------------- |
+| `.properties` | Yes              | Yes                      | Yes (Resource Bundles) | Yes                           |
+| `JSON`        | No (can do more) | No (requires JSON5)      | No                     | Depends on the schema         |
+| `YAML`        | No (can do more) | Yes                      | No                     | Depends on the schema         |
+
+Having good JavaScript/TypeScript support for `.properties` files offers more internationalization (i18n) options.
+
+### How does this package work?
+
+Basically, our goal was to offer parity with the Java implementation, which is the closest thing to a specification for `.properties` files. Here is the logic behind this package in a nutshell:
+
+1. The content is split by lines, creating an array of strings where each line is an element.
+2. All lines are parsed to create a collection of `Property` objects that:
+   1. Identify key-value pair lines from the other lines (e.g., comments, blank lines, etc.).
+   2. Merge back multiline key-value pairs on single lines by removing trailing backslashes.
+   3. Unescape the keys and values.
+
+Just like Java, if a Unicode-escaped character (`\u`) is malformed, an error will be thrown. However, we do not recommend using Unicode-escaped characters, but rather using UTF-8 encoding that supports more characters.
+
+## Additional references
+
+- Java [Test Sandbox](https://codehs.com/sandbox/id/java-main-FObePj)
+- Java's `Properties` class [documentation](https://docs.oracle.com/javase/9/docs/api/java/util/Properties.html)
+- Java's `PropertyResourceBundle` [documentation](https://docs.oracle.com/javase/9/docs/api/java/util/PropertyResourceBundle.html)
+- Java's Internationalization [Guide](https://docs.oracle.com/en/java/javase/18/intl/internationalization-overview.html)
+- Wikipedia's .properties [page](https://en.wikipedia.org/wiki/.properties)
+
+### Special mention
+
+Thanks to [@calibr](https://github.com/calibr), the creator of [properties-file version 1.0](https://github.com/calibr/properties-file), for letting us use the [https://www.npmjs.com/package/properties-file](https://www.npmjs.com/package/properties-file) package name. We hope that it will make it easier to find our package.

package/lib/cjs/editor/index.js

@@ -0,0 +1 @@
+"use strict";var __extends=this&&this.__extends||function(){var e=function(r,n){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,r){e.__proto__=r}||function(e,r){for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])},e(r,n)};return function(r,n){if("function"!=typeof n&&null!==n)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");function t(){this.constructor=r}e(r,n),r.prototype=null===n?Object.create(n):(t.prototype=n.prototype,new t)}}(),__read=this&&this.__read||function(e,r){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var t,i,o=n.call(e),s=[];try{for(;(void 0===r||r-- >0)&&!(t=o.next()).done;)s.push(t.value)}catch(e){i={error:e}}finally{try{t&&!t.done&&(n=o.return)&&n.call(o)}finally{if(i)throw i.error}}return s},__spreadArray=this&&this.__spreadArray||function(e,r,n){if(n||2===arguments.length)for(var t,i=0,o=r.length;i<o;i++)!t&&i in r||(t||(t=Array.prototype.slice.call(r,0,i)),t[i]=r[i]);return e.concat(t||Array.prototype.slice.call(r))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.PropertiesEditor=exports.DEFAULT_COMMENT_DELIMITER=exports.DEFAULT_SEPARATOR=void 0;var escape_1=require("../escape"),properties_1=require("../properties");exports.DEFAULT_SEPARATOR="=",exports.DEFAULT_COMMENT_DELIMITER="#";var PropertiesEditor=function(e){function r(r){var n=e.call(this,r)||this;return n.needsLineParsing=!1,n}return __extends(r,e),r.prototype.parseLinesIfNeeded=function(){this.needsLineParsing&&(this.parseLines(),this.needsLineParsing=!1)},r.prototype.insert=function(e,r,n){var t,i,o,s=(null==n?void 0:n.escapeUnicode)||!1,a=(null==n?void 0:n.separator)?" "===n.separator?" ":" ".concat(n.separator," "):" ".concat(exports.DEFAULT_SEPARATOR," ").replace("  "," "),c=null==n?void 0:n.referenceKey,l=(null==n?void 0:n.position)||"after";c&&this.parseLinesIfNeeded();var p=e.split(/\r?\n/).map((function(e){return(0,escape_1.escapeKey)(e,s)})).join("\\\n"),d=r.split(/\r?\n/).map((function(e){return(0,escape_1.escapeValue)(e,s)})).join("\\\n"),u="".concat((null==n?void 0:n.commentDelimiter)||exports.DEFAULT_COMMENT_DELIMITER," "),_=void 0===(null==n?void 0:n.comment)?"":"".concat("".concat(u).concat(n.comment).split(/\r?\n/).join("\n".concat(u)),"\n"),v="".concat(_).concat(p).concat(a).concat(d).split(/\n/);if(void 0===c)return(t=this.lines).push.apply(t,__spreadArray([],__read(v),!1)),this.needsLineParsing=!0,!0;var y=__spreadArray([],__read(this.collection),!1).reverse().find((function(e){return e.key===c}));if(y){var f="after"===l?y.endingLineNumber:null!==(o=null===(i=y.previousProperty)||void 0===i?void 0:i.endingLineNumber)&&void 0!==o?o:0;return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,f)),!1),__read(v),!1),__read(this.lines.slice(f)),!1),this.needsLineParsing=!0,!0}return!1},r.prototype.insertComment=function(e,r){var n,t,i,o=null==r?void 0:r.referenceKey,s=(null==r?void 0:r.position)||"after";o&&this.parseLinesIfNeeded();var a="".concat((null==r?void 0:r.commentDelimiter)||exports.DEFAULT_COMMENT_DELIMITER," "),c="".concat(a).concat(e).replace(/\r?\n/g,"\n".concat(a)).split(/\n/);if(void 0===o)return(n=this.lines).push.apply(n,__spreadArray([],__read(c),!1)),this.needsLineParsing=!0,!0;var l=__spreadArray([],__read(this.collection),!1).reverse().find((function(e){return e.key===o}));if(l){var p="after"===s?l.endingLineNumber:null!==(i=null===(t=l.previousProperty)||void 0===t?void 0:t.endingLineNumber)&&void 0!==i?i:0;return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,p)),!1),__read(c),!1),__read(this.lines.slice(p)),!1),this.needsLineParsing=!0,!0}return!1},r.prototype.delete=function(e,r){var n,t;void 0===r&&(r=!0),this.parseLinesIfNeeded();var i=__spreadArray([],__read(this.collection),!1).reverse().find((function(r){return r.key===e}));if(i){var o=r?null!==(t=null===(n=i.previousProperty)||void 0===n?void 0:n.endingLineNumber)&&void 0!==t?t:0:i.startingLineNumber-1,s=i.endingLineNumber;return this.lines=__spreadArray(__spreadArray([],__read(this.lines.slice(0,o)),!1),__read(this.lines.slice(s)),!1),this.needsLineParsing=!0,!0}return!1},r.prototype.getKeyWithNewlines=function(e){return 0===e.newlinePositions.length?e.key:__spreadArray([],__read(e.key),!1).reduce((function(r,n,t){return"".concat(r).concat(e.newlinePositions.includes(t)?"\n":"").concat(n)}),"")},r.prototype.getValueWithNewlines=function(e){return 0===e.newlinePositions.length||void 0===e.valuePosition?e.value:__spreadArray([],__read(e.value),!1).reduce((function(r,n,t){return"".concat(r).concat(e.newlinePositions.includes(t+e.valuePosition)?"\n":"").concat(n)}),"")},r.prototype.update=function(e,r){var n,t,i,o;this.parseLinesIfNeeded();var s=__spreadArray([],__read(this.collection),!1).reverse().find((function(r){return r.key===e}));if(!s||!r)return!1;var a=r.escapeUnicode||!1,c=r.separator?" "===r.separator?" ":" ".concat(r.separator," "):s.separator||" ".concat(exports.DEFAULT_SEPARATOR," ").replace("  "," "),l=(null!==(n=r.newKey)&&void 0!==n?n:this.getKeyWithNewlines(s)).split(/\r?\n/).map((function(e){return(0,escape_1.escapeKey)(e,a)})).join("\\\n"),p=(null!==(t=r.newValue)&&void 0!==t?t:this.getValueWithNewlines(s)).split(/\r?\n/).map((function(e){return(0,escape_1.escapeValue)(e,a)})).join("\\\n"),d="".concat(r.commentDelimiter||exports.DEFAULT_COMMENT_DELIMITER," "),u=void 0===r.newComment?"":"".concat("".concat(d).concat(r.newComment).split(/\r?\n/).join("\n".concat(d)),"\n"),_="".concat(u).concat(l).concat(c).concat(p).split(/\n/);return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,void 0===r.newComment?s.startingLineNumber-1:null!==(o=null===(i=s.previousProperty)||void 0===i?void 0:i.endingLineNumber)&&void 0!==o?o:0)),!1),__read(_),!1),__read(this.lines.slice(s.endingLineNumber)),!1),this.needsLineParsing=!0,!0},r.prototype.upsert=function(e,r,n){return this.parseLinesIfNeeded(),this.keyLineNumbers[e]?this.update(e,{newValue:r,newComment:null==n?void 0:n.comment,commentDelimiter:null==n?void 0:n.commentDelimiter,separator:null==n?void 0:n.separator,escapeUnicode:null==n?void 0:n.escapeUnicode}):this.insert(e,r,n)},r}(properties_1.Properties);exports.PropertiesEditor=PropertiesEditor;

package/lib/{escape → cjs/escape}/index.d.ts

@@ -4,7 +4,7 @@
  * @param unescapedKey - A property key to be escaped.
  * @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
  *
- * @return The escaped key.
+ * @returns The escaped key.
  */
 export declare const escapeKey: (unescapedKey: string, escapeUnicode?: boolean) => string;
 /**
@@ -13,6 +13,6 @@ export declare const escapeKey: (unescapedKey: string, escapeUnicode?: boolean)
  * @param unescapedValue - Property value to be escaped.
  * @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
  *
- * @return The escaped value.
+ * @returns The escaped value.
  */
 export declare const escapeValue: (unescapedValue: string, escapeUnicode?: boolean) => string;

package/lib/cjs/escape/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.escapeValue=exports.escapeKey=void 0;var escapeKey=function(e,t){return void 0===t&&(t=!1),escapeContent(e,!0,t)};exports.escapeKey=escapeKey;var escapeValue=function(e,t){return void 0===t&&(t=!1),escapeContent(e,!1,t)};exports.escapeValue=escapeValue;var escapeContent=function(e,t,r){return e.replace(new RegExp("[\\s!#:=\\\\".concat(r?"\\u0000-\\u001F\\u007F-\\uFFFF":"","]"),"g"),(function(e,r){switch(e){case" ":return t||0===r?"\\ ":" ";case"\\":return"\\\\";case"\f":return"\\f";case"\n":return"\\n";case"\r":return"\\r";case"\t":return"\\t";case"=":case":":case"#":case"!":return"\\".concat(e);default:return"\\u".concat(e.codePointAt(0).toString(16).padStart(4,"0"))}}))};

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getProperties=exports.Properties=void 0;var properties_1=require("./properties"),properties_2=require("./properties");Object.defineProperty(exports,"Properties",{enumerable:!0,get:function(){return properties_2.Properties}});var getProperties=function(e){return new properties_1.Properties(e).toObject()};exports.getProperties=getProperties;

package/lib/cjs/loader/webpack.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var __1=require(".."),webpackLoader=function(e){return"module.exports = ".concat(JSON.stringify((0,__1.getProperties)(e)),";")};exports.default=webpackLoader;