@stryke/string-format 0.14.8 → 0.16.0

package/dist/path/src/join-paths.cjs

@@ -0,0 +1,122 @@
+const require_regex = require('./regex.cjs');
+const require_is_type = require('./is-type.cjs');
+const require_slash = require('./slash.cjs');
+
+//#region ../path/src/join-paths.ts
+function normalizeWindowsPath(input = "") {
+	if (!input) return input;
+	return input.replace(/\\/g, "/").replace(require_regex.DRIVE_LETTER_START_REGEX, (r) => r.toUpperCase());
+}
+function correctPaths(path) {
+	if (!path || path.length === 0) return ".";
+	path = normalizeWindowsPath(path);
+	const isUNCPath = path.match(require_regex.UNC_REGEX);
+	const isPathAbsolute = require_is_type.isAbsolute(path);
+	const trailingSeparator = path[path.length - 1] === "/";
+	path = normalizeString(path, !isPathAbsolute);
+	if (path.length === 0) {
+		if (isPathAbsolute) return "/";
+		return trailingSeparator ? "./" : ".";
+	}
+	if (trailingSeparator) path += "/";
+	if (require_regex.DRIVE_LETTER_REGEX.test(path)) path += "/";
+	if (isUNCPath) {
+		if (!isPathAbsolute) return `//./${path}`;
+		return `//${path}`;
+	}
+	return isPathAbsolute && !require_is_type.isAbsolute(path) ? `/${path}` : path;
+}
+/**
+* Joins all given path segments together using the platform-specific separator as a delimiter.
+*
+* @remarks
+* Multiple segments can be provided as separate arguments. The resulting path is normalized to remove any redundant or unnecessary segments.
+*
+* @example
+* ```ts
+* import { joinPaths } from 'stryke/path';
+*
+* const fullPath = joinPaths('folder1', 'folder2', '..', 'folder3', 'file.txt');
+* console.log(fullPath); // Output: 'folder1/folder3/file.txt'
+*
+* const absolutePath = joinPaths('/root', 'folder', '.', 'subfolder', 'file.txt');
+* console.log(absolutePath); // Output: '/root/folder/subfolder/file.txt'
+*
+* const windowsPath = joinPaths('C:\\', 'Users', 'Public', '..', 'Documents', 'file.txt');
+* console.log(windowsPath); // Output: 'C:/Users/Documents/file.txt'
+*
+* const uncPath = joinPaths('\\\\Server\\Share', 'Folder', 'File.txt');
+* console.log(uncPath); // Output: '//Server/Share/Folder/File.txt'
+* ```
+*
+* @param segments - The path segments to join.
+* @returns The joined and normalized path string.
+*/
+function joinPaths(...segments) {
+	let result = "";
+	for (const segment of segments) if (segment && require_slash.slash(segment).replaceAll(/\//g, "") !== ".") {
+		if (result) if (require_slash.slash(segment).replaceAll(/\//g, "") === "..") result = require_slash.slash(result).replace(/\/+$/, "").replace(/\/*[^/]+$/, "");
+		else result = `${require_slash.slash(result).replace(/\/+$/, "")}/${require_slash.slash(segment).replace(/^\/+/, "")}`;
+		else if (require_slash.slash(segment).replaceAll(/\//g, "") !== "..") result = segment;
+	}
+	return correctPaths(result);
+}
+/**
+* Resolves a string path, resolving '.' and '.' segments and allowing paths above the root.
+*
+* @param path - The path to normalize.
+* @param allowAboveRoot - Whether to allow the resulting path to be above the root directory.
+* @returns the normalized path string.
+*/
+function normalizeString(path, allowAboveRoot) {
+	let res = "";
+	let lastSegmentLength = 0;
+	let lastSlash = -1;
+	let dots = 0;
+	let char = null;
+	for (let index = 0; index <= path.length; ++index) {
+		if (index < path.length) char = path[index];
+		else if (char === "/") break;
+		else char = "/";
+		if (char === "/") {
+			if (lastSlash === index - 1 || dots === 1) {} else if (dots === 2) {
+				if (res.length < 2 || lastSegmentLength !== 2 || res[res.length - 1] !== "." || res[res.length - 2] !== ".") {
+					if (res.length > 2) {
+						const lastSlashIndex = res.lastIndexOf("/");
+						if (lastSlashIndex === -1) {
+							res = "";
+							lastSegmentLength = 0;
+						} else {
+							res = res.slice(0, lastSlashIndex);
+							lastSegmentLength = res.length - 1 - res.lastIndexOf("/");
+						}
+						lastSlash = index;
+						dots = 0;
+						continue;
+					} else if (res.length > 0) {
+						res = "";
+						lastSegmentLength = 0;
+						lastSlash = index;
+						dots = 0;
+						continue;
+					}
+				}
+				if (allowAboveRoot) {
+					res += res.length > 0 ? "/.." : "..";
+					lastSegmentLength = 2;
+				}
+			} else {
+				if (res.length > 0) res += `/${path.slice(lastSlash + 1, index)}`;
+				else res = path.slice(lastSlash + 1, index);
+				lastSegmentLength = index - lastSlash - 1;
+			}
+			lastSlash = index;
+			dots = 0;
+		} else if (char === "." && dots !== -1) ++dots;
+		else dots = -1;
+	}
+	return res;
+}
+
+//#endregion
+exports.joinPaths = joinPaths;

package/dist/path/src/join-paths.mjs

@@ -0,0 +1,123 @@
+import { DRIVE_LETTER_REGEX, DRIVE_LETTER_START_REGEX, UNC_REGEX } from "./regex.mjs";
+import { isAbsolute } from "./is-type.mjs";
+import { slash } from "./slash.mjs";
+
+//#region ../path/src/join-paths.ts
+function normalizeWindowsPath(input = "") {
+	if (!input) return input;
+	return input.replace(/\\/g, "/").replace(DRIVE_LETTER_START_REGEX, (r) => r.toUpperCase());
+}
+function correctPaths(path) {
+	if (!path || path.length === 0) return ".";
+	path = normalizeWindowsPath(path);
+	const isUNCPath = path.match(UNC_REGEX);
+	const isPathAbsolute = isAbsolute(path);
+	const trailingSeparator = path[path.length - 1] === "/";
+	path = normalizeString(path, !isPathAbsolute);
+	if (path.length === 0) {
+		if (isPathAbsolute) return "/";
+		return trailingSeparator ? "./" : ".";
+	}
+	if (trailingSeparator) path += "/";
+	if (DRIVE_LETTER_REGEX.test(path)) path += "/";
+	if (isUNCPath) {
+		if (!isPathAbsolute) return `//./${path}`;
+		return `//${path}`;
+	}
+	return isPathAbsolute && !isAbsolute(path) ? `/${path}` : path;
+}
+/**
+* Joins all given path segments together using the platform-specific separator as a delimiter.
+*
+* @remarks
+* Multiple segments can be provided as separate arguments. The resulting path is normalized to remove any redundant or unnecessary segments.
+*
+* @example
+* ```ts
+* import { joinPaths } from 'stryke/path';
+*
+* const fullPath = joinPaths('folder1', 'folder2', '..', 'folder3', 'file.txt');
+* console.log(fullPath); // Output: 'folder1/folder3/file.txt'
+*
+* const absolutePath = joinPaths('/root', 'folder', '.', 'subfolder', 'file.txt');
+* console.log(absolutePath); // Output: '/root/folder/subfolder/file.txt'
+*
+* const windowsPath = joinPaths('C:\\', 'Users', 'Public', '..', 'Documents', 'file.txt');
+* console.log(windowsPath); // Output: 'C:/Users/Documents/file.txt'
+*
+* const uncPath = joinPaths('\\\\Server\\Share', 'Folder', 'File.txt');
+* console.log(uncPath); // Output: '//Server/Share/Folder/File.txt'
+* ```
+*
+* @param segments - The path segments to join.
+* @returns The joined and normalized path string.
+*/
+function joinPaths(...segments) {
+	let result = "";
+	for (const segment of segments) if (segment && slash(segment).replaceAll(/\//g, "") !== ".") {
+		if (result) if (slash(segment).replaceAll(/\//g, "") === "..") result = slash(result).replace(/\/+$/, "").replace(/\/*[^/]+$/, "");
+		else result = `${slash(result).replace(/\/+$/, "")}/${slash(segment).replace(/^\/+/, "")}`;
+		else if (slash(segment).replaceAll(/\//g, "") !== "..") result = segment;
+	}
+	return correctPaths(result);
+}
+/**
+* Resolves a string path, resolving '.' and '.' segments and allowing paths above the root.
+*
+* @param path - The path to normalize.
+* @param allowAboveRoot - Whether to allow the resulting path to be above the root directory.
+* @returns the normalized path string.
+*/
+function normalizeString(path, allowAboveRoot) {
+	let res = "";
+	let lastSegmentLength = 0;
+	let lastSlash = -1;
+	let dots = 0;
+	let char = null;
+	for (let index = 0; index <= path.length; ++index) {
+		if (index < path.length) char = path[index];
+		else if (char === "/") break;
+		else char = "/";
+		if (char === "/") {
+			if (lastSlash === index - 1 || dots === 1) {} else if (dots === 2) {
+				if (res.length < 2 || lastSegmentLength !== 2 || res[res.length - 1] !== "." || res[res.length - 2] !== ".") {
+					if (res.length > 2) {
+						const lastSlashIndex = res.lastIndexOf("/");
+						if (lastSlashIndex === -1) {
+							res = "";
+							lastSegmentLength = 0;
+						} else {
+							res = res.slice(0, lastSlashIndex);
+							lastSegmentLength = res.length - 1 - res.lastIndexOf("/");
+						}
+						lastSlash = index;
+						dots = 0;
+						continue;
+					} else if (res.length > 0) {
+						res = "";
+						lastSegmentLength = 0;
+						lastSlash = index;
+						dots = 0;
+						continue;
+					}
+				}
+				if (allowAboveRoot) {
+					res += res.length > 0 ? "/.." : "..";
+					lastSegmentLength = 2;
+				}
+			} else {
+				if (res.length > 0) res += `/${path.slice(lastSlash + 1, index)}`;
+				else res = path.slice(lastSlash + 1, index);
+				lastSegmentLength = index - lastSlash - 1;
+			}
+			lastSlash = index;
+			dots = 0;
+		} else if (char === "." && dots !== -1) ++dots;
+		else dots = -1;
+	}
+	return res;
+}
+
+//#endregion
+export { joinPaths };
+//# sourceMappingURL=join-paths.mjs.map

package/dist/path/src/join-paths.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"join-paths.mjs","names":["char: string | null"],"sources":["../../../../path/src/join-paths.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { isAbsolute } from \"./is-type\";\nimport {\n  DRIVE_LETTER_REGEX,\n  DRIVE_LETTER_START_REGEX,\n  UNC_REGEX\n} from \"./regex\";\nimport { slash } from \"./slash\";\n\n// Util to normalize windows paths to posix\nfunction normalizeWindowsPath(input = \"\") {\n  if (!input) {\n    return input;\n  }\n  return input\n    .replace(/\\\\/g, \"/\")\n    .replace(DRIVE_LETTER_START_REGEX, r => r.toUpperCase());\n}\n\nfunction correctPaths(path?: string) {\n  if (!path || path.length === 0) {\n    return \".\";\n  }\n\n  // Normalize windows argument\n  path = normalizeWindowsPath(path);\n\n  const isUNCPath = path.match(UNC_REGEX);\n  const isPathAbsolute = isAbsolute(path);\n  const trailingSeparator = path[path.length - 1] === \"/\";\n\n  // Normalize the path\n  path = normalizeString(path, !isPathAbsolute);\n\n  if (path.length === 0) {\n    if (isPathAbsolute) {\n      return \"/\";\n    }\n    return trailingSeparator ? \"./\" : \".\";\n  }\n  if (trailingSeparator) {\n    path += \"/\";\n  }\n  if (DRIVE_LETTER_REGEX.test(path)) {\n    path += \"/\";\n  }\n\n  if (isUNCPath) {\n    if (!isPathAbsolute) {\n      return `//./${path}`;\n    }\n    return `//${path}`;\n  }\n\n  return isPathAbsolute && !isAbsolute(path) ? `/${path}` : path;\n}\n\n/**\n * Joins all given path segments together using the platform-specific separator as a delimiter.\n *\n * @remarks\n * Multiple segments can be provided as separate arguments. The resulting path is normalized to remove any redundant or unnecessary segments.\n *\n * @example\n * ```ts\n * import { joinPaths } from 'stryke/path';\n *\n * const fullPath = joinPaths('folder1', 'folder2', '..', 'folder3', 'file.txt');\n * console.log(fullPath); // Output: 'folder1/folder3/file.txt'\n *\n * const absolutePath = joinPaths('/root', 'folder', '.', 'subfolder', 'file.txt');\n * console.log(absolutePath); // Output: '/root/folder/subfolder/file.txt'\n *\n * const windowsPath = joinPaths('C:\\\\', 'Users', 'Public', '..', 'Documents', 'file.txt');\n * console.log(windowsPath); // Output: 'C:/Users/Documents/file.txt'\n *\n * const uncPath = joinPaths('\\\\\\\\Server\\\\Share', 'Folder', 'File.txt');\n * console.log(uncPath); // Output: '//Server/Share/Folder/File.txt'\n * ```\n *\n * @param segments - The path segments to join.\n * @returns The joined and normalized path string.\n */\nexport function joinPaths(...segments: string[]): string {\n  let result = \"\";\n  for (const segment of segments) {\n    if (segment && slash(segment).replaceAll(/\\//g, \"\") !== \".\") {\n      if (result) {\n        if (slash(segment).replaceAll(/\\//g, \"\") === \"..\") {\n          result = slash(result)\n            .replace(/\\/+$/, \"\")\n            .replace(/\\/*[^/]+$/, \"\");\n        } else {\n          result = `${slash(result).replace(/\\/+$/, \"\")}/${slash(\n            segment\n          ).replace(/^\\/+/, \"\")}`;\n        }\n      } else if (slash(segment).replaceAll(/\\//g, \"\") !== \"..\") {\n        result = segment;\n      }\n    }\n  }\n\n  return correctPaths(result);\n}\n\nexport const join = joinPaths;\n\n/**\n * Resolves a string path, resolving '.' and '.' segments and allowing paths above the root.\n *\n * @param path - The path to normalize.\n * @param allowAboveRoot - Whether to allow the resulting path to be above the root directory.\n * @returns the normalized path string.\n */\nfunction normalizeString(path: string, allowAboveRoot: boolean) {\n  let res = \"\";\n  let lastSegmentLength = 0;\n  let lastSlash = -1;\n  let dots = 0;\n  let char: string | null = null;\n  for (let index = 0; index <= path.length; ++index) {\n    if (index < path.length) {\n      // casted because we know it exists thanks to the length check\n      char = path[index] as string;\n    } else if (char === \"/\") {\n      break;\n    } else {\n      char = \"/\";\n    }\n    if (char === \"/\") {\n      if (lastSlash === index - 1 || dots === 1) {\n        // NOOP\n      } else if (dots === 2) {\n        if (\n          res.length < 2 ||\n          lastSegmentLength !== 2 ||\n          res[res.length - 1] !== \".\" ||\n          res[res.length - 2] !== \".\"\n        ) {\n          if (res.length > 2) {\n            const lastSlashIndex = res.lastIndexOf(\"/\");\n            if (lastSlashIndex === -1) {\n              res = \"\";\n              lastSegmentLength = 0;\n            } else {\n              res = res.slice(0, lastSlashIndex);\n              lastSegmentLength = res.length - 1 - res.lastIndexOf(\"/\");\n            }\n            lastSlash = index;\n            dots = 0;\n            continue;\n          } else if (res.length > 0) {\n            res = \"\";\n            lastSegmentLength = 0;\n            lastSlash = index;\n            dots = 0;\n            continue;\n          }\n        }\n        if (allowAboveRoot) {\n          res += res.length > 0 ? \"/..\" : \"..\";\n          lastSegmentLength = 2;\n        }\n      } else {\n        if (res.length > 0) {\n          res += `/${path.slice(lastSlash + 1, index)}`;\n        } else {\n          res = path.slice(lastSlash + 1, index);\n        }\n        lastSegmentLength = index - lastSlash - 1;\n      }\n      lastSlash = index;\n      dots = 0;\n    } else if (char === \".\" && dots !== -1) {\n      ++dots;\n    } else {\n      dots = -1;\n    }\n  }\n  return res;\n}\n"],"mappings":";;;;;AA2BA,SAAS,qBAAqB,QAAQ,IAAI;AACxC,KAAI,CAAC,MACH,QAAO;AAET,QAAO,MACJ,QAAQ,OAAO,IAAI,CACnB,QAAQ,2BAA0B,MAAK,EAAE,aAAa,CAAC;;AAG5D,SAAS,aAAa,MAAe;AACnC,KAAI,CAAC,QAAQ,KAAK,WAAW,EAC3B,QAAO;AAIT,QAAO,qBAAqB,KAAK;CAEjC,MAAM,YAAY,KAAK,MAAM,UAAU;CACvC,MAAM,iBAAiB,WAAW,KAAK;CACvC,MAAM,oBAAoB,KAAK,KAAK,SAAS,OAAO;AAGpD,QAAO,gBAAgB,MAAM,CAAC,eAAe;AAE7C,KAAI,KAAK,WAAW,GAAG;AACrB,MAAI,eACF,QAAO;AAET,SAAO,oBAAoB,OAAO;;AAEpC,KAAI,kBACF,SAAQ;AAEV,KAAI,mBAAmB,KAAK,KAAK,CAC/B,SAAQ;AAGV,KAAI,WAAW;AACb,MAAI,CAAC,eACH,QAAO,OAAO;AAEhB,SAAO,KAAK;;AAGd,QAAO,kBAAkB,CAAC,WAAW,KAAK,GAAG,IAAI,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6B5D,SAAgB,UAAU,GAAG,UAA4B;CACvD,IAAI,SAAS;AACb,MAAK,MAAM,WAAW,SACpB,KAAI,WAAW,MAAM,QAAQ,CAAC,WAAW,OAAO,GAAG,KAAK,KACtD;MAAI,OACF,KAAI,MAAM,QAAQ,CAAC,WAAW,OAAO,GAAG,KAAK,KAC3C,UAAS,MAAM,OAAO,CACnB,QAAQ,QAAQ,GAAG,CACnB,QAAQ,aAAa,GAAG;MAE3B,UAAS,GAAG,MAAM,OAAO,CAAC,QAAQ,QAAQ,GAAG,CAAC,GAAG,MAC/C,QACD,CAAC,QAAQ,QAAQ,GAAG;WAEd,MAAM,QAAQ,CAAC,WAAW,OAAO,GAAG,KAAK,KAClD,UAAS;;AAKf,QAAO,aAAa,OAAO;;;;;;;;;AAY7B,SAAS,gBAAgB,MAAc,gBAAyB;CAC9D,IAAI,MAAM;CACV,IAAI,oBAAoB;CACxB,IAAI,YAAY;CAChB,IAAI,OAAO;CACX,IAAIA,OAAsB;AAC1B,MAAK,IAAI,QAAQ,GAAG,SAAS,KAAK,QAAQ,EAAE,OAAO;AACjD,MAAI,QAAQ,KAAK,OAEf,QAAO,KAAK;WACH,SAAS,IAClB;MAEA,QAAO;AAET,MAAI,SAAS,KAAK;AAChB,OAAI,cAAc,QAAQ,KAAK,SAAS,GAAG,YAEhC,SAAS,GAAG;AACrB,QACE,IAAI,SAAS,KACb,sBAAsB,KACtB,IAAI,IAAI,SAAS,OAAO,OACxB,IAAI,IAAI,SAAS,OAAO,KAExB;SAAI,IAAI,SAAS,GAAG;MAClB,MAAM,iBAAiB,IAAI,YAAY,IAAI;AAC3C,UAAI,mBAAmB,IAAI;AACzB,aAAM;AACN,2BAAoB;aACf;AACL,aAAM,IAAI,MAAM,GAAG,eAAe;AAClC,2BAAoB,IAAI,SAAS,IAAI,IAAI,YAAY,IAAI;;AAE3D,kBAAY;AACZ,aAAO;AACP;gBACS,IAAI,SAAS,GAAG;AACzB,YAAM;AACN,0BAAoB;AACpB,kBAAY;AACZ,aAAO;AACP;;;AAGJ,QAAI,gBAAgB;AAClB,YAAO,IAAI,SAAS,IAAI,QAAQ;AAChC,yBAAoB;;UAEjB;AACL,QAAI,IAAI,SAAS,EACf,QAAO,IAAI,KAAK,MAAM,YAAY,GAAG,MAAM;QAE3C,OAAM,KAAK,MAAM,YAAY,GAAG,MAAM;AAExC,wBAAoB,QAAQ,YAAY;;AAE1C,eAAY;AACZ,UAAO;aACE,SAAS,OAAO,SAAS,GAClC,GAAE;MAEF,QAAO;;AAGX,QAAO"}

package/dist/path/src/regex.cjs

@@ -0,0 +1,12 @@
+
+//#region ../path/src/regex.ts
+const DRIVE_LETTER_START_REGEX = /^[A-Z]:\//i;
+const DRIVE_LETTER_REGEX = /^[A-Z]:$/i;
+const UNC_REGEX = /^[/\\]{2}/;
+const ABSOLUTE_PATH_REGEX = /^[/\\](?![/\\])|^[/\\]{2}(?!\.)|^~[/\\]|^[A-Z]:[/\\]/i;
+
+//#endregion
+exports.ABSOLUTE_PATH_REGEX = ABSOLUTE_PATH_REGEX;
+exports.DRIVE_LETTER_REGEX = DRIVE_LETTER_REGEX;
+exports.DRIVE_LETTER_START_REGEX = DRIVE_LETTER_START_REGEX;
+exports.UNC_REGEX = UNC_REGEX;

package/dist/path/src/regex.mjs

@@ -0,0 +1,9 @@
+//#region ../path/src/regex.ts
+const DRIVE_LETTER_START_REGEX = /^[A-Z]:\//i;
+const DRIVE_LETTER_REGEX = /^[A-Z]:$/i;
+const UNC_REGEX = /^[/\\]{2}/;
+const ABSOLUTE_PATH_REGEX = /^[/\\](?![/\\])|^[/\\]{2}(?!\.)|^~[/\\]|^[A-Z]:[/\\]/i;
+
+//#endregion
+export { ABSOLUTE_PATH_REGEX, DRIVE_LETTER_REGEX, DRIVE_LETTER_START_REGEX, UNC_REGEX };
+//# sourceMappingURL=regex.mjs.map

package/dist/path/src/regex.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"regex.mjs","names":[],"sources":["../../../../path/src/regex.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport const DRIVE_LETTER_START_REGEX = /^[A-Z]:\\//i;\nexport const DRIVE_LETTER_REGEX = /^[A-Z]:$/i;\n\nexport const UNC_REGEX = /^[/\\\\]{2}/;\n\nexport const ABSOLUTE_PATH_REGEX =\n  /^[/\\\\](?![/\\\\])|^[/\\\\]{2}(?!\\.)|^~[/\\\\]|^[A-Z]:[/\\\\]/i;\n\nexport const ROOT_FOLDER_REGEX = /^\\/([A-Z]:)?$/i;\n\nexport const FILE_EXTENSION_REGEX = /\\.[0-9a-z]+$/i;\nexport const FULL_FILE_EXTENSION_REGEX = /(\\.d)?\\.[0-9a-z]+(\\.map)?$/i;\n\nexport const PACKAGE_PATH_REGEX = /^@\\w+\\/.*$/;\nexport const NPM_SCOPED_PACKAGE_REGEX = /^(?:@[\\w-]+\\/)?[\\w-]+$/;\n"],"mappings":";AAkBA,MAAa,2BAA2B;AACxC,MAAa,qBAAqB;AAElC,MAAa,YAAY;AAEzB,MAAa,sBACX"}

package/dist/path/src/slash.cjs

@@ -0,0 +1,15 @@
+
+//#region ../path/src/slash.ts
+/**
+* Replace backslash to slash
+*
+* @param path - The string to replace
+* @returns The string with replaced backslashes
+*/
+function slash(path) {
+	if (path.startsWith("\\\\?\\")) return path;
+	return path.replace(/\\/g, "/");
+}
+
+//#endregion
+exports.slash = slash;

package/dist/path/src/slash.mjs

@@ -0,0 +1,15 @@
+//#region ../path/src/slash.ts
+/**
+* Replace backslash to slash
+*
+* @param path - The string to replace
+* @returns The string with replaced backslashes
+*/
+function slash(path) {
+	if (path.startsWith("\\\\?\\")) return path;
+	return path.replace(/\\/g, "/");
+}
+
+//#endregion
+export { slash };
+//# sourceMappingURL=slash.mjs.map

package/dist/path/src/slash.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"slash.mjs","names":[],"sources":["../../../../path/src/slash.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { isAbsolutePath } from \"./is-type\";\n\n/**\n * Replace backslash to slash\n *\n * @param path - The string to replace\n * @returns The string with replaced backslashes\n */\nexport function slash(path: string) {\n  if (path.startsWith(\"\\\\\\\\?\\\\\")) {\n    return path;\n  }\n\n  return path.replace(/\\\\/g, \"/\");\n}\n\n/**\n * Replace backslash to slash and remove unneeded leading and trailing slashes\n *\n * @param path - The string to replace\n * @returns The string with replaced backslashes\n */\nexport function formatSlash(path: string) {\n  const formatted = slash(path);\n\n  return isAbsolutePath(formatted)\n    ? formatted.replace(/\\/+$/g, \"\")\n    : formatted.replace(/^\\.\\//g, \"\").replace(/\\/+$/g, \"\");\n}\n"],"mappings":";;;;;;;AA0BA,SAAgB,MAAM,MAAc;AAClC,KAAI,KAAK,WAAW,UAAU,CAC5B,QAAO;AAGT,QAAO,KAAK,QAAQ,OAAO,IAAI"}

package/dist/pretty-path.cjs

@@ -0,0 +1,17 @@
+const require_correct_path = require('./path/src/correct-path.cjs');
+
+//#region src/pretty-path.ts
+/**
+* Format a file path to be more human-readable by removing the `file://` prefix and optionally converting it to a relative path.
+*
+* @param path - The file path to format.
+* @param options - Optional settings for how the path should be formatted.
+* @returns A human-readable version of the file path, with the `file://` prefix removed and optionally converted to a relative path based on the provided options.
+*/
+function prettyPath(path, options = {}) {
+	const formatted = path.replace(/^file:\/\//, "");
+	return require_correct_path.withoutTrailingSlash(options.relative ? require_correct_path.toRelativePath(formatted, options.cwd) : formatted);
+}
+
+//#endregion
+exports.prettyPath = prettyPath;

package/dist/pretty-path.d.cts

@@ -0,0 +1,27 @@
+//#region src/pretty-path.d.ts
+interface PrettyPathOptions {
+  /**
+   * The current working directory to use as the base for the relative path. If not provided, it defaults to `process.cwd()`.
+   */
+  cwd?: string;
+  /**
+   * Whether to return a relative path instead of an absolute path.
+   *
+   * @remarks
+   * If `true`, the function will return a path relative to the provided {@link PrettyPathOptions.cwd}.
+   *
+   * @defaultValue `false`
+   */
+  relative?: boolean;
+}
+/**
+ * Format a file path to be more human-readable by removing the `file://` prefix and optionally converting it to a relative path.
+ *
+ * @param path - The file path to format.
+ * @param options - Optional settings for how the path should be formatted.
+ * @returns A human-readable version of the file path, with the `file://` prefix removed and optionally converted to a relative path based on the provided options.
+ */
+declare function prettyPath(path: string, options?: PrettyPathOptions): string;
+//#endregion
+export { PrettyPathOptions, prettyPath };
+//# sourceMappingURL=pretty-path.d.cts.map

package/dist/pretty-path.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty-path.d.cts","names":[],"sources":["../src/pretty-path.ts"],"sourcesContent":[],"mappings":";UAoBiB,iBAAA;EAAA;AAwBjB;;;;;;;;;;;;;;;;;;;;iBAAgB,UAAA,yBAEL"}

package/dist/pretty-path.d.mts

@@ -0,0 +1,27 @@
+//#region src/pretty-path.d.ts
+interface PrettyPathOptions {
+  /**
+   * The current working directory to use as the base for the relative path. If not provided, it defaults to `process.cwd()`.
+   */
+  cwd?: string;
+  /**
+   * Whether to return a relative path instead of an absolute path.
+   *
+   * @remarks
+   * If `true`, the function will return a path relative to the provided {@link PrettyPathOptions.cwd}.
+   *
+   * @defaultValue `false`
+   */
+  relative?: boolean;
+}
+/**
+ * Format a file path to be more human-readable by removing the `file://` prefix and optionally converting it to a relative path.
+ *
+ * @param path - The file path to format.
+ * @param options - Optional settings for how the path should be formatted.
+ * @returns A human-readable version of the file path, with the `file://` prefix removed and optionally converted to a relative path based on the provided options.
+ */
+declare function prettyPath(path: string, options?: PrettyPathOptions): string;
+//#endregion
+export { PrettyPathOptions, prettyPath };
+//# sourceMappingURL=pretty-path.d.mts.map

package/dist/pretty-path.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty-path.d.mts","names":[],"sources":["../src/pretty-path.ts"],"sourcesContent":[],"mappings":";UAoBiB,iBAAA;EAAA;AAwBjB;;;;;;;;;;;;;;;;;;;;iBAAgB,UAAA,yBAEL"}

package/dist/pretty-path.mjs

@@ -0,0 +1,18 @@
+import { toRelativePath, withoutTrailingSlash } from "./path/src/correct-path.mjs";
+
+//#region src/pretty-path.ts
+/**
+* Format a file path to be more human-readable by removing the `file://` prefix and optionally converting it to a relative path.
+*
+* @param path - The file path to format.
+* @param options - Optional settings for how the path should be formatted.
+* @returns A human-readable version of the file path, with the `file://` prefix removed and optionally converted to a relative path based on the provided options.
+*/
+function prettyPath(path, options = {}) {
+	const formatted = path.replace(/^file:\/\//, "");
+	return withoutTrailingSlash(options.relative ? toRelativePath(formatted, options.cwd) : formatted);
+}
+
+//#endregion
+export { prettyPath };
+//# sourceMappingURL=pretty-path.mjs.map

package/dist/pretty-path.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty-path.mjs","names":[],"sources":["../src/pretty-path.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { toRelativePath, withoutTrailingSlash } from \"@stryke/path/normalize\";\n\nexport interface PrettyPathOptions {\n  /**\n   * The current working directory to use as the base for the relative path. If not provided, it defaults to `process.cwd()`.\n   */\n  cwd?: string;\n\n  /**\n   * Whether to return a relative path instead of an absolute path.\n   *\n   * @remarks\n   * If `true`, the function will return a path relative to the provided {@link PrettyPathOptions.cwd}.\n   *\n   * @defaultValue `false`\n   */\n  relative?: boolean;\n}\n\n/**\n * Format a file path to be more human-readable by removing the `file://` prefix and optionally converting it to a relative path.\n *\n * @param path - The file path to format.\n * @param options - Optional settings for how the path should be formatted.\n * @returns A human-readable version of the file path, with the `file://` prefix removed and optionally converted to a relative path based on the provided options.\n */\nexport function prettyPath(\n  path: string,\n  options: PrettyPathOptions = {}\n): string {\n  const formatted = path.replace(/^file:\\/\\//, \"\");\n\n  return withoutTrailingSlash(\n    options.relative ? toRelativePath(formatted, options.cwd) : formatted\n  );\n}\n"],"mappings":";;;;;;;;;;AA4CA,SAAgB,WACd,MACA,UAA6B,EAAE,EACvB;CACR,MAAM,YAAY,KAAK,QAAQ,cAAc,GAAG;AAEhD,QAAO,qBACL,QAAQ,WAAW,eAAe,WAAW,QAAQ,IAAI,GAAG,UAC7D"}

package/dist/title-case.cjs

@@ -1,3 +1,4 @@
+const require_acronyms = require('./acronyms.cjs');
 const require_combine = require('./combine.cjs');
 const require_upper_case_first = require('./upper-case-first.cjs');
 const require_decamelize = require('./decamelize.cjs');
@@ -12,7 +13,7 @@ const require_format_special_cases = require('./format-special-cases.cjs');
 * @returns The title cased string.
 */
 function titleCase(input, options) {
-	return input?.split(/\s+-\s+/).map((segment) => require_decamelize.decamelize(segment).split(/[\s\-_]/).map(require_upper_case_first.upperCaseFirst).map((value, index, array) => require_format_special_cases.formatSpecialCases(value, index, array, options)).reduce(require_combine.combine)).join(" - ");
+	return input?.split(/\s+-\s+/).map((segment) => require_decamelize.decamelize(segment).split(/[\s\-_]/).map(require_upper_case_first.upperCaseFirst).map((value) => options?.expandAcronyms ? require_acronyms.ACRONYMS[value]?.description || value : value).map((value, index, array) => require_format_special_cases.formatSpecialCases(value, index, array, options)).reduce(require_combine.combine)).join(" - ");
 }
 
 //#endregion

package/dist/title-case.d.cts

@@ -1,7 +1,17 @@
 import { FormatSpecialCasesOptions } from "./format-special-cases.cjs";
 
 //#region src/title-case.d.ts
-
+interface TitleCaseOptions extends FormatSpecialCasesOptions {
+  /**
+   * Whether to expand acronyms in the input string.
+   *
+   * @remarks
+   * If true, acronyms will be expanded to their full form before being converted to title case. For example, "NASA" would be expanded to "National Aeronautics and Space Administration".
+   *
+   * @defaultValue false
+   */
+  expandAcronyms?: boolean;
+}
 /**
  * Convert a string to title case.
  *
@@ -9,7 +19,7 @@ import { FormatSpecialCasesOptions } from "./format-special-cases.cjs";
  * @param options - Options for formatting special cases.
  * @returns The title cased string.
  */
-declare function titleCase<T extends string | undefined>(input: T, options?: FormatSpecialCasesOptions): T;
+declare function titleCase<T extends string | undefined>(input: T, options?: TitleCaseOptions): T;
 //#endregion
-export { titleCase };
+export { TitleCaseOptions, titleCase };
 //# sourceMappingURL=title-case.d.cts.map

package/dist/title-case.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"title-case.d.cts","names":[],"sources":["../src/title-case.ts"],"sourcesContent":[],"mappings":";;;;;;AA+BA;;;;;iBAAgB,+CACP,aACG,4BACT"}
+{"version":3,"file":"title-case.d.cts","names":[],"sources":["../src/title-case.ts"],"sourcesContent":[],"mappings":";;;UAyBiB,gBAAA,SAAyB;;AAA1C;AAmBA;;;;;;;;;;;;;;;iBAAgB,+CACP,aACG,mBACT"}

package/dist/title-case.d.mts

@@ -1,7 +1,17 @@
 import { FormatSpecialCasesOptions } from "./format-special-cases.mjs";
 
 //#region src/title-case.d.ts
-
+interface TitleCaseOptions extends FormatSpecialCasesOptions {
+  /**
+   * Whether to expand acronyms in the input string.
+   *
+   * @remarks
+   * If true, acronyms will be expanded to their full form before being converted to title case. For example, "NASA" would be expanded to "National Aeronautics and Space Administration".
+   *
+   * @defaultValue false
+   */
+  expandAcronyms?: boolean;
+}
 /**
  * Convert a string to title case.
  *
@@ -9,7 +19,7 @@ import { FormatSpecialCasesOptions } from "./format-special-cases.mjs";
  * @param options - Options for formatting special cases.
  * @returns The title cased string.
  */
-declare function titleCase<T extends string | undefined>(input: T, options?: FormatSpecialCasesOptions): T;
+declare function titleCase<T extends string | undefined>(input: T, options?: TitleCaseOptions): T;
 //#endregion
-export { titleCase };
+export { TitleCaseOptions, titleCase };
 //# sourceMappingURL=title-case.d.mts.map

package/dist/title-case.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"title-case.d.mts","names":[],"sources":["../src/title-case.ts"],"sourcesContent":[],"mappings":";;;;;;AA+BA;;;;;iBAAgB,+CACP,aACG,4BACT"}
+{"version":3,"file":"title-case.d.mts","names":[],"sources":["../src/title-case.ts"],"sourcesContent":[],"mappings":";;;UAyBiB,gBAAA,SAAyB;;AAA1C;AAmBA;;;;;;;;;;;;;;;iBAAgB,+CACP,aACG,mBACT"}

package/dist/title-case.mjs

@@ -1,3 +1,4 @@
+import { ACRONYMS } from "./acronyms.mjs";
 import { combine } from "./combine.mjs";
 import { upperCaseFirst } from "./upper-case-first.mjs";
 import { decamelize } from "./decamelize.mjs";
@@ -12,7 +13,7 @@ import { formatSpecialCases } from "./format-special-cases.mjs";
 * @returns The title cased string.
 */
 function titleCase(input, options) {
-	return input?.split(/\s+-\s+/).map((segment) => decamelize(segment).split(/[\s\-_]/).map(upperCaseFirst).map((value, index, array) => formatSpecialCases(value, index, array, options)).reduce(combine)).join(" - ");
+	return input?.split(/\s+-\s+/).map((segment) => decamelize(segment).split(/[\s\-_]/).map(upperCaseFirst).map((value) => options?.expandAcronyms ? ACRONYMS[value]?.description || value : value).map((value, index, array) => formatSpecialCases(value, index, array, options)).reduce(combine)).join(" - ");
 }
 
 //#endregion

package/dist/title-case.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"title-case.mjs","names":[],"sources":["../src/title-case.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { combine } from \"./combine\";\nimport { decamelize } from \"./decamelize\";\nimport type { FormatSpecialCasesOptions } from \"./format-special-cases\";\nimport { formatSpecialCases } from \"./format-special-cases\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\n/**\n * Convert a string to title case.\n *\n * @param input - The input string to convert.\n * @param options - Options for formatting special cases.\n * @returns The title cased string.\n */\nexport function titleCase<T extends string | undefined>(\n  input: T,\n  options?: FormatSpecialCasesOptions\n): T {\n  return input\n    ?.split(/\\s+-\\s+/)\n    .map(segment =>\n      decamelize(segment)\n        .split(/[\\s\\-_]/)\n        .map(upperCaseFirst)\n        .map((value: string, index: number, array: string[]) =>\n          formatSpecialCases(value, index, array, options)\n        )\n        .reduce(combine)\n    )\n    .join(\" - \") as T;\n}\n"],"mappings":";;;;;;;;;;;;;AA+BA,SAAgB,UACd,OACA,SACG;AACH,QAAO,OACH,MAAM,UAAU,CACjB,KAAI,YACH,WAAW,QAAQ,CAChB,MAAM,UAAU,CAChB,IAAI,eAAe,CACnB,KAAK,OAAe,OAAe,UAClC,mBAAmB,OAAO,OAAO,OAAO,QAAQ,CACjD,CACA,OAAO,QAAQ,CACnB,CACA,KAAK,MAAM"}
+{"version":3,"file":"title-case.mjs","names":[],"sources":["../src/title-case.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { ACRONYMS } from \"./acronyms\";\nimport { combine } from \"./combine\";\nimport { decamelize } from \"./decamelize\";\nimport type { FormatSpecialCasesOptions } from \"./format-special-cases\";\nimport { formatSpecialCases } from \"./format-special-cases\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\nexport interface TitleCaseOptions extends FormatSpecialCasesOptions {\n  /**\n   * Whether to expand acronyms in the input string.\n   *\n   * @remarks\n   * If true, acronyms will be expanded to their full form before being converted to title case. For example, \"NASA\" would be expanded to \"National Aeronautics and Space Administration\".\n   *\n   * @defaultValue false\n   */\n  expandAcronyms?: boolean;\n}\n\n/**\n * Convert a string to title case.\n *\n * @param input - The input string to convert.\n * @param options - Options for formatting special cases.\n * @returns The title cased string.\n */\nexport function titleCase<T extends string | undefined>(\n  input: T,\n  options?: TitleCaseOptions\n): T {\n  return input\n    ?.split(/\\s+-\\s+/)\n    .map(segment =>\n      decamelize(segment)\n        .split(/[\\s\\-_]/)\n        .map(upperCaseFirst)\n        .map(value =>\n          options?.expandAcronyms\n            ? ACRONYMS[value]?.description || value\n            : value\n        )\n        .map((value: string, index: number, array: string[]) =>\n          formatSpecialCases(value, index, array, options)\n        )\n        .reduce(combine)\n    )\n    .join(\" - \") as T;\n}\n"],"mappings":";;;;;;;;;;;;;;AA4CA,SAAgB,UACd,OACA,SACG;AACH,QAAO,OACH,MAAM,UAAU,CACjB,KAAI,YACH,WAAW,QAAQ,CAChB,MAAM,UAAU,CAChB,IAAI,eAAe,CACnB,KAAI,UACH,SAAS,iBACL,SAAS,QAAQ,eAAe,QAChC,MACL,CACA,KAAK,OAAe,OAAe,UAClC,mBAAmB,OAAO,OAAO,OAAO,QAAQ,CACjD,CACA,OAAO,QAAQ,CACnB,CACA,KAAK,MAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.14.8",
+  "version": "0.16.0",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -61,6 +61,7 @@
       "require": "./dist/kebab-case.cjs",
       "import": "./dist/kebab-case.mjs"
     },
+    "./list": { "require": "./dist/list.cjs", "import": "./dist/list.mjs" },
     "./lower-case-first": {
       "require": "./dist/lower-case-first.cjs",
       "import": "./dist/lower-case-first.mjs"
@@ -94,6 +95,10 @@
       "require": "./dist/pretty-bytes.cjs",
       "import": "./dist/pretty-bytes.mjs"
     },
+    "./pretty-path": {
+      "require": "./dist/pretty-path.cjs",
+      "import": "./dist/pretty-path.mjs"
+    },
     "./snake-case": {
       "require": "./dist/snake-case.cjs",
       "import": "./dist/snake-case.mjs"
@@ -129,7 +134,8 @@
     "./*": "./*"
   },
   "types": "./dist/index.d.cts",
+  "dependencies": { "@stryke/path": "^0.26.15" },
   "devDependencies": { "tsdown": "^0.17.2" },
   "publishConfig": { "access": "public" },
-  "gitHead": "7d12d78184a0812114d762186fe34f82d9e9083d"
+  "gitHead": "6e83233262e8614cd725c601173e20c877d4c60d"
 }