feat: add comparePaths function

dictionaries/keywords.txt

@@ -31,3 +31,4 @@ pinst
 iteratable
 FMRADIO
 vitest
+réservé

src/string.spec.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from 'vitest';
 
 import {
+  comparePaths,
   crlfToLf,
   getInitials,
   isNullOrEmpty,
@@ -294,4 +295,32 @@ describe('string', () => {
       },
     );
   });
+
+  describe('comparePaths', () => {
+    it('should return 0 if paths are the same', () => {
+      expect(comparePaths('/path1/', '/path1/')).toBe(0);
+    });
+
+    it('should return 1 if path1 is bigger', () => {
+      expect(comparePaths('b', 'a')).toBe(1);
+    });
+
+    it('should return 0 if path1 is equal to path2 but with different case', () => {
+      expect(comparePaths('path', 'PAth')).toBe(0);
+    });
+
+    it('should return non-zero if path1 is equal to path2 but with different accent', () => {
+      expect(comparePaths('reserve', 'réservé')).not.toBe(0);
+    });
+
+    it('should ignore trailing slashes', () => {
+      expect(comparePaths('reserve', 'reserve//')).toBe(0);
+      expect(comparePaths('reserve//', 'reserve/')).toBe(0);
+    });
+
+    it('should ignore leading slashes', () => {
+      expect(comparePaths('//reserve', 'reserve')).toBe(0);
+      expect(comparePaths('/reserve', '//reserve')).toBe(0);
+    });
+  });
 });

src/string.ts

@@ -1,7 +1,7 @@
 import { isNull, isString } from './guards.js';
 import { isWordOrWords } from './internals/string.js';
 import { hasInvalidCasing, tokenize } from './internals/tokenize.js';
-import type { Nullish } from './types.js';
+import type { Nullish, Sensitivity } from './types.js';
 
 export const toSpaceCase = tokenize;
 
@@ -34,7 +34,7 @@ export const toSnakeCase = (str: string) =>
     ? str
     : toSpaceCase(str).replace(
         /(\s[a-z])/g,
-        (_, letter) => `_${letter.slice(1)}`,
+        (_, letter: string) => `_${letter.slice(1)}`,
       );
 
 /**
@@ -45,7 +45,7 @@ export const toKebabCase = (str: string) =>
     ? str
     : toSpaceCase(str).replace(
         /(\s[a-z])/g,
-        (_, letter) => `-${letter.slice(1)}`,
+        (_, letter: string) => `-${letter.slice(1)}`,
       );
 
 /**
@@ -99,3 +99,21 @@ export const joinPath = (...paths: string[]): string => {
   );
   return result.join('/');
 };
+
+/**
+ * Compare two path without trailing and leading slashes
+ * @param {string} path1: first path
+ * @param {string} path2: second path
+ * @return {boolean} is they are equal
+ */
+export const comparePaths = (
+  path1: string,
+  path2: string,
+  { sensitivity = 'accent' }: { sensitivity?: Sensitivity } = {},
+): number => {
+  const normalPath1 = removeLeadingSlashes(removeTrailingSlashes(path1));
+  const normalPath2 = removeLeadingSlashes(removeTrailingSlashes(path2));
+  return normalPath1.localeCompare(normalPath2, undefined, {
+    sensitivity,
+  });
+};

src/types.ts

@@ -89,3 +89,5 @@ export type Tuple<T, N extends number> = N extends N
     ? T[]
     : TupleOf<T, N, []>
   : never;
+
+export type Sensitivity = 'accent' | 'base' | 'case' | 'variant';