refactor: move escape functions to own file

Author: mdvorak

src/escape.spec.ts

@@ -0,0 +1,47 @@
+import * as properties from '.'
+
+describe('escapeKey', () => {
+  it.each([
+    ['foo1', 'foo1'],
+    ['foo2:', 'foo2\\:'],
+    ['foo3=', 'foo3\\='],
+    ['foo4\t', 'foo4\\t'],
+    ['foo5 ', 'foo5\\ '],
+    [' foo6', '\\ foo6'],
+    ['#foo7', '\\#foo7'],
+    ['!foo8#', '\\!foo8\\#'],
+    ['fo  o9', 'fo\\ \\ o9'],
+    ['foo10\n', 'foo10\\n'],
+    ['f\r\f\n\too11', 'f\\r\\f\\n\\too11'],
+    ['\\foo12\\', '\\\\foo12\\\\'],
+    ['\0\u0001', '\\u0000\\u0001'],
+    ['\u3053\u3093\u306B\u3061\u306F', '\\u3053\\u3093\\u306b\\u3061\\u306f'],
+    ['こんにちは', '\\u3053\\u3093\\u306b\\u3061\\u306f']
+  ])('should escape key "%s" as "%s"', (key: string, expected: string) => {
+    const result = properties.escapeKey(key)
+    expect(result).toEqual(expected)
+  })
+})
+
+describe('escapeValue', () => {
+  it.each([
+    ['foo1', 'foo1'],
+    ['foo2:', 'foo2\\:'],
+    ['foo3=', 'foo3\\='],
+    ['foo4\t', 'foo4\\t'],
+    ['foo5 ', 'foo5 '],
+    [' foo6', '\\ foo6'],
+    ['#foo7', '\\#foo7'],
+    ['!foo8#', '\\!foo8\\#'],
+    ['fo  o9', 'fo  o9'],
+    ['foo10\n', 'foo10\\n'],
+    ['f\r\f\n\too11', 'f\\r\\f\\n\\too11'],
+    ['\\foo12\\', '\\\\foo12\\\\'],
+    ['\0\u0001', '\\u0000\\u0001'],
+    ['\u3053\u3093\u306B\u3061\u306F', '\\u3053\\u3093\\u306b\\u3061\\u306f'],
+    ['こんにちは', '\\u3053\\u3093\\u306b\\u3061\\u306f']
+  ])('should escape value "%s" as "%s"', (key: string, expected: string) => {
+    const result = properties.escapeValue(key)
+    expect(result).toEqual(expected)
+  })
+})

src/escape.ts

@@ -0,0 +1,103 @@
+/**
+ * Escape property key.
+ *
+ * @param unescapedKey Property key to be escaped.
+ * @param escapeUnicode Escape unicode chars (below 0x0020 and above 0x007e). Default is true.
+ * @return Escaped string.
+ */
+export const escapeKey = (
+  unescapedKey: string,
+  escapeUnicode = true
+): string => {
+  return escape(unescapedKey, true, escapeUnicode)
+}
+
+/**
+ * Escape property value.
+ *
+ * @param unescapedValue Property value to be escaped.
+ * @param escapeUnicode Escape unicode chars (below 0x0020 and above 0x007e). Default is true.
+ * @return Escaped string.
+ */
+export const escapeValue = (
+  unescapedValue: string,
+  escapeUnicode = true
+): string => {
+  return escape(unescapedValue, false, escapeUnicode)
+}
+
+/**
+ * Internal escape method.
+ *
+ * @param unescapedContent Text to be escaped.
+ * @param escapeSpace Whether all spaces should be escaped
+ * @param escapeUnicode Whether unicode chars should be escaped
+ * @return Escaped string.
+ */
+const escape = (
+  unescapedContent: string,
+  escapeSpace: boolean,
+  escapeUnicode: boolean
+): string => {
+  const result: string[] = []
+
+  for (let index = 0; index < unescapedContent.length; index++) {
+    const char = unescapedContent[index]
+    switch (char) {
+      case ' ': {
+        // Escape space if required, or if it is first character
+        if (escapeSpace || index === 0) {
+          result.push('\\ ')
+        } else {
+          result.push(' ')
+        }
+        break
+      }
+      case '\\': {
+        result.push('\\\\')
+        break
+      }
+      case '\f': {
+        // Form-feed
+        result.push('\\f')
+        break
+      }
+      case '\n': {
+        // Newline
+        result.push('\\n')
+        break
+      }
+      case '\r': {
+        // Carriage return
+        result.push('\\r')
+        break
+      }
+      case '\t': {
+        // Tab
+        result.push('\\t')
+        break
+      }
+      case '=': // Fall through
+      case ':': // Fall through
+      case '#': // Fall through
+      case '!': {
+        result.push('\\', char)
+        break
+      }
+      default: {
+        if (escapeUnicode) {
+          const codePoint: number = char.codePointAt(0) as number // can never be undefined
+          if (codePoint < 0x0020 || codePoint > 0x007e) {
+            result.push('\\u', codePoint.toString(16).padStart(4, '0'))
+            break
+          }
+        }
+        // Normal char
+        result.push(char)
+        break
+      }
+    }
+  }
+
+  return result.join('')
+}

src/index.ts

@@ -1 +1,2 @@
+export * from './escape'
 export * from './properties'

src/properties.spec.ts

@@ -1,6 +1,6 @@
 import * as fs from 'node:fs/promises'
 
-import properties from '.'
+import * as properties from '.'
 
 describe('parse', () => {
   it('should parse all lines', () => {
@@ -411,49 +411,3 @@ describe('data access', () => {
     })
   })
 })
-
-describe('escapeKey', () => {
-  it.each([
-    ['foo1', 'foo1'],
-    ['foo2:', 'foo2\\:'],
-    ['foo3=', 'foo3\\='],
-    ['foo4\t', 'foo4\\t'],
-    ['foo5 ', 'foo5\\ '],
-    [' foo6', '\\ foo6'],
-    ['#foo7', '\\#foo7'],
-    ['!foo8#', '\\!foo8\\#'],
-    ['fo  o9', 'fo\\ \\ o9'],
-    ['foo10\n', 'foo10\\n'],
-    ['f\r\f\n\too11', 'f\\r\\f\\n\\too11'],
-    ['\\foo12\\', '\\\\foo12\\\\'],
-    ['\0\u0001', '\\u0000\\u0001'],
-    ['\u3053\u3093\u306B\u3061\u306F', '\\u3053\\u3093\\u306b\\u3061\\u306f'],
-    ['こんにちは', '\\u3053\\u3093\\u306b\\u3061\\u306f']
-  ])('should escape key "%s" as "%s"', (key: string, expected: string) => {
-    const result = properties.escapeKey(key)
-    expect(result).toEqual(expected)
-  })
-})
-
-describe('escapeValue', () => {
-  it.each([
-    ['foo1', 'foo1'],
-    ['foo2:', 'foo2\\:'],
-    ['foo3=', 'foo3\\='],
-    ['foo4\t', 'foo4\\t'],
-    ['foo5 ', 'foo5 '],
-    [' foo6', '\\ foo6'],
-    ['#foo7', '\\#foo7'],
-    ['!foo8#', '\\!foo8\\#'],
-    ['fo  o9', 'fo  o9'],
-    ['foo10\n', 'foo10\\n'],
-    ['f\r\f\n\too11', 'f\\r\\f\\n\\too11'],
-    ['\\foo12\\', '\\\\foo12\\\\'],
-    ['\0\u0001', '\\u0000\\u0001'],
-    ['\u3053\u3093\u306B\u3061\u306F', '\\u3053\\u3093\\u306b\\u3061\\u306f'],
-    ['こんにちは', '\\u3053\\u3093\\u306b\\u3061\\u306f']
-  ])('should escape value "%s" as "%s"', (key: string, expected: string) => {
-    const result = properties.escapeValue(key)
-    expect(result).toEqual(expected)
-  })
-})

src/properties.ts

@@ -1,3 +1,5 @@
+import {escapeKey, escapeValue} from './escape'
+
 /**
  * Wrapper for java properties file contents
  */
@@ -495,107 +497,3 @@ const parseUnicode = (sequence: string, line: number): string => {
   }
   return String.fromCodePoint(parseInt(sequence, 16))
 }
-
-/**
- * Escape property key.
- *
- * @param unescapedKey Property key to be escaped.
- * @param escapeUnicode Escape unicode chars (below 0x0020 and above 0x007e). Default is true.
- * @return Escaped string.
- */
-export const escapeKey = (
-  unescapedKey: string,
-  escapeUnicode = true
-): string => {
-  return escape(unescapedKey, true, escapeUnicode)
-}
-
-/**
- * Escape property value.
- *
- * @param unescapedValue Property value to be escaped.
- * @param escapeUnicode Escape unicode chars (below 0x0020 and above 0x007e). Default is true.
- * @return Escaped string.
- */
-export const escapeValue = (
-  unescapedValue: string,
-  escapeUnicode = true
-): string => {
-  return escape(unescapedValue, false, escapeUnicode)
-}
-
-/**
- * Internal escape method.
- *
- * @param unescapedContent Text to be escaped.
- * @param escapeSpace Whether all spaces should be escaped
- * @param escapeUnicode Whether unicode chars should be escaped
- * @return Escaped string.
- */
-const escape = (
-  unescapedContent: string,
-  escapeSpace: boolean,
-  escapeUnicode: boolean
-): string => {
-  const result: string[] = []
-
-  for (let index = 0; index < unescapedContent.length; index++) {
-    const char = unescapedContent[index]
-    switch (char) {
-      case ' ': {
-        // Escape space if required, or if it is first character
-        if (escapeSpace || index === 0) {
-          result.push('\\ ')
-        } else {
-          result.push(' ')
-        }
-        break
-      }
-      case '\\': {
-        result.push('\\\\')
-        break
-      }
-      case '\f': {
-        // Form-feed
-        result.push('\\f')
-        break
-      }
-      case '\n': {
-        // Newline
-        result.push('\\n')
-        break
-      }
-      case '\r': {
-        // Carriage return
-        result.push('\\r')
-        break
-      }
-      case '\t': {
-        // Tab
-        result.push('\\t')
-        break
-      }
-      case '=': // Fall through
-      case ':': // Fall through
-      case '#': // Fall through
-      case '!': {
-        result.push('\\', char)
-        break
-      }
-      default: {
-        if (escapeUnicode) {
-          const codePoint: number = char.codePointAt(0) as number // can never be undefined
-          if (codePoint < 0x0020 || codePoint > 0x007e) {
-            result.push('\\u', codePoint.toString(16).padStart(4, '0'))
-            break
-          }
-        }
-        // Normal char
-        result.push(char)
-        break
-      }
-    }
-  }
-
-  return result.join('')
-}