chore: added more tests

Thanks https://github.com/Avansai/properties-file for the sample

Author: mdvorak

fixtures/test-all.properties

@@ -0,0 +1,72 @@
+# You are reading a comment in ".properties" file.
+! The exclamation mark can also be used for comments.
+# Lines with "properties" contain a key and a value separated by a delimiting character.
+# There are 3 types of delimiting characters: '=' (equal), ':' (colon) and whitespace characters other
+# than carriage returns and newlines: ' ' (space), \t (tab) and \f (formfeed).
+website = https://en.wikipedia.org/
+language : English
+topic .properties file
+category    file format
+# A word on a line will just create a key with no value.
+empty
+orLikeThis =
+evenLikeThis\\
+# Likewise, if a line starts with a delimiter, it will create a value without a key.
+= This line has no key.
+: So does this line.
+# Whitespace characters between the key, the value and the delimiter are ignored.
+# This means that the following entries are equivalent (other than for readability).
+hello=hello
+hello = hello
+hello  =  hello
+# Keys with the same name will be overwritten by the key that is the closest to the end of a file.
+# For example the final value for "duplicateKey" will be "second".
+duplicateKey = first
+duplicateKey = second
+# To use the delimiter characters inside a key, you need to escape them with a \.
+# However, there is no need to do this in the value.
+keyWithDelimiters\:\=\ = This is the value for the key "keyWithDelimiters:= "
+# Adding a \ at the end of a line means that the value continues to the next line.
+multiline = This line \
+continues \
+on 3 lines
+# You can also do the same for keys, even if there is no real reason to do this.
+# In the following example, the value for "multilineKey" will be "this is a multiline key".
+multiline\
+Key this is a multiline key
+# If you want your value to include a \, it should be escaped by another \.
+path = c:\\wiki\\templates
+# This means that if the number of \ at the end of the line is even, the next line is not included in the value.
+# In the following example, the value for "evenKey" is "This is on one line\".
+evenKey = This is on one line\\
+# This line is a normal comment and is not included in the value for "evenKey"
+# If the number of \ is odd, then the next line is included in the value.
+# In the following example, the value for "oddKey" is "This is line one and\#This is line two".
+oddKey = This is line one and\\\
+# This is line two
+# This also applies with keys.
+# In the following example, the value for "keyWitheven\" is "this colon is not escaped".
+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.    
+# 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 \
+          Wikipedia!    
+# You can have empty lines, where all white space characters will be ignored.
+
+# You can also have whitespace before comments.
+
+# If you need to add carriage returns and newlines, they need to be escaped using \r and \n respectively.
+# You can also optionally escape tabs with \t for readability purposes.
+# \f (formfeed) can also be escaped even if it's not really useful.
+valueWithEscapes = This is a newline\n, a carriage return\r, a tab\t and a formfeed\f.
+# Using \ in front of non-escape characters will remove them from the output.
+# In the following example, the value for "keyWithBackslashes" is "This has random backslashes".
+keyWith\Backslashes = This\ has ran\d\o\m backslashes
+# You can also use Unicode escape characters, limited to 2 bytes or 65,535 characters.
+# In the following example, the value for "encodedHelloInJapanese" is "?????".
+encodedHelloInJapanese = \u3053\u3093\u306b\u3061\u306f
+# Using \u without being followed by four hexadecimal digits will throw an exception.
+# But with more modern file encodings like UTF-8, you can directly use supported characters.
+helloInJapanese = ?????

src/properties.spec.ts

@@ -1,16 +1,18 @@
+import * as fs from 'node:fs/promises'
 import properties from '.'
 
 describe('parse', () => {
   it('should parse all lines', () => {
     // Data
-    const sample = 'registry=https://abcd\n#foo bar\n@scope:test=avx\n'
+    const sample = 'registry=https://abcd\n#foo bar\r\n@scope:test=avx\rextra\r\n'
 
     // Test
     const result = properties.parse(sample)
     expect(result.lines).toEqual([
       'registry=https://abcd',
       '#foo bar',
-      '@scope:test=avx'
+      '@scope:test=avx',
+      'extra'
     ])
   })
 })
@@ -128,6 +130,19 @@ describe('data access', () => {
     expect(result).toBe(expected)
   })
 
+  it('should return last value of duplicate key', () => {
+    const config: properties.Properties = {
+      lines: [
+        'key1=foo1',
+        'key2=foo2',
+        'key1=foo3'
+      ]
+    }
+
+    const result = properties.get(config, 'key1')
+    expect(result).toBe('foo3')
+  })
+
   it.each([
     ['foo', 'bar', 'foo=bar'],
     ['foo8:', 'bar8', 'foo8\\:=bar8'],
@@ -218,6 +233,22 @@ describe('data access', () => {
     ])
   })
 
+  it('should remove duplicate keys on set', () => {
+    const config: properties.Properties = {
+      lines: [
+        'key1=foo1',
+        'key2=foo2',
+        'key1=foo3'
+      ]
+    }
+
+    properties.set(config, 'key1', 'test')
+    expect(config.lines).toEqual([
+      'key1=test',
+      'key2=foo2'
+    ])
+  })
+
   it('should remove existing key with set undefined', () => {
     const config: properties.Properties = {
       lines: ['foo=bar']
@@ -234,6 +265,19 @@ describe('data access', () => {
     expect(config.lines).toEqual([])
   })
 
+  it('should remove all duplicate keys with remove', () => {
+    const config: properties.Properties = {
+      lines: [
+        'key1=foo1',
+        'key2=foo2',
+        'key1=foo3'
+      ]
+    }
+
+    properties.remove(config, 'key1')
+    expect(config.lines).toEqual(['key2=foo2'])
+  })
+
   describe('list', () => {
     it('should list all key-value pairs', () => {
       const result = [...properties.list(sample)]
@@ -293,6 +337,40 @@ describe('data access', () => {
         ['c', 'd']
       ])
     })
+
+    it('should parse test file', async () => {
+      const contents = await fs.readFile('../fixtures/test-all.properties', 'utf-8')
+
+      // Parse
+      const result = properties.toMap(properties.parse(contents))
+
+      // Verify
+      expect(result).toEqual({
+        '': 'So does this line.',
+        category: 'file format',
+        duplicateKey: 'second',
+        empty: '',
+        encodedHelloInJapanese: 'こんにちは',
+        evenKey: 'This is on one line\\',
+        'evenLikeThis\\': '',
+        hello: 'hello',
+        helloInJapanese: 'こんにちは',
+        keyWithBackslashes: 'This has random backslashes',
+        'keyWithDelimiters:= ': 'This is the value for the key "keyWithDelimiters:= "',
+        'keyWitheven\\': 'this colon is not escaped',
+        language: 'English',
+        multiline: 'This line continues on 3 lines',
+        multilineKey: 'this is a multiline key',
+        noWhiteSpace: 'The key will be "noWhiteSpace" without any whitespace.    ',
+        oddKey: 'This is line one and\\# This is line two',
+        orLikeThis: '',
+        path: 'c:\\wiki\\templates',
+        topic: '.properties file',
+        valueWithEscapes: 'This is a newline\n, a carriage return\r, a tab\t and a formfeed\f.',
+        website: 'https://en.wikipedia.org/',
+        welcome: 'Welcome to Wikipedia!    '
+      })
+    })
   })
 })