@stryke/fs 0.33.38 → 0.33.39

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 # Changelog for Stryke - Fs
 
+## [0.33.38](https://github.com/storm-software/stryke/releases/tag/fs%400.33.38) (01/26/2026)
+
+### Updated Dependencies
+
+- Updated **string-format** to **v0.13.6**
+- Updated **type-checks** to **v0.5.22**
+- Updated **convert** to **v0.6.37**
+- Updated **helpers** to **v0.9.39**
+- Updated **types** to **v0.10.36**
+- Updated **json** to **v0.9.40**
+- Updated **path** to **v0.26.2**
+
 ## [0.33.37](https://github.com/storm-software/stryke/releases/tag/fs%400.33.37) (01/25/2026)
 
 ### Updated Dependencies

package/dist/path/src/file-path-fns.cjs

@@ -47,10 +47,10 @@ function findFileName(filePath, options = {}) {
 */
 function findFilePath(filePath, options = {}) {
 	const normalizedPath = require_correct_path.normalizeWindowsPath(filePath);
-	const result = normalizedPath.replace(findFileName(normalizedPath, {
+	const result = normalizedPath.replace(/* @__PURE__ */ new RegExp(`\/${findFileName(normalizedPath, {
 		requireExtension: false,
 		...options
-	}), "");
+	})}$`), "");
 	return result === "/" ? result : result.replace(/\/$/, "");
 }
 /**

package/dist/path/src/file-path-fns.mjs

@@ -44,10 +44,10 @@ function findFileName(filePath, options = {}) {
 */
 function findFilePath(filePath, options = {}) {
 	const normalizedPath = normalizeWindowsPath(filePath);
-	const result = normalizedPath.replace(findFileName(normalizedPath, {
+	const result = normalizedPath.replace(/* @__PURE__ */ new RegExp(`\/${findFileName(normalizedPath, {
 		requireExtension: false,
 		...options
-	}), "");
+	})}$`), "");
 	return result === "/" ? result : result.replace(/\/$/, "");
 }
 /**

package/dist/path/src/file-path-fns.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"file-path-fns.mjs","names":["currentDir"],"sources":["../../../../path/src/file-path-fns.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 { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { EMPTY_STRING } from \"@stryke/types/base\";\nimport _path from \"node:path\";\nimport { normalizeString, normalizeWindowsPath } from \"./correct-path\";\nimport { cwd as currentDir } from \"./cwd\";\nimport { isAbsolute, isAbsolutePath } from \"./is-type\";\nimport { joinPaths } from \"./join-paths\";\nimport {\n  FILE_EXTENSION_REGEX,\n  FULL_FILE_EXTENSION_REGEX,\n  ROOT_FOLDER_REGEX\n} from \"./regex\";\n\nexport interface FindFileNameOptions extends FindFileExtensionOptions {\n  /**\n   * Require the file extension to be present in the file name.\n   *\n   * @defaultValue false\n   */\n  requireExtension?: boolean;\n\n  /**\n   * Return the file extension as part of the full file name result.\n   *\n   * @defaultValue true\n   */\n  withExtension?: boolean;\n}\n\n/**\n * Find the file name from a file path.\n *\n * @example\n * ```ts\n * const fileName = findFileName(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // fileName = \"file.txt\"\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file name\n */\nexport function findFileName(\n  filePath: string,\n  options: FindFileNameOptions = {}\n): string {\n  const { requireExtension = false, withExtension = true } = options;\n  const result =\n    normalizeWindowsPath(filePath)\n      ?.split(filePath?.includes(\"\\\\\") ? \"\\\\\" : \"/\")\n      ?.pop() ?? \"\";\n\n  if (requireExtension === true && !result.includes(\".\")) {\n    return EMPTY_STRING;\n  }\n\n  if (withExtension === false && result.includes(\".\")) {\n    return (\n      result.replace(`.${findFileExtension(result, options) ?? \"\"}`, \"\") ||\n      EMPTY_STRING\n    );\n  }\n\n  return result;\n}\n\n/**\n * Find the full file path's directories from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link _path.dirname} function in Node's path module.\n *\n * @example\n * ```ts\n * const folderPath = findFilePath(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // folderPath = \"C:\\\\Users\\\\user\\\\Documents\"\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The full file path's directories\n */\nexport function findFilePath(\n  filePath: string,\n  options: FindFileNameOptions = {}\n): string {\n  const normalizedPath = normalizeWindowsPath(filePath);\n\n  const result = normalizedPath.replace(\n    findFileName(normalizedPath, { requireExtension: false, ...options }),\n    \"\"\n  );\n\n  return result === \"/\" ? result : result.replace(/\\/$/, \"\");\n}\n\nexport const dirname = findFilePath;\n\n/**\n * Find the top most folder containing the file from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link _path.basename} function in Node's path module.\n * If you're looking for the full path of the folder (for example: `C:\\\\Users\\\\user\\\\Documents` instead of just `Documents`) containing the file, use {@link findFilePath} instead.\n *\n * @example\n * const folderPath = findFolderName(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // folderPath = \"Documents\"\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The folder containing the file\n */\nexport function findFolderName(\n  filePath: string,\n  options?: FindFileNameOptions\n): string {\n  const segments = findFilePath(filePath, options).split(\"/\");\n\n  let lastSegment = \"\";\n  for (let i = segments.length - 1; i >= 0; i--) {\n    const val = segments[i];\n    if (val) {\n      lastSegment = val;\n      break;\n    }\n  }\n\n  // if (\n  //   folderPath.lastIndexOf(\"\\\\\") === folderPath.length - 1 ||\n  //   folderPath.lastIndexOf(\"/\") === folderPath.length - 1\n  // ) {\n  //   folderPath = folderPath.slice(0, Math.max(0, folderPath.length - 1));\n  // }\n\n  return lastSegment ?? EMPTY_STRING;\n}\n\nexport const basename = findFolderName;\n\nexport interface FindFileExtensionOptions {\n  /**\n   * Return the full file extension including `.d` and `.map` if present.\n   *\n   * @defaultValue false\n   */\n  fullExtension?: boolean;\n}\n\n/**\n * Find the file extension from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link path.extname} function in Node's path module.\n * The file extension is the part of the file name that comes after the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.\n *\n * @example\n * ```ts\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.config.ts\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.d.ts\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.d.ts\", { fullExtension: true }); // Returns \"d.ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.ts.map\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.ts.map\", { fullExtension: true }); // Returns \"ts.map\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file\"); // Returns undefined\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension or undefined if no extension is found\n */\nexport function findFileExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string | undefined {\n  if (filePath.endsWith(\".\") || filePath.endsWith(\"/\")) {\n    return undefined;\n  }\n\n  const match = (\n    options?.fullExtension ? FULL_FILE_EXTENSION_REGEX : FILE_EXTENSION_REGEX\n  ).exec(normalizeWindowsPath(filePath));\n\n  return match && match.length > 0 && isSetString(match[0])\n    ? match[0].replace(\".\", \"\")\n    : undefined;\n}\n\nexport const extname = findFileExtension;\n\n/**\n * Find the file extension including the `\".\"` character prefix from a file path.\n *\n * @remarks\n * The file extension is the part of the file name that comes after (and including) the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will** include the dot, for example `.txt` or `.js` instead of `txt` or `js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension (including the `\".\"` prefix) or undefined if no extension is found\n */\nexport function findFileDotExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string | undefined {\n  const ext = findFileExtension(filePath, options);\n\n  return ext ? `.${ext}` : undefined;\n}\n\n/**\n * Find the file extension from a file path or an empty string.\n *\n *  @remarks\n * The file extension is the part of the file name that comes after the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension or an empty string if no extension is found\n */\nexport function findFileExtensionSafe(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string {\n  return findFileExtension(filePath, options) ?? EMPTY_STRING;\n}\n\n/**\n * Find the file extension including the `\".\"` character prefix from a file path or an empty string.\n *\n *  @remarks\n * The file extension is the part of the file name that comes after (and including) the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will** include the dot, for example `.txt` or `.js` instead of `txt` or `js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension (including the `\".\"` prefix) or an empty string if no extension is found\n */\nexport function findFileDotExtensionSafe(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string {\n  const ext = findFileExtension(filePath, options);\n\n  return ext ? `.${ext}` : \"\";\n}\n\n/**\n * Check if a file path has a file name.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a file name\n */\nexport function hasFileName(filePath: string): boolean {\n  return Boolean(findFileName(filePath));\n}\n\n/**\n * Check if a file path has a file path.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a file path\n */\nexport function hasFilePath(filePath: string): boolean {\n  return Boolean(findFilePath(filePath));\n}\n\n/**\n * Check if a file path has a folder name.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a folder name\n */\nexport function hasFolderName(filePath: string): boolean {\n  return Boolean(findFolderName(filePath));\n}\n\n/**\n * Check if a file path has a file extension.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns An indicator specifying if the file path has a file extension\n */\nexport function hasFileExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): boolean {\n  return Boolean(findFileExtension(filePath, options));\n}\n\n/**\n * Resolve the file path to an absolute path.\n *\n * @param path - The path to resolve\n * @param cwd - The current working directory\n * @returns The resolved path\n */\nexport function resolvePath(path: string, cwd = currentDir()) {\n  // Normalize windows arguments\n  const paths = normalizeWindowsPath(path).split(\"/\");\n\n  let resolvedPath = \"\";\n  let resolvedAbsolute = false;\n\n  for (\n    let index = paths.length - 1;\n    index >= -1 && !resolvedAbsolute;\n    index--\n  ) {\n    const path = index >= 0 ? paths[index] : cwd;\n\n    // Skip empty entries\n    if (!path || path.length === 0) {\n      continue;\n    }\n\n    resolvedPath = joinPaths(path, resolvedPath);\n    resolvedAbsolute = isAbsolutePath(path);\n  }\n\n  // At this point the path should be resolved to a full absolute path, but\n  // handle relative paths to be safe (might happen when process.cwd() fails)\n\n  // Normalize the path\n  resolvedPath = normalizeString(resolvedPath, !resolvedAbsolute);\n\n  if (resolvedAbsolute && !isAbsolutePath(resolvedPath)) {\n    return `/${resolvedPath}`;\n  }\n\n  return resolvedPath.length > 0 ? resolvedPath : \".\";\n}\n\nexport function resolve(...paths: string[]) {\n  // Normalize windows arguments\n  paths = paths.map(argument => normalizeWindowsPath(argument));\n\n  let resolvedPath = \"\";\n  let resolvedAbsolute = false;\n\n  for (\n    let index = paths.length - 1;\n    index >= -1 && !resolvedAbsolute;\n    index--\n  ) {\n    const path = index >= 0 ? paths[index] : currentDir();\n\n    // Skip empty entries\n    if (!path || path.length === 0) {\n      continue;\n    }\n\n    resolvedPath = `${path}/${resolvedPath}`;\n    resolvedAbsolute = isAbsolute(path);\n  }\n\n  // At this point the path should be resolved to a full absolute path, but\n  // handle relative paths to be safe (might happen when process.cwd() fails)\n\n  // Normalize the path\n  resolvedPath = normalizeString(resolvedPath, !resolvedAbsolute);\n\n  if (resolvedAbsolute && !isAbsolute(resolvedPath)) {\n    return `/${resolvedPath}`;\n  }\n\n  return resolvedPath.length > 0 ? resolvedPath : \".\";\n}\n\n/**\n * Resolve the file path to an absolute path.\n *\n * @param paths - The paths to resolve\n * @returns The resolved path\n */\nexport function resolvePaths(...paths: string[]) {\n  return resolvePath(\n    joinPaths(...paths.map(path => normalizeWindowsPath(path)))\n  );\n}\n\n/**\n * Get the relative path from one file to another.\n *\n * @remarks\n * This function is similar to the `path.relative` function in Node's path module.\n *\n * @param from - The base path to start from\n * @param to - The target path to resolve relative to the base path\n * @returns The relative path from the base path to the target path\n */\nexport function relative(from: string, to: string) {\n  // we cast these because `split` will always be at least one string\n  const _from = resolve(from).replace(ROOT_FOLDER_REGEX, \"$1\").split(\"/\") as [\n    string,\n    ...string[]\n  ];\n  const _to = resolve(to).replace(ROOT_FOLDER_REGEX, \"$1\").split(\"/\") as [\n    string,\n    ...string[]\n  ];\n\n  // Different windows drive letters\n  if (_to[0][1] === \":\" && _from[0][1] === \":\" && _from[0] !== _to[0]) {\n    return _to.join(\"/\");\n  }\n\n  const _fromCopy = [..._from];\n  for (const segment of _fromCopy) {\n    if (_to[0] !== segment) {\n      break;\n    }\n    _from.shift();\n    _to.shift();\n  }\n  return [..._from.map(() => \"..\"), ..._to].join(\"/\");\n}\n\n/**\n * Get the relative path from one file to another.\n *\n * @remarks\n * This function wraps the `path.relative` function in Node's path module.\n *\n * @param from - The base path to start from\n * @param to - The target path to resolve relative to the base path\n * @param withEndSlash - Whether to include a trailing slash at the end of the path\n * @returns The relative path from the base path to the target path\n */\nexport function relativePath(from: string, to: string, withEndSlash = false) {\n  return relative(\n    withEndSlash !== true ? from.replace(/\\/$/, \"\") : from,\n    withEndSlash !== true ? to.replace(/\\/$/, \"\") : to\n  );\n}\n\n/**\n * Find the file path relative to the workspace root path.\n *\n * @param filePath - The file path to process\n * @returns The resolved file path\n */\nexport function relativeToCurrentDir(filePath: string) {\n  return relativePath(filePath, currentDir());\n}\n\n/**\n * Check if the path is a relative path.\n *\n * @param path - The path to check\n * @returns An indicator specifying if the path is a relative path\n */\nexport function parsePath(path: string, options?: FindFileNameOptions) {\n  // The root of the path such as '/' or 'c:\\'\n  const root =\n    /^[/\\\\]|^[a-z]:[/\\\\]/i.exec(path)?.[0]?.replace(/\\\\/g, \"/\") || \"\";\n\n  const normalizedPath = normalizeWindowsPath(path);\n\n  const segments = normalizedPath.replace(/\\/$/, \"\").split(\"/\").slice(0, -1);\n  if (segments.length === 1 && /^[A-Z]:$/i.test(segments[0] as string)) {\n    segments[0] += \"/\";\n  }\n\n  const base = findFolderName(normalizedPath, options);\n  const dir = segments.join(\"/\") || (isAbsolutePath(path) ? \"/\" : \".\");\n  const ext = findFileExtensionSafe(path, options);\n\n  return {\n    root,\n    dir,\n    base,\n    ext,\n    name: base.slice(0, base.length - ext.length)\n  };\n}\n\n/**\n * Rename the file name with a new name.\n *\n * @param filePath - The current file path being processed\n * @param newFileName - The updated file name being processed\n * @param options - Options to control the file name extraction\n * @returns The modified or unmodified file path.\n */\nexport function renameFile(\n  filePath: string,\n  newFileName: string,\n  options?: FindFileNameOptions\n): string {\n  const file = parsePath(filePath, options);\n\n  return joinPaths(\n    file.dir,\n    newFileName.includes(\".\") ? newFileName : newFileName + file.ext\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,aACd,UACA,UAA+B,EAAE,EACzB;CACR,MAAM,EAAE,mBAAmB,OAAO,gBAAgB,SAAS;CAC3D,MAAM,SACJ,qBAAqB,SAAS,EAC1B,MAAM,UAAU,SAAS,KAAK,GAAG,OAAO,IAAI,EAC5C,KAAK,IAAI;AAEf,KAAI,qBAAqB,QAAQ,CAAC,OAAO,SAAS,IAAI,CACpD,QAAO;AAGT,KAAI,kBAAkB,SAAS,OAAO,SAAS,IAAI,CACjD,QACE,OAAO,QAAQ,IAAI,kBAAkB,QAAQ,QAAQ,IAAI,MAAM,GAAG,IAClE;AAIJ,QAAO;;;;;;;;;;;;;;;;;;AAmBT,SAAgB,aACd,UACA,UAA+B,EAAE,EACzB;CACR,MAAM,iBAAiB,qBAAqB,SAAS;CAErD,MAAM,SAAS,eAAe,QAC5B,aAAa,gBAAgB;EAAE,kBAAkB;EAAO,GAAG;EAAS,CAAC,EACrE,GACD;AAED,QAAO,WAAW,MAAM,SAAS,OAAO,QAAQ,OAAO,GAAG;;;;;;;;;;;;;;;;;AAoB5D,SAAgB,eACd,UACA,SACQ;CACR,MAAM,WAAW,aAAa,UAAU,QAAQ,CAAC,MAAM,IAAI;CAE3D,IAAI,cAAc;AAClB,MAAK,IAAI,IAAI,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK;EAC7C,MAAM,MAAM,SAAS;AACrB,MAAI,KAAK;AACP,iBAAc;AACd;;;AAWJ,QAAO,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;AAqCxB,SAAgB,kBACd,UACA,SACoB;AACpB,KAAI,SAAS,SAAS,IAAI,IAAI,SAAS,SAAS,IAAI,CAClD;CAGF,MAAM,SACJ,SAAS,gBAAgB,4BAA4B,sBACrD,KAAK,qBAAqB,SAAS,CAAC;AAEtC,QAAO,SAAS,MAAM,SAAS,KAAK,YAAY,MAAM,GAAG,GACrD,MAAM,GAAG,QAAQ,KAAK,GAAG,GACzB;;;;;;;;;AAuGN,SAAgB,iBACd,UACA,SACS;AACT,QAAO,QAAQ,kBAAkB,UAAU,QAAQ,CAAC;;AA8CtD,SAAgB,QAAQ,GAAG,OAAiB;AAE1C,SAAQ,MAAM,KAAI,aAAY,qBAAqB,SAAS,CAAC;CAE7D,IAAI,eAAe;CACnB,IAAI,mBAAmB;AAEvB,MACE,IAAI,QAAQ,MAAM,SAAS,GAC3B,SAAS,MAAM,CAAC,kBAChB,SACA;EACA,MAAM,OAAO,SAAS,IAAI,MAAM,SAASA,KAAY;AAGrD,MAAI,CAAC,QAAQ,KAAK,WAAW,EAC3B;AAGF,iBAAe,GAAG,KAAK,GAAG;AAC1B,qBAAmB,WAAW,KAAK;;AAOrC,gBAAe,gBAAgB,cAAc,CAAC,iBAAiB;AAE/D,KAAI,oBAAoB,CAAC,WAAW,aAAa,CAC/C,QAAO,IAAI;AAGb,QAAO,aAAa,SAAS,IAAI,eAAe;;;;;;;;;;;;AAyBlD,SAAgB,SAAS,MAAc,IAAY;CAEjD,MAAM,QAAQ,QAAQ,KAAK,CAAC,QAAQ,mBAAmB,KAAK,CAAC,MAAM,IAAI;CAIvE,MAAM,MAAM,QAAQ,GAAG,CAAC,QAAQ,mBAAmB,KAAK,CAAC,MAAM,IAAI;AAMnE,KAAI,IAAI,GAAG,OAAO,OAAO,MAAM,GAAG,OAAO,OAAO,MAAM,OAAO,IAAI,GAC/D,QAAO,IAAI,KAAK,IAAI;CAGtB,MAAM,YAAY,CAAC,GAAG,MAAM;AAC5B,MAAK,MAAM,WAAW,WAAW;AAC/B,MAAI,IAAI,OAAO,QACb;AAEF,QAAM,OAAO;AACb,MAAI,OAAO;;AAEb,QAAO,CAAC,GAAG,MAAM,UAAU,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,IAAI;;;;;;;;;;;;;AAcrD,SAAgB,aAAa,MAAc,IAAY,eAAe,OAAO;AAC3E,QAAO,SACL,iBAAiB,OAAO,KAAK,QAAQ,OAAO,GAAG,GAAG,MAClD,iBAAiB,OAAO,GAAG,QAAQ,OAAO,GAAG,GAAG,GACjD"}
+{"version":3,"file":"file-path-fns.mjs","names":["currentDir"],"sources":["../../../../path/src/file-path-fns.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 { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { EMPTY_STRING } from \"@stryke/types/base\";\nimport _path from \"node:path\";\nimport { normalizeString, normalizeWindowsPath } from \"./correct-path\";\nimport { cwd as currentDir } from \"./cwd\";\nimport { isAbsolute, isAbsolutePath } from \"./is-type\";\nimport { joinPaths } from \"./join-paths\";\nimport {\n  FILE_EXTENSION_REGEX,\n  FULL_FILE_EXTENSION_REGEX,\n  ROOT_FOLDER_REGEX\n} from \"./regex\";\n\nexport interface FindFileNameOptions extends FindFileExtensionOptions {\n  /**\n   * Require the file extension to be present in the file name.\n   *\n   * @defaultValue false\n   */\n  requireExtension?: boolean;\n\n  /**\n   * Return the file extension as part of the full file name result.\n   *\n   * @defaultValue true\n   */\n  withExtension?: boolean;\n}\n\n/**\n * Find the file name from a file path.\n *\n * @example\n * ```ts\n * const fileName = findFileName(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // fileName = \"file.txt\"\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file name\n */\nexport function findFileName(\n  filePath: string,\n  options: FindFileNameOptions = {}\n): string {\n  const { requireExtension = false, withExtension = true } = options;\n  const result =\n    normalizeWindowsPath(filePath)\n      ?.split(filePath?.includes(\"\\\\\") ? \"\\\\\" : \"/\")\n      ?.pop() ?? \"\";\n\n  if (requireExtension === true && !result.includes(\".\")) {\n    return EMPTY_STRING;\n  }\n\n  if (withExtension === false && result.includes(\".\")) {\n    return (\n      result.replace(`.${findFileExtension(result, options) ?? \"\"}`, \"\") ||\n      EMPTY_STRING\n    );\n  }\n\n  return result;\n}\n\n/**\n * Find the full file path's directories from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link _path.dirname} function in Node's path module.\n *\n * @example\n * ```ts\n * const folderPath = findFilePath(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // folderPath = \"C:\\\\Users\\\\user\\\\Documents\"\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The full file path's directories\n */\nexport function findFilePath(\n  filePath: string,\n  options: FindFileNameOptions = {}\n): string {\n  const normalizedPath = normalizeWindowsPath(filePath);\n\n  const result = normalizedPath.replace(\n    new RegExp(\n      `\\/${findFileName(normalizedPath, { requireExtension: false, ...options })}$`\n    ),\n    \"\"\n  );\n\n  return result === \"/\" ? result : result.replace(/\\/$/, \"\");\n}\n\nexport const dirname = findFilePath;\n\n/**\n * Find the top most folder containing the file from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link _path.basename} function in Node's path module.\n * If you're looking for the full path of the folder (for example: `C:\\\\Users\\\\user\\\\Documents` instead of just `Documents`) containing the file, use {@link findFilePath} instead.\n *\n * @example\n * const folderPath = findFolderName(\"C:\\\\Users\\\\user\\\\Documents\\\\file.txt\");\n * // folderPath = \"Documents\"\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The folder containing the file\n */\nexport function findFolderName(\n  filePath: string,\n  options?: FindFileNameOptions\n): string {\n  const segments = findFilePath(filePath, options).split(\"/\");\n\n  let lastSegment = \"\";\n  for (let i = segments.length - 1; i >= 0; i--) {\n    const val = segments[i];\n    if (val) {\n      lastSegment = val;\n      break;\n    }\n  }\n\n  // if (\n  //   folderPath.lastIndexOf(\"\\\\\") === folderPath.length - 1 ||\n  //   folderPath.lastIndexOf(\"/\") === folderPath.length - 1\n  // ) {\n  //   folderPath = folderPath.slice(0, Math.max(0, folderPath.length - 1));\n  // }\n\n  return lastSegment ?? EMPTY_STRING;\n}\n\nexport const basename = findFolderName;\n\nexport interface FindFileExtensionOptions {\n  /**\n   * Return the full file extension including `.d` and `.map` if present.\n   *\n   * @defaultValue false\n   */\n  fullExtension?: boolean;\n}\n\n/**\n * Find the file extension from a file path.\n *\n * @remarks\n * The functionality of this method is similar to the {@link path.extname} function in Node's path module.\n * The file extension is the part of the file name that comes after the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.\n *\n * @example\n * ```ts\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.config.ts\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.d.ts\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.d.ts\", { fullExtension: true }); // Returns \"d.ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.ts.map\"); // Returns \"ts\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file.ts.map\", { fullExtension: true }); // Returns \"ts.map\"\n * findFileExtension(\"C:\\\\Users\\\\user\\\\Documents\\\\file\"); // Returns undefined\n * ```\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension or undefined if no extension is found\n */\nexport function findFileExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string | undefined {\n  if (filePath.endsWith(\".\") || filePath.endsWith(\"/\")) {\n    return undefined;\n  }\n\n  const match = (\n    options?.fullExtension ? FULL_FILE_EXTENSION_REGEX : FILE_EXTENSION_REGEX\n  ).exec(normalizeWindowsPath(filePath));\n\n  return match && match.length > 0 && isSetString(match[0])\n    ? match[0].replace(\".\", \"\")\n    : undefined;\n}\n\nexport const extname = findFileExtension;\n\n/**\n * Find the file extension including the `\".\"` character prefix from a file path.\n *\n * @remarks\n * The file extension is the part of the file name that comes after (and including) the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will** include the dot, for example `.txt` or `.js` instead of `txt` or `js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension (including the `\".\"` prefix) or undefined if no extension is found\n */\nexport function findFileDotExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string | undefined {\n  const ext = findFileExtension(filePath, options);\n\n  return ext ? `.${ext}` : undefined;\n}\n\n/**\n * Find the file extension from a file path or an empty string.\n *\n *  @remarks\n * The file extension is the part of the file name that comes after the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension or an empty string if no extension is found\n */\nexport function findFileExtensionSafe(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string {\n  return findFileExtension(filePath, options) ?? EMPTY_STRING;\n}\n\n/**\n * Find the file extension including the `\".\"` character prefix from a file path or an empty string.\n *\n *  @remarks\n * The file extension is the part of the file name that comes after (and including) the last dot (`.`) in the file name. If the file name does not contain a dot, or if it ends with a dot, this function will return `undefined`.\n *\n * The returned extension **will** include the dot, for example `.txt` or `.js` instead of `txt` or `js`.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns The file extension (including the `\".\"` prefix) or an empty string if no extension is found\n */\nexport function findFileDotExtensionSafe(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): string {\n  const ext = findFileExtension(filePath, options);\n\n  return ext ? `.${ext}` : \"\";\n}\n\n/**\n * Check if a file path has a file name.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a file name\n */\nexport function hasFileName(filePath: string): boolean {\n  return Boolean(findFileName(filePath));\n}\n\n/**\n * Check if a file path has a file path.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a file path\n */\nexport function hasFilePath(filePath: string): boolean {\n  return Boolean(findFilePath(filePath));\n}\n\n/**\n * Check if a file path has a folder name.\n *\n * @param filePath - The file path to process\n * @returns An indicator specifying if the file path has a folder name\n */\nexport function hasFolderName(filePath: string): boolean {\n  return Boolean(findFolderName(filePath));\n}\n\n/**\n * Check if a file path has a file extension.\n *\n * @param filePath - The file path to process\n * @param options - Options to control the file name extraction\n * @returns An indicator specifying if the file path has a file extension\n */\nexport function hasFileExtension(\n  filePath: string,\n  options?: FindFileExtensionOptions\n): boolean {\n  return Boolean(findFileExtension(filePath, options));\n}\n\n/**\n * Resolve the file path to an absolute path.\n *\n * @param path - The path to resolve\n * @param cwd - The current working directory\n * @returns The resolved path\n */\nexport function resolvePath(path: string, cwd = currentDir()) {\n  // Normalize windows arguments\n  const paths = normalizeWindowsPath(path).split(\"/\");\n\n  let resolvedPath = \"\";\n  let resolvedAbsolute = false;\n\n  for (\n    let index = paths.length - 1;\n    index >= -1 && !resolvedAbsolute;\n    index--\n  ) {\n    const path = index >= 0 ? paths[index] : cwd;\n\n    // Skip empty entries\n    if (!path || path.length === 0) {\n      continue;\n    }\n\n    resolvedPath = joinPaths(path, resolvedPath);\n    resolvedAbsolute = isAbsolutePath(path);\n  }\n\n  // At this point the path should be resolved to a full absolute path, but\n  // handle relative paths to be safe (might happen when process.cwd() fails)\n\n  // Normalize the path\n  resolvedPath = normalizeString(resolvedPath, !resolvedAbsolute);\n\n  if (resolvedAbsolute && !isAbsolutePath(resolvedPath)) {\n    return `/${resolvedPath}`;\n  }\n\n  return resolvedPath.length > 0 ? resolvedPath : \".\";\n}\n\nexport function resolve(...paths: string[]) {\n  // Normalize windows arguments\n  paths = paths.map(argument => normalizeWindowsPath(argument));\n\n  let resolvedPath = \"\";\n  let resolvedAbsolute = false;\n\n  for (\n    let index = paths.length - 1;\n    index >= -1 && !resolvedAbsolute;\n    index--\n  ) {\n    const path = index >= 0 ? paths[index] : currentDir();\n\n    // Skip empty entries\n    if (!path || path.length === 0) {\n      continue;\n    }\n\n    resolvedPath = `${path}/${resolvedPath}`;\n    resolvedAbsolute = isAbsolute(path);\n  }\n\n  // At this point the path should be resolved to a full absolute path, but\n  // handle relative paths to be safe (might happen when process.cwd() fails)\n\n  // Normalize the path\n  resolvedPath = normalizeString(resolvedPath, !resolvedAbsolute);\n\n  if (resolvedAbsolute && !isAbsolute(resolvedPath)) {\n    return `/${resolvedPath}`;\n  }\n\n  return resolvedPath.length > 0 ? resolvedPath : \".\";\n}\n\n/**\n * Resolve the file path to an absolute path.\n *\n * @param paths - The paths to resolve\n * @returns The resolved path\n */\nexport function resolvePaths(...paths: string[]) {\n  return resolvePath(\n    joinPaths(...paths.map(path => normalizeWindowsPath(path)))\n  );\n}\n\n/**\n * Get the relative path from one file to another.\n *\n * @remarks\n * This function is similar to the `path.relative` function in Node's path module.\n *\n * @param from - The base path to start from\n * @param to - The target path to resolve relative to the base path\n * @returns The relative path from the base path to the target path\n */\nexport function relative(from: string, to: string) {\n  // we cast these because `split` will always be at least one string\n  const _from = resolve(from).replace(ROOT_FOLDER_REGEX, \"$1\").split(\"/\") as [\n    string,\n    ...string[]\n  ];\n  const _to = resolve(to).replace(ROOT_FOLDER_REGEX, \"$1\").split(\"/\") as [\n    string,\n    ...string[]\n  ];\n\n  // Different windows drive letters\n  if (_to[0][1] === \":\" && _from[0][1] === \":\" && _from[0] !== _to[0]) {\n    return _to.join(\"/\");\n  }\n\n  const _fromCopy = [..._from];\n  for (const segment of _fromCopy) {\n    if (_to[0] !== segment) {\n      break;\n    }\n    _from.shift();\n    _to.shift();\n  }\n  return [..._from.map(() => \"..\"), ..._to].join(\"/\");\n}\n\n/**\n * Get the relative path from one file to another.\n *\n * @remarks\n * This function wraps the `path.relative` function in Node's path module.\n *\n * @param from - The base path to start from\n * @param to - The target path to resolve relative to the base path\n * @param withEndSlash - Whether to include a trailing slash at the end of the path\n * @returns The relative path from the base path to the target path\n */\nexport function relativePath(from: string, to: string, withEndSlash = false) {\n  return relative(\n    withEndSlash !== true ? from.replace(/\\/$/, \"\") : from,\n    withEndSlash !== true ? to.replace(/\\/$/, \"\") : to\n  );\n}\n\n/**\n * Find the file path relative to the workspace root path.\n *\n * @param filePath - The file path to process\n * @returns The resolved file path\n */\nexport function relativeToCurrentDir(filePath: string) {\n  return relativePath(filePath, currentDir());\n}\n\n/**\n * Check if the path is a relative path.\n *\n * @param path - The path to check\n * @returns An indicator specifying if the path is a relative path\n */\nexport function parsePath(path: string, options?: FindFileNameOptions) {\n  // The root of the path such as '/' or 'c:\\'\n  const root =\n    /^[/\\\\]|^[a-z]:[/\\\\]/i.exec(path)?.[0]?.replace(/\\\\/g, \"/\") || \"\";\n\n  const normalizedPath = normalizeWindowsPath(path);\n\n  const segments = normalizedPath.replace(/\\/$/, \"\").split(\"/\").slice(0, -1);\n  if (segments.length === 1 && /^[A-Z]:$/i.test(segments[0] as string)) {\n    segments[0] += \"/\";\n  }\n\n  const base = findFolderName(normalizedPath, options);\n  const dir = segments.join(\"/\") || (isAbsolutePath(path) ? \"/\" : \".\");\n  const ext = findFileExtensionSafe(path, options);\n\n  return {\n    root,\n    dir,\n    base,\n    ext,\n    name: base.slice(0, base.length - ext.length)\n  };\n}\n\n/**\n * Rename the file name with a new name.\n *\n * @param filePath - The current file path being processed\n * @param newFileName - The updated file name being processed\n * @param options - Options to control the file name extraction\n * @returns The modified or unmodified file path.\n */\nexport function renameFile(\n  filePath: string,\n  newFileName: string,\n  options?: FindFileNameOptions\n): string {\n  const file = parsePath(filePath, options);\n\n  return joinPaths(\n    file.dir,\n    newFileName.includes(\".\") ? newFileName : newFileName + file.ext\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,aACd,UACA,UAA+B,EAAE,EACzB;CACR,MAAM,EAAE,mBAAmB,OAAO,gBAAgB,SAAS;CAC3D,MAAM,SACJ,qBAAqB,SAAS,EAC1B,MAAM,UAAU,SAAS,KAAK,GAAG,OAAO,IAAI,EAC5C,KAAK,IAAI;AAEf,KAAI,qBAAqB,QAAQ,CAAC,OAAO,SAAS,IAAI,CACpD,QAAO;AAGT,KAAI,kBAAkB,SAAS,OAAO,SAAS,IAAI,CACjD,QACE,OAAO,QAAQ,IAAI,kBAAkB,QAAQ,QAAQ,IAAI,MAAM,GAAG,IAClE;AAIJ,QAAO;;;;;;;;;;;;;;;;;;AAmBT,SAAgB,aACd,UACA,UAA+B,EAAE,EACzB;CACR,MAAM,iBAAiB,qBAAqB,SAAS;CAErD,MAAM,SAAS,eAAe,wBAC5B,IAAI,OACF,KAAK,aAAa,gBAAgB;EAAE,kBAAkB;EAAO,GAAG;EAAS,CAAC,CAAC,GAC5E,EACD,GACD;AAED,QAAO,WAAW,MAAM,SAAS,OAAO,QAAQ,OAAO,GAAG;;;;;;;;;;;;;;;;;AAoB5D,SAAgB,eACd,UACA,SACQ;CACR,MAAM,WAAW,aAAa,UAAU,QAAQ,CAAC,MAAM,IAAI;CAE3D,IAAI,cAAc;AAClB,MAAK,IAAI,IAAI,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK;EAC7C,MAAM,MAAM,SAAS;AACrB,MAAI,KAAK;AACP,iBAAc;AACd;;;AAWJ,QAAO,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;AAqCxB,SAAgB,kBACd,UACA,SACoB;AACpB,KAAI,SAAS,SAAS,IAAI,IAAI,SAAS,SAAS,IAAI,CAClD;CAGF,MAAM,SACJ,SAAS,gBAAgB,4BAA4B,sBACrD,KAAK,qBAAqB,SAAS,CAAC;AAEtC,QAAO,SAAS,MAAM,SAAS,KAAK,YAAY,MAAM,GAAG,GACrD,MAAM,GAAG,QAAQ,KAAK,GAAG,GACzB;;;;;;;;;AAuGN,SAAgB,iBACd,UACA,SACS;AACT,QAAO,QAAQ,kBAAkB,UAAU,QAAQ,CAAC;;AA8CtD,SAAgB,QAAQ,GAAG,OAAiB;AAE1C,SAAQ,MAAM,KAAI,aAAY,qBAAqB,SAAS,CAAC;CAE7D,IAAI,eAAe;CACnB,IAAI,mBAAmB;AAEvB,MACE,IAAI,QAAQ,MAAM,SAAS,GAC3B,SAAS,MAAM,CAAC,kBAChB,SACA;EACA,MAAM,OAAO,SAAS,IAAI,MAAM,SAASA,KAAY;AAGrD,MAAI,CAAC,QAAQ,KAAK,WAAW,EAC3B;AAGF,iBAAe,GAAG,KAAK,GAAG;AAC1B,qBAAmB,WAAW,KAAK;;AAOrC,gBAAe,gBAAgB,cAAc,CAAC,iBAAiB;AAE/D,KAAI,oBAAoB,CAAC,WAAW,aAAa,CAC/C,QAAO,IAAI;AAGb,QAAO,aAAa,SAAS,IAAI,eAAe;;;;;;;;;;;;AAyBlD,SAAgB,SAAS,MAAc,IAAY;CAEjD,MAAM,QAAQ,QAAQ,KAAK,CAAC,QAAQ,mBAAmB,KAAK,CAAC,MAAM,IAAI;CAIvE,MAAM,MAAM,QAAQ,GAAG,CAAC,QAAQ,mBAAmB,KAAK,CAAC,MAAM,IAAI;AAMnE,KAAI,IAAI,GAAG,OAAO,OAAO,MAAM,GAAG,OAAO,OAAO,MAAM,OAAO,IAAI,GAC/D,QAAO,IAAI,KAAK,IAAI;CAGtB,MAAM,YAAY,CAAC,GAAG,MAAM;AAC5B,MAAK,MAAM,WAAW,WAAW;AAC/B,MAAI,IAAI,OAAO,QACb;AAEF,QAAM,OAAO;AACb,MAAI,OAAO;;AAEb,QAAO,CAAC,GAAG,MAAM,UAAU,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,IAAI;;;;;;;;;;;;;AAcrD,SAAgB,aAAa,MAAc,IAAY,eAAe,OAAO;AAC3E,QAAO,SACL,iBAAiB,OAAO,KAAK,QAAQ,OAAO,GAAG,GAAG,MAClD,iBAAiB,OAAO,GAAG,QAAQ,OAAO,GAAG,GAAG,GACjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/fs",
-  "version": "0.33.38",
+  "version": "0.33.39",
   "type": "module",
   "description": "A package containing various file system utilities that expand the functionality of NodeJs's built-in `fs` module.",
   "repository": {
@@ -111,7 +111,7 @@
     "@storm-software/config-tools": "^1.189.0",
     "@stryke/convert": "^0.6.37",
     "@stryke/helpers": "^0.9.39",
-    "@stryke/path": "^0.26.2",
+    "@stryke/path": "^0.26.3",
     "@stryke/string-format": "^0.13.6",
     "chalk": "^5.6.2",
     "defu": "^6.1.4",
@@ -129,5 +129,5 @@
     "tsdown": "^0.17.2"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "e6880b328f3e8390a4ffd440c1bfc335de4e76c4"
+  "gitHead": "6c08e4f844473543a1da816b3279c02d162957f8"
 }