@lowentry/utils 1.16.2 → 1.17.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowentry/utils",
-  "version": "1.16.2",
+  "version": "1.17.1",
   "private": false,
   "type": "module",
   "main": "./index.js",

package/src/LeUtils.js

@@ -1127,6 +1127,47 @@ export const LeUtils = {
 			return 0;
 		},
 	
+	/**
+	 * Compares two strings in a natural way, meaning that it will compare numbers in the strings as actual numbers.
+	 *
+	 * This will correctly sort numeric parts so that "file5.txt" comes before "file10.txt", as well as that "file/5/test.txt" comes before "file/10/test.txt".
+	 *
+	 * @param {string} a
+	 * @param {string} b
+	 * @returns {number}
+	 */
+	compareNaturalStrings:
+		(a, b) =>
+		{
+			const re = /(\d+|\D+)/g; // split into runs of digits or non-digits
+			const aTokens = a.match(re) ?? [];
+			const bTokens = b.match(re) ?? [];
+			
+			const len = Math.min(aTokens.length, bTokens.length);
+			for(let i = 0; i < len; i++)
+			{
+				const x = aTokens[i];
+				const y = bTokens[i];
+				if(x === y)
+				{
+					continue;
+				}
+				
+				// if both are numbers, compare as numbers
+				const nx = parseInt(x, 10);
+				const ny = parseInt(y, 10);
+				if(!isNaN(nx) && !isNaN(ny))
+				{
+					return nx - ny;
+				}
+				
+				// otherwise compare lexically
+				return x < y ? -1 : 1;
+			}
+			
+			return aTokens.length - bTokens.length;
+		},
+	
 	/**
 	 * Compares two strings generated by LeUtils.timestamp(). Primarily used for sorting.
 	 *

package/tests/sort.test.js

@@ -0,0 +1,33 @@
+import {describe, test, expect, jest} from '@jest/globals';
+import {LeUtils} from '../src/index.js';
+
+const wait = ms => LeUtils.promiseTimeout(ms ?? 100);
+
+
+describe('LeUtils.compareNaturalStrings', () =>
+{
+	test('should return 0 for equal paths', () =>
+	{
+		expect(LeUtils.compareNaturalStrings('path/to/file.txt', 'path/to/file.txt')).toBe(0);
+	});
+	
+	test('should return -1 for first path being "less than" second', () =>
+	{
+		expect(LeUtils.compareNaturalStrings('path/to/a.txt', 'path/to/b.txt')).toBeLessThan(0);
+	});
+	
+	test('should return 1 for first path being "greater than" second', () =>
+	{
+		expect(LeUtils.compareNaturalStrings('path/to/b.txt', 'path/to/a.txt')).toBeGreaterThan(0);
+	});
+	
+	test('test/5/test.txt should be less than test/10/test.txt', () =>
+	{
+		expect(LeUtils.compareNaturalStrings('test/5/test.txt', 'test/10/test.txt')).toBeLessThan(0);
+	});
+	
+	test('test5.txt should be less than test10.txt', () =>
+	{
+		expect(LeUtils.compareNaturalStrings('test5.txt', 'test10.txt')).toBeLessThan(0);
+	});
+});