feat: add join method that deprecates joinPaths

This adds some naming compatibility compared with `node:path` module.

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

lib/index.ts

@@ -38,9 +38,21 @@ export function dirname(path: string): string {
 }
 
 /**
- * Join path sections
+ * Joins multiple path segments into a single path.
+ *
+ * @param args - The path segments to join
+ * @deprecated use `join()` instead
  */
-export function joinPaths(...args: string[]) {
+export function joinPaths(...args: string[]): string {
+    return join(...args)
+}
+
+/**
+ * Joins multiple path segments into a single path.
+ *
+ * @param args - The path segments to join
+ */
+export function join(...args: string[]): string {
     if (arguments.length < 1) {
         return ''
     }

test/joinPaths.test.ts

@@ -3,9 +3,9 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 import { describe, expect, it  } from 'vitest';
-import { joinPaths } from "../lib/index";
+import { joinPaths, join } from "../lib/index";
 
-describe("joinPaths", function () {
+describe.for([join, joinPaths])("joinPaths", (joinPaths) => {
 	it("returns empty string with no or empty arguments", function () {
 		expect(joinPaths()).toEqual("");
 		expect(joinPaths("")).toEqual("");