properties-file 3.3.2 → 3.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/editor/index.d.ts +6 -0
- package/lib/editor/index.js +25 -23
- package/lib/escape/index.js +3 -3
- package/lib/index.js +2 -2
- package/lib/loader/webpack.js +2 -2
- package/lib/properties.js +27 -26
- package/lib/property-line.js +4 -4
- package/lib/property.js +15 -15
- package/lib/unescape/index.js +4 -4
- package/package.json +4 -4
package/lib/editor/index.d.ts
CHANGED
|
@@ -61,12 +61,18 @@ export type UpsertOptions = {
|
|
|
61
61
|
* A .properties file editor.
|
|
62
62
|
*/
|
|
63
63
|
export declare class PropertiesEditor extends Properties {
|
|
64
|
+
/** Is line parsing required to re-async the object's properties? */
|
|
65
|
+
private needsLineParsing;
|
|
64
66
|
/**
|
|
65
67
|
* Create `PropertiesEditor` object.
|
|
66
68
|
*
|
|
67
69
|
* @param content - The content of a `.properties` file.
|
|
68
70
|
*/
|
|
69
71
|
constructor(content: string);
|
|
72
|
+
/**
|
|
73
|
+
* Parse the `.properties` content line by line only when needed.
|
|
74
|
+
*/
|
|
75
|
+
private parseLinesIfNeeded;
|
|
70
76
|
/**
|
|
71
77
|
* Insert a new property in the existing object (by default it will be at the end).
|
|
72
78
|
*
|
package/lib/editor/index.js
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
-
"use strict";
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PropertiesEditor=exports.DEFAULT_SEPARATOR=exports.DEFAULT_COMMENT_DELIMITER=void 0;var _escape=require("../escape"),_properties=require("../properties");/** The default separator between keys and values. */const DEFAULT_SEPARATOR=exports.DEFAULT_SEPARATOR="=",DEFAULT_COMMENT_DELIMITER=exports.DEFAULT_COMMENT_DELIMITER="#";/** The default character used as comment delimiter. */ /** Characters that can be used as key-value pair separators. */ /** Characters that can be used as comment delimiters. */ /** Options on the `Properties.insert` method. */ /** Options on the `Properties.insertComment` method. */ /** Options on the `Properties.update` method. */ /** Options on the `Properties.upsert` method. */ /**
|
|
2
|
+
* A .properties file editor.
|
|
3
|
+
*/class PropertiesEditor extends _properties.Properties{/** Is line parsing required to re-async the object's properties? */needsLineParsing=!1;/**
|
|
2
4
|
* Create `PropertiesEditor` object.
|
|
3
5
|
*
|
|
4
6
|
* @param content - The content of a `.properties` file.
|
|
5
|
-
*/
|
|
7
|
+
*/constructor(a){super(a)}/**
|
|
8
|
+
* Parse the `.properties` content line by line only when needed.
|
|
9
|
+
*/parseLinesIfNeeded(){this.needsLineParsing&&(this.parseLines(),this.needsLineParsing=!1)}/**
|
|
6
10
|
* Insert a new property in the existing object (by default it will be at the end).
|
|
7
11
|
*
|
|
8
12
|
* @param key - A property key (unescaped).
|
|
@@ -10,56 +14,56 @@
|
|
|
10
14
|
* @param options - Additional options.
|
|
11
15
|
*
|
|
12
16
|
* @returns True if the key was inserted, otherwise false.
|
|
13
|
-
*/
|
|
14
|
-
|
|
17
|
+
*/insert(a,b,c){const d=c?.escapeUnicode||!1,e=c?.separator?" "===c.separator?" ":` ${c.separator} `:` ${DEFAULT_SEPARATOR} `.replace(" "," "),f=c?.referenceKey,g=c?.position||"after";f&&this.parseLinesIfNeeded();// Allow multiline keys.
|
|
18
|
+
const h=a.split(/\r?\n/).map(a=>(0,_escape.escapeKey)(a,d)).join("\\\n"),i=b.split(/\r?\n/).map(a=>(0,_escape.escapeValue)(a,d)).join("\\\n"),j=`${c?.commentDelimiter||DEFAULT_COMMENT_DELIMITER} `,k=c?.comment===void 0?"":`${`${j}${c.comment}`.split(/\r?\n/).join(`\n${j}`)}\n`,l=`${k}${h}${e}${i}`.split(/\n/);// Allow multiline values.
|
|
15
19
|
// Allow multiline comments.
|
|
16
|
-
if(void 0===f)
|
|
17
|
-
|
|
18
|
-
if(
|
|
20
|
+
if(void 0===f)return this.lines.push(...l),this.needsLineParsing=!0,!0;else{// Find the last occurrence of the reference key.
|
|
21
|
+
const a=[...this.collection].reverse().find(a=>a.key===f);// Insert the new property when a reference key defined only when found.
|
|
22
|
+
if(a){const b="after"===g?a.endingLineNumber:a.previousProperty?.endingLineNumber??0;return this.lines=[...this.lines.slice(0,b),...l,...this.lines.slice(b)],this.needsLineParsing=!0,!0}return!1}}/**
|
|
19
23
|
* Insert a new comment in the existing object (by default it will be at the end).
|
|
20
24
|
*
|
|
21
25
|
* @param comment - The comment to add.
|
|
22
26
|
* @param options - Additional options.
|
|
23
27
|
*
|
|
24
28
|
* @returns True if the comment was inserted, otherwise false.
|
|
25
|
-
*/
|
|
26
|
-
if(void 0===c)
|
|
27
|
-
|
|
28
|
-
if(
|
|
29
|
+
*/insertComment(a,b){const c=b?.referenceKey,d=b?.position||"after";c&&this.parseLinesIfNeeded();// Allow multiline comments.
|
|
30
|
+
const e=`${b?.commentDelimiter||DEFAULT_COMMENT_DELIMITER} `,f=`${e}${a}`.replace(/\r?\n/g,`\n${e}`).split(/\n/);if(void 0===c)return this.lines.push(...f),this.needsLineParsing=!0,!0;else{// Find the last occurrence of the reference key.
|
|
31
|
+
const a=[...this.collection].reverse().find(a=>a.key===c);// Insert the new comment when a reference key defined only when found.
|
|
32
|
+
if(a){const b="after"===d?a.endingLineNumber:a.previousProperty?.endingLineNumber??0;return this.lines=[...this.lines.slice(0,b),...f,...this.lines.slice(b)],this.needsLineParsing=!0,!0}return!1}}/**
|
|
29
33
|
* Delete the last occurrence of a given key from the existing object.
|
|
30
34
|
*
|
|
31
35
|
* @param key - The name of the key to delete.
|
|
32
36
|
* @param deleteCommentsAndWhiteSpace - By default, comments and white-space characters before the key will be deleted.
|
|
33
37
|
*
|
|
34
38
|
* @returns True if the key was deleted, otherwise false.
|
|
35
|
-
*/
|
|
36
|
-
if(c){
|
|
39
|
+
*/delete(a){let b=!(1<arguments.length&&arguments[1]!==void 0)||arguments[1];this.parseLinesIfNeeded();// Find the last occurrence of the key.
|
|
40
|
+
const c=[...this.collection].reverse().find(b=>b.key===a);if(c){const a=b?c.previousProperty?.endingLineNumber??0:c.startingLineNumber-1,d=c.endingLineNumber;return this.lines=[...this.lines.slice(0,a),...this.lines.slice(d)],this.needsLineParsing=!0,!0}return!1}/**
|
|
37
41
|
* Restore the original newline characters of a key.
|
|
38
42
|
*
|
|
39
43
|
* @param property - A property object.
|
|
40
44
|
*
|
|
41
45
|
* @returns The key with its original newlines characters restored.
|
|
42
|
-
*/
|
|
43
|
-
|
|
46
|
+
*/getKeyWithNewlines(a){return 0===a.newlinePositions.length?a.key:// eslint-disable-next-line unicorn/no-array-reduce
|
|
47
|
+
[...a.key].reduce((b,c,d)=>`${b}${a.newlinePositions.includes(d)?"\n":""}${c}`,"")}/**
|
|
44
48
|
* Restore the original newline characters of a value.
|
|
45
49
|
*
|
|
46
50
|
* @param property - A property object.
|
|
47
51
|
*
|
|
48
52
|
* @returns The value with its original newlines characters restored.
|
|
49
|
-
*/
|
|
50
|
-
|
|
53
|
+
*/getValueWithNewlines(a){return 0===a.newlinePositions.length||a.valuePosition===void 0?a.value:// eslint-disable-next-line unicorn/no-array-reduce
|
|
54
|
+
[...a.value].reduce((b,c,d)=>`${b}${a.newlinePositions.includes(d+a.valuePosition)?"\n":""}${c}`,"")}/**
|
|
51
55
|
* Update the last occurrence of a given key from the existing object.
|
|
52
56
|
*
|
|
53
57
|
* @param key - The name of the key to update.
|
|
54
58
|
* @param options - Additional options.
|
|
55
59
|
*
|
|
56
60
|
* @returns True if the key was updated, otherwise false.
|
|
57
|
-
*/
|
|
58
|
-
if(!
|
|
61
|
+
*/update(a,b){this.parseLinesIfNeeded();// Find the last occurrence of the key to update.
|
|
62
|
+
const c=[...this.collection].reverse().find(b=>b.key===a);if(!c||!b)return!1;const d=b.escapeUnicode||!1,e=b.separator?" "===b.separator?" ":` ${b.separator} `:c.separator||` ${DEFAULT_SEPARATOR} `.replace(" "," "),f=(b.newKey??this.getKeyWithNewlines(c)).split(/\r?\n/).map(a=>(0,_escape.escapeKey)(a,d)).join("\\\n"),g=(b.newValue??this.getValueWithNewlines(c)).split(/\r?\n/).map(a=>(0,_escape.escapeValue)(a,d)).join("\\\n"),h=`${b.commentDelimiter||DEFAULT_COMMENT_DELIMITER} `,i=void 0===b.newComment?"":`${`${h}${b.newComment}`.split(/\r?\n/).join(`\n${h}`)}\n`,j=`${i}${f}${e}${g}`.split(/\n/);// Allow multiline keys.
|
|
59
63
|
// Allow multiline values.
|
|
60
64
|
// Allow multiline comments.
|
|
61
65
|
// Replace the existing property with the new one.
|
|
62
|
-
return this.lines=[
|
|
66
|
+
return this.lines=[...this.lines.slice(0,void 0===b.newComment?c.startingLineNumber-1:c.previousProperty?.endingLineNumber??0),...j,...this.lines.slice(c.endingLineNumber)],this.needsLineParsing=!0,!0}/**
|
|
63
67
|
* Update a key if it exist, otherwise add it at the end.
|
|
64
68
|
*
|
|
65
69
|
* @param key - A property key (unescaped).
|
|
@@ -67,6 +71,4 @@ return this.lines=[].concat(_toConsumableArray(this.lines.slice(0,void 0===b.new
|
|
|
67
71
|
* @param options - Additional options.
|
|
68
72
|
*
|
|
69
73
|
* @returns True if the key was updated or inserted, otherwise false.
|
|
70
|
-
*/
|
|
71
|
-
* A .properties file editor.
|
|
72
|
-
*/
|
|
74
|
+
*/upsert(a,b,c){return this.parseLinesIfNeeded(),this.keyLineNumbers[a]?this.update(a,{newValue:b,newComment:c?.comment,commentDelimiter:c?.commentDelimiter,separator:c?.separator,escapeUnicode:c?.escapeUnicode}):this.insert(a,b,c)}}exports.PropertiesEditor=PropertiesEditor;
|
package/lib/escape/index.js
CHANGED
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
* @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
|
|
6
6
|
*
|
|
7
7
|
* @return The escaped key.
|
|
8
|
-
*/
|
|
8
|
+
*/const escapeKey=function(a){let b=!!(1<arguments.length&&arguments[1]!==void 0)&&arguments[1];return escapeContent(a,!0,b)};/**
|
|
9
9
|
* Escape property value.
|
|
10
10
|
*
|
|
11
11
|
* @param unescapedValue - Property value to be escaped.
|
|
12
12
|
* @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
|
|
13
13
|
*
|
|
14
14
|
* @return The escaped value.
|
|
15
|
-
*/
|
|
15
|
+
*/exports.escapeKey=escapeKey;const escapeValue=function(a){let b=!!(1<arguments.length&&arguments[1]!==void 0)&&arguments[1];return escapeContent(a,!1,b)};/**
|
|
16
16
|
* Escape the content from either key or value of a property.
|
|
17
17
|
*
|
|
18
18
|
* @param unescapedContent - The content to escape.
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
* @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
|
|
21
21
|
*
|
|
22
22
|
* @returns The escaped content.
|
|
23
|
-
*/
|
|
23
|
+
*/exports.escapeValue=escapeValue;const escapeContent=(a,b,c)=>a.replace(new RegExp(`[\\s!#:=\\\\${c?"\\u0000-\\u001F\\u007F-\\uFFFF":""}]`,"g"),(a,c)=>" "===a?b||0===c?"\\ ":" ":"\\"===a?"\\\\":"\f"===a?"\\f":"\n"===a?"\\n":"\r"===a?"\\r":"\t"===a?"\\t":"="===a||":"===a||"#"===a||"!"===a?`\\${a}`:`\\u${a.codePointAt(0).toString(16).padStart(4,"0")}`);
|
package/lib/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"Properties",{enumerable:!0,get:function
|
|
1
|
+
"use strict";var _properties=require("./properties");Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"Properties",{enumerable:!0,get:function(){return _properties.Properties}}),exports.getProperties=void 0;/**
|
|
2
2
|
* A key-value pair object.
|
|
3
3
|
*/ /**
|
|
4
4
|
* Converts the content of a `.properties` file to a key-value pair object.
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
* @param content - The content of a `.properties` file.
|
|
7
7
|
*
|
|
8
8
|
* @returns A key/value object representing the content of a `.properties` file.
|
|
9
|
-
*/
|
|
9
|
+
*/const getProperties=a=>new _properties.Properties(a).toObject();exports.getProperties=getProperties;
|
package/lib/loader/webpack.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0
|
|
1
|
+
"use strict";var _=require("..");Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;/**
|
|
2
2
|
* Webpack file loader for `.properties` files.
|
|
3
3
|
*
|
|
4
4
|
* @param content - the content of a `.properties` file.
|
|
5
5
|
*
|
|
6
6
|
* @returns A Webpack file loader string containing the content of a `.properties` file.
|
|
7
|
-
*/
|
|
7
|
+
*/const webpackLoader=a=>`module.exports = ${JSON.stringify((0,_.getProperties)(a))};`;var _default=exports.default=webpackLoader;
|
package/lib/properties.js
CHANGED
|
@@ -1,51 +1,52 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getFirstEolCharacter=exports.Properties=exports.KeyCollisions=exports.DEFAULT_END_OF_LINE_CHARACTER=exports.BOM_CODE_POINT=exports.BOM=void 0;var _property=require("./property"),_propertyLine=require("./property-line")
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getFirstEolCharacter=exports.Properties=exports.KeyCollisions=exports.DEFAULT_END_OF_LINE_CHARACTER=exports.BOM_CODE_POINT=exports.BOM=void 0;var _property=require("./property"),_propertyLine=require("./property-line");/**
|
|
2
2
|
* Byte-order mark.
|
|
3
|
-
*/
|
|
3
|
+
*/const BOM=exports.BOM="\uFEFF",BOM_CODE_POINT=exports.BOM_CODE_POINT=BOM.codePointAt(0),DEFAULT_END_OF_LINE_CHARACTER=exports.DEFAULT_END_OF_LINE_CHARACTER="\n",getFirstEolCharacter=a=>{const b=a.indexOf("\n");return 0>b?void 0:`${"\r"===a[b-1]?"\r":""}\n`};/** The default end of line character. */ /**
|
|
4
|
+
* Get the first end of line (EOL) character from multiline content.
|
|
5
|
+
*
|
|
6
|
+
* @param content - The content of a `.properties` file.
|
|
7
|
+
*
|
|
8
|
+
* @returns The multiline content's first end of line (EOL) character.
|
|
9
|
+
*/ /**
|
|
10
|
+
* A class representing the content of a .properties file.
|
|
11
|
+
*/exports.getFirstEolCharacter=getFirstEolCharacter;class Properties{/** Does the .properties content starts with a BOM character? */ /** The end of line character. */ /** `.properties` content split by line. */ /** The collection of property object. */collection=[];/** Object associating keys with their starting line numbers. */keyLineNumbers={};/**
|
|
4
12
|
* Create `Properties` object.
|
|
5
13
|
*
|
|
6
14
|
* @param content - The content of a `.properties` file.
|
|
7
|
-
*/
|
|
15
|
+
*/constructor(a){const b="string"==typeof a?a:a.toString();this.hasBom=b.codePointAt(0)===BOM_CODE_POINT,this.eolCharacter=getFirstEolCharacter(b)??DEFAULT_END_OF_LINE_CHARACTER,this.lines=(this.hasBom?b.slice(1):b).split(/\r?\n/),this.parseLines()}/**
|
|
8
16
|
* Parse the `.properties` content line by line.
|
|
9
|
-
*/
|
|
10
|
-
if(
|
|
17
|
+
*/parseLines(){this.collection=[],this.keyLineNumbers={};/** Line number while parsing properties file content. */let a,b,c=0;/** The current property object being parsed. */ /** The previous property object that was parsed. */for(const d of this.lines){c++;const e=new _propertyLine.PropertyLine(d,!!a);if(!a){// Check if the line is a new property.
|
|
18
|
+
if(e.isComment||e.isBlank)continue;// Skip line if its a comment or blank.
|
|
11
19
|
// The line is a new property.
|
|
12
|
-
if(a=new _property.Property(
|
|
13
|
-
}else if(a.addLine(
|
|
14
|
-
this.addToCollection(a),b=a,a=void 0}}
|
|
20
|
+
if(a=new _property.Property(e,c,b),e.isContinuing)continue;// Continue parsing the next line.
|
|
21
|
+
}else if(a.addLine(e),e.isContinuing)continue;// If the line does not continue, add the property to the collection.
|
|
22
|
+
this.addToCollection(a),b=a,a=void 0}}/**
|
|
15
23
|
* Add a property object into a properties object collection.
|
|
16
24
|
*
|
|
17
25
|
* @param property - A property object, or undefined.
|
|
18
26
|
*
|
|
19
27
|
* @returns Undefined so that we conveniently overwrite the property object.
|
|
20
|
-
*/
|
|
28
|
+
*/addToCollection(a){// Add the property to the collection.
|
|
29
|
+
a.setKeyAndValue(),this.keyLineNumbers[a.key]?.length?(this.keyLineNumbers[a.key].push(a.startingLineNumber),a.hasKeyCollisions=!0,a.keyCollisionLines=this.keyLineNumbers[a.key],this.collection=this.collection.filter(b=>b.key!==a.key)):this.keyLineNumbers[a.key]=[a.startingLineNumber],this.collection.push(a)}/**
|
|
21
30
|
* Get keys that have collisions (more than one occurrence).
|
|
22
|
-
*/
|
|
31
|
+
*/getKeyCollisions(){const a=[];for(const[b,c]of Object.entries(this.keyLineNumbers))1<c.length&&a.push(new KeyCollisions(b,c));return a}/**
|
|
23
32
|
* Get the key/value object representing the properties.
|
|
24
33
|
*
|
|
25
34
|
* @returns A key/value object representing the properties.
|
|
26
|
-
*/
|
|
35
|
+
*/toObject(){const a={};return this.collection.forEach(b=>{a[b.key]=b.value}),a}/**
|
|
27
36
|
* Format the object in `.properties`.
|
|
28
37
|
*
|
|
29
38
|
* @param endOfLineCharacter - The character used for end of lines.
|
|
30
39
|
*
|
|
31
40
|
* @returns The object in `.properties` format.
|
|
32
|
-
*/
|
|
41
|
+
*/format(a){return`${this.hasBom?BOM:""}${this.lines.join(a||this.eolCharacter)}`}}/**
|
|
42
|
+
* Object associating keys with their line numbers.
|
|
43
|
+
*/exports.Properties=Properties;/**
|
|
44
|
+
* A class representing key within a .properties file that had collisions (more than one occurrence).
|
|
45
|
+
*/class KeyCollisions{/** The key with collisions. */ /** The starting line numbers where collisions are found. */ /**
|
|
33
46
|
* Create a new key collision object.
|
|
34
47
|
*
|
|
35
48
|
* @param key - The key with collisions.
|
|
36
49
|
* @param startingLineNumbers - The starting line numbers where collisions are found.
|
|
37
|
-
*/
|
|
50
|
+
*/constructor(a,b){this.key=a,this.startingLineNumbers=b}/**
|
|
38
51
|
* Get the number of the line from which the value will be used.
|
|
39
|
-
*/
|
|
40
|
-
* Get the first end of line (EOL) character from multiline content.
|
|
41
|
-
*
|
|
42
|
-
* @param content - The content of a `.properties` file.
|
|
43
|
-
*
|
|
44
|
-
* @returns The multiline content's first end of line (EOL) character.
|
|
45
|
-
*/ /**
|
|
46
|
-
* A class representing the content of a .properties file.
|
|
47
|
-
*/ /**
|
|
48
|
-
* Object associating keys with their line numbers.
|
|
49
|
-
*/ /**
|
|
50
|
-
* A class representing key within a .properties file that had collisions (more than one occurrence).
|
|
51
|
-
*/
|
|
52
|
+
*/getApplicableLineNumber(){return this.startingLineNumbers.slice(-1)[0]}}exports.KeyCollisions=KeyCollisions;
|
package/lib/property-line.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PropertyLine=void 0
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PropertyLine=void 0;/**
|
|
2
2
|
* Object representing a line from the content of .properties file.
|
|
3
|
-
*/
|
|
3
|
+
*/class PropertyLine{/** The line content, minus the trailing \ that identifies that the line is continuing. */ /** True if the line is continuing to the next line, otherwise false. */isContinuing=!1;/** True if the line is blank, otherwise false. */isBlank=!1;/** True if the line is a comment, otherwise false. */isComment=!1;/** Is the line object a continuation from a previous line? */ /**
|
|
4
4
|
* Create a new line object.
|
|
5
5
|
*
|
|
6
6
|
* @param line - The raw content of a line.
|
|
7
7
|
* @param isMultiline - Is the line spreading on multiple lines?
|
|
8
|
-
*/
|
|
9
|
-
|
|
8
|
+
*/constructor(a,b){if(this.content=a.trimStart(),this.isMultiline=b,0===this.content.length)this.isBlank=!0;else if(this.isMultiline||(this.isComment=!!/^[!#]/.test(this.content)),!this.isComment){// Otherwise, check if the line is continuing on the next line.
|
|
9
|
+
const a=this.content.match(/(?<backslashes>\\+)$/);a?.groups&&(this.isContinuing=!!(a.groups.backslashes.length%2),this.isContinuing&&(this.content=this.content.slice(0,-1)))}}}exports.PropertyLine=PropertyLine;
|
package/lib/property.js
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
"use strict";var _unescape=require("./unescape");Object.defineProperty(exports,"__esModule",{value:!0}),exports.Property=void 0
|
|
1
|
+
"use strict";var _unescape=require("./unescape");Object.defineProperty(exports,"__esModule",{value:!0}),exports.Property=void 0;/**
|
|
2
2
|
* Object representing a property (key/value).
|
|
3
|
-
*/
|
|
3
|
+
*/class Property{/** The content of one or multiple lines when applicable. */ /** The property key (unescaped). */key="";/** The property key, including its escaped characters. */escapedKey="";/** Is the key empty? */hasNoKey=!1;/** Does the key definition spread across multiple lines? */hasMultilineKey=!1;/** Starting line numbers of property objects with the same key. */keyCollisionLines=[];/** Was the property's key used more than once? */hasKeyCollisions=!1;/** The key/value pair separator */ /** The length of the key/value pair separator, including its whitespace characters. */ /** The starting position of the key/value pair separator. */ /** The property value (unescaped). */value="";/** The starting position of the value. */ /** The property value, including its escaped characters. */escapedValue="";/** Is the value empty? */hasNoValue=!1;/** Positions of the newline characters if any. */newlinePositions=[];/** The line number at which the property starts. */ /** The line number at which the property ends. */ /** The previous property object if it exists. */ /** The next property object if it exists. */ /**
|
|
4
4
|
* Create a new property object.
|
|
5
5
|
*
|
|
6
6
|
* @param propertyLine - A property line object.
|
|
7
7
|
* @param startingLineNumber - The line number at which the property starts.
|
|
8
|
-
*/
|
|
8
|
+
*/constructor(a,b,c){this.linesContent=a.content,this.startingLineNumber=b,this.endingLineNumber=b,this.previousProperty=c,c?.setNextProperty(this)}/**
|
|
9
9
|
* Set the next property object.
|
|
10
10
|
*
|
|
11
11
|
* @param property - The next property object
|
|
12
|
-
*/
|
|
12
|
+
*/setNextProperty(a){this.nextProperty=a}/**
|
|
13
13
|
* Add the a line to a multiline property object.
|
|
14
14
|
*
|
|
15
15
|
* @param propertyLine - A property line object.
|
|
16
|
-
*/
|
|
16
|
+
*/addLine(a){0<this.linesContent.length&&(this.newlinePositions.push(this.linesContent.length),this.endingLineNumber++),this.linesContent+=a.content}/**
|
|
17
17
|
* Set the property's key and value.
|
|
18
|
-
*/
|
|
18
|
+
*/setKeyAndValue(){this.findSeparator(),this.separatorPosition!==void 0&&this.separatorLength!==void 0?(!this.hasNoKey&&(this.escapedKey=this.linesContent.slice(0,this.separatorPosition),this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber)),!this.hasNoValue&&(this.escapedValue=this.linesContent.slice(this.separatorPosition+this.separatorLength),this.value=this.unescapeLine(this.escapedValue,this.startingLineNumber))):this.hasNoValue&&(this.escapedKey=this.linesContent,this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber))}/**
|
|
19
19
|
* Unescape the content from either key or value of a property.
|
|
20
20
|
*
|
|
21
21
|
* @param escapedContent - The content to unescape.
|
|
@@ -25,15 +25,15 @@
|
|
|
25
25
|
*
|
|
26
26
|
* @throws {@link Error}
|
|
27
27
|
* This exception is thrown if malformed escaped unicode characters are present.
|
|
28
|
-
*/
|
|
28
|
+
*/unescapeLine(a,b){try{return(0,_unescape.unescapeContent)(a)}catch(a){throw new Error(`${a.message} in property starting at line ${b}`)}}/**
|
|
29
29
|
* Find the character separating the key from the value.
|
|
30
|
-
*/
|
|
30
|
+
*/findSeparator(){// If the separator was already found, skip.
|
|
31
31
|
if(!(this.hasNoKey||this.hasNoValue||this.separatorPosition)){// Only match separators to avoid iterating all characters.
|
|
32
|
-
|
|
33
|
-
if(
|
|
34
|
-
continue}
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
for(const a of this.linesContent.matchAll(/[\t\f :=]/g)){const b=a.index,c=this.linesContent.slice(0,b),d=c.match(/(?<backslashes>\\+)$/);// Check if the separator might be escaped.
|
|
33
|
+
if(d?.groups){const a=!!(d.groups.backslashes.length%2);if(a)// If the separator is escaped, check the next character.
|
|
34
|
+
continue}let e="";this.separatorPosition=b;// Check if the separator starts with a whitespace.
|
|
35
|
+
let f=this.linesContent.slice(b);// All white-space characters, excluding non-breaking spaces.
|
|
36
|
+
const g=f.match(/^(?<whitespace>[\t\n\v\f\r ]+)/),h=g?.groups?.whitespace||"";// If there is a whitespace, move to the next character.
|
|
37
37
|
// Check if there is an equal or colon character.
|
|
38
|
-
if(0<
|
|
39
|
-
|
|
38
|
+
if(0<h.length&&(e+=h,f=f.slice(h.length)),/[:=]/.test(f[0])){e+=f[0],f=f.slice(1);// If an equal or colon character was found, try to get trailing whitespace.
|
|
39
|
+
const a=f.match(/^(?<whitespace>[\t\n\v\f\r ]+)/),b=a?.groups?.whitespace||"";e+=b}this.separatorLength=e.length,this.valuePosition=this.separatorPosition+this.separatorLength,this.separator=this.linesContent.slice(this.separatorPosition,this.separatorPosition+this.separatorLength),b||(this.hasNoKey=!0);break}void 0===this.separatorPosition?this.hasNoValue=!0:0<this.newlinePositions.length&&this.newlinePositions[0]<this.separatorPosition&&(this.hasMultilineKey=!0)}}}exports.Property=Property;
|
package/lib/unescape/index.js
CHANGED
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
*
|
|
8
8
|
* @throws {@link Error}
|
|
9
9
|
* This exception is thrown if malformed escaped unicode characters are present.
|
|
10
|
-
*/
|
|
11
|
-
a.replace(/\\[^u]|\\u.{4}/g,
|
|
10
|
+
*/const unescapeContent=a=>// By using a regular expression we avoid iterating through all characters and improve performance.
|
|
11
|
+
a.replace(/\\[^u]|\\u.{4}/g,a=>{const b=a.charAt(1);switch(b){case"f":// Formfeed.
|
|
12
12
|
return"\f";case"n":// Newline.
|
|
13
13
|
return"\n";case"r":// Carriage return.
|
|
14
14
|
return"\r";case"t":// Tab.
|
|
15
15
|
return"\t";case"u":{// Unicode character.
|
|
16
|
-
|
|
17
|
-
throw new Error(
|
|
16
|
+
const b=a.slice(2,6);if(!/[\da-f]{4}/i.test(b))// Code point can only be within Unicode's Multilingual Plane (BMP).
|
|
17
|
+
throw new Error(`malformed escaped unicode characters '\\u${b}'`);return String.fromCodePoint(Number.parseInt(b,16))}default:return b}});exports.unescapeContent=unescapeContent;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "properties-file",
|
|
3
|
-
"version": "3.3.
|
|
3
|
+
"version": "3.3.4",
|
|
4
4
|
"description": ".properties file parser, editor, formatter and Webpack loader.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
".properties",
|
|
@@ -64,9 +64,9 @@
|
|
|
64
64
|
},
|
|
65
65
|
"devDependencies": {
|
|
66
66
|
"@babel/cli": "^7.23.0",
|
|
67
|
-
"@babel/core": "^7.23.
|
|
68
|
-
"@babel/preset-env": "^7.
|
|
69
|
-
"@babel/preset-typescript": "7.23.
|
|
67
|
+
"@babel/core": "^7.23.2",
|
|
68
|
+
"@babel/preset-env": "^7.23.2",
|
|
69
|
+
"@babel/preset-typescript": "7.23.2",
|
|
70
70
|
"@release-it/conventional-changelog": "7.0.2",
|
|
71
71
|
"@types/jest": "29.5.5",
|
|
72
72
|
"@typescript-eslint/eslint-plugin": "6.7.5",
|