fix: fix leading space behavior on values

properties-file · Oct 10, 2023 · d7b2ee5 · d7b2ee5
1 parent 12f600d
commit d7b2ee5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/assets/tests/test-all-java-console-output b/assets/tests/test-all-java-console-output
@@ -22,5 +22,6 @@ topic => '.properties file'
 trailingNonBreakingSpace => 'this line will have a trailing non-breaking space '
 valueWithEscapes => 'This is a newline
 , a carriage return, a tab	 and a formfeed.'
+valueWithLeadingSpaces => '   There are 3 leading spaces.'
 website => 'https://en.wikipedia.org/'
 welcome => 'Welcome to Wikipedia!    '

diff --git a/assets/tests/test-all.properties b/assets/tests/test-all.properties
@@ -49,6 +49,8 @@ oddKey = This is line one and\\\
 keyWitheven\\:this colon is not escaped
 # White space characters are removed before each line, but trailing spaces aren't.
     noWhiteSpace = The key will be "noWhiteSpace" without any whitespace.    
+# Values with leading spaces must be escaped for them to be preseved.
+valueWithLeadingSpaces = \   There are 3 leading spaces.
 # Make sure to add your spaces before your \ if you need them on the next line.
 # In the following example, the value for "welcome" is "Welcome to Wikipedia!    ".
 welcome = Welcome to \

diff --git a/src/escape/index.ts b/src/escape/index.ts
@@ -38,11 +38,11 @@ const escapeContent = (
 ): string =>
   unescapedContent.replace(
     new RegExp(`[\\s!#:=\\\\${escapeUnicode ? '\\u0000-\\u001F\\u007F-\\uFFFF' : ''}]`, 'g'),
-    (character) => {
+    (character, position) => {
       switch (character) {
         case ' ': {
-          // Escape space if required, or if it's the first character.
-          return escapeSpace ? '\\ ' : ' '
+          // Spaces.
+          return escapeSpace || position === 0 ? '\\ ' : ' '
         }
         case '\\': {
           // Backslash.

diff --git a/tests/properties-escape-unescape.test.ts b/tests/properties-escape-unescape.test.ts
@@ -51,7 +51,7 @@ describe('The property unicode value escaping', () => {
     ['こんにちは3=', 'こんにちは3\\='],
     ['こんにちは4\t', 'こんにちは4\\t'],
     ['こんにちは5 ', 'こんにちは5 '],
-    [' こんにちは6', ' こんにちは6'],
+    ['  こんにちは6', '\\  こんにちは6'],
     ['#こんにちは7', '\\#こんにちは7'],
     ['!こんにちは8#', '\\!こんにちは8\\#'],
     ['こん  にちは9', 'こん  にちは9'],
@@ -71,11 +71,11 @@ describe('The property ISO-8859-1 compatible encoding value escaping', () => {
     ['foo3=', 'foo3\\='],
     ['foo4\t', 'foo4\\t'],
     ['foo5 ', 'foo5 '],
-    [' foo6', ' foo6'],
+    [' foo6', '\\ foo6'],
     ['#foo7', '\\#foo7'],
     ['!foo8#', '\\!foo8\\#'],
     ['fo  o9', 'fo  o9'],
-    [' fo  o10 ', ' fo  o10 '],
+    ['  fo  o10 ', '\\  fo  o10 '],
     ['foo11\n', 'foo11\\n'],
     ['f\r\f\n\too12', 'f\\r\\f\\n\\too12'],
     ['\\foo13\\', '\\\\foo13\\\\'],