@stryke/path 0.4.14 → 0.5.1

package/dist/file-path-fns.cjs

@@ -21,12 +21,13 @@ var _correctPath = require("./correct-path.cjs");
 var _getWorkspaceRoot = require("./get-workspace-root.cjs");
 var _isFile = require("./is-file.cjs");
 var _joinPaths = require("./join-paths.cjs");
-function findFileName(t, {
-  requireExtension: e,
-  withExtension: r
-} = {}) {
-  const n = (0, _correctPath.normalizeWindowsPath)(t)?.split(t?.includes("\\") ? "\\" : "/")?.pop() ?? "";
-  return e === !0 && !n.includes(".") ? _base.EMPTY_STRING : r === !1 && n.includes(".") ? n.split(".").slice(-1).join(".") || _base.EMPTY_STRING : n;
+function findFileName(t, e = {}) {
+  const {
+      requireExtension: i = !1,
+      withExtension: n = !0
+    } = e,
+    r = (0, _correctPath.normalizeWindowsPath)(t)?.split(t?.includes("\\") ? "\\" : "/")?.pop() ?? "";
+  return i === !0 && !r.includes(".") ? _base.EMPTY_STRING : n === !1 && r.includes(".") ? r.split(".").slice(-1).join(".") || _base.EMPTY_STRING : r;
 }
 function findFilePath(t) {
   const e = (0, _correctPath.normalizeWindowsPath)(t);
@@ -36,15 +37,15 @@ function findFilePath(t) {
 }
 function findFolderName(t) {
   const e = findFilePath(t).split("/");
-  let r = "";
+  let i = "";
   for (let n = e.length - 1; n >= 0; n--) {
-    const i = e[n];
-    if (i) {
-      r = i;
+    const r = e[n];
+    if (r) {
+      i = r;
       break;
     }
   }
-  return r ?? _base.EMPTY_STRING;
+  return i ?? _base.EMPTY_STRING;
 }
 function findFileExtension(t) {
   if (t === "..") return "";
@@ -58,14 +59,14 @@ function hasFilePath(t) {
   return !!findFilePath(t);
 }
 function resolvePath(t, e = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
-  const r = (0, _correctPath.normalizeWindowsPath)(t).split("/");
+  const i = (0, _correctPath.normalizeWindowsPath)(t).split("/");
   let n = "",
-    i = !1;
-  for (let s = r.length - 1; s >= -1 && !i; s--) {
-    const o = s >= 0 ? r[s] : e;
-    !o || o.length === 0 || (n = (0, _joinPaths.joinPaths)(o, n), i = (0, _isFile.isAbsolutePath)(o));
+    r = !1;
+  for (let s = i.length - 1; s >= -1 && !r; s--) {
+    const o = s >= 0 ? i[s] : e;
+    !o || o.length === 0 || (n = (0, _joinPaths.joinPaths)(o, n), r = (0, _isFile.isAbsolutePath)(o));
   }
-  return n = (0, _correctPath.normalizeString)(n, !i), i && !(0, _isFile.isAbsolutePath)(n) ? `/${n}` : n.length > 0 ? n : ".";
+  return n = (0, _correctPath.normalizeString)(n, !r), r && !(0, _isFile.isAbsolutePath)(n) ? `/${n}` : n.length > 0 ? n : ".";
 }
 function resolvePaths(...t) {
   return resolvePath((0, _joinPaths.joinPaths)(...t.map(e => (0, _correctPath.normalizeWindowsPath)(e))));
@@ -78,21 +79,21 @@ function relativeToWorkspaceRoot(t) {
 }
 function parsePath(t) {
   const e = /^[/\\]|^[a-z]:[/\\]/i.exec(t)?.[0]?.replace(/\\/g, "/") || "",
-    r = (0, _correctPath.normalizeWindowsPath)(t),
-    n = r.replace(/\/$/, "").split("/").slice(0, -1);
+    i = (0, _correctPath.normalizeWindowsPath)(t),
+    n = i.replace(/\/$/, "").split("/").slice(0, -1);
   n.length === 1 && /^[A-Z]:$/i.test(n[0]) && (n[0] += "/");
-  const i = findFolderName(r),
+  const r = findFolderName(i),
     s = n.join("/") || ((0, _isFile.isAbsolutePath)(t) ? "/" : "."),
     o = findFileExtension(t);
   return {
     root: e,
     dir: s,
-    base: i,
+    base: r,
     ext: o,
-    name: i.slice(0, i.length - o.length)
+    name: r.slice(0, r.length - o.length)
   };
 }
 function renameFile(t, e) {
-  const r = parsePath(t);
-  return (0, _joinPaths.joinPaths)(r.dir, e.includes(".") ? e : e + r.ext);
+  const i = parsePath(t);
+  return (0, _joinPaths.joinPaths)(i.dir, e.includes(".") ? e : e + i.ext);
 }

package/dist/file-path-fns.d.ts

@@ -22,10 +22,10 @@ export interface FindFileNameOptions {
  * ```
  *
  * @param filePath - The file path to process
- * @param options - The options to use when processing the file name
+ * @param options - Options to control the file name extraction
  * @returns The file name
  */
-export declare function findFileName(filePath: string, { requireExtension, withExtension }?: FindFileNameOptions): string;
+export declare function findFileName(filePath: string, options?: FindFileNameOptions): string;
 /**
  * Find the full file path's directories from a file path.
  *

package/dist/file-path-fns.mjs

@@ -1 +1 @@
-import{EMPTY_STRING as a}from"@stryke/types/base";import{relative as f}from"node:path";import{normalizeString as g,normalizeWindowsPath as l}from"./correct-path";import{getWorkspaceRoot as p}from"./get-workspace-root";import{isAbsolutePath as c}from"./is-file";import{joinPaths as u}from"./join-paths";export function findFileName(t,{requireExtension:e,withExtension:r}={}){const n=l(t)?.split(t?.includes("\\")?"\\":"/")?.pop()??"";return e===!0&&!n.includes(".")?a:r===!1&&n.includes(".")?n.split(".").slice(-1).join(".")||a:n}export function findFilePath(t){const e=l(t);return e.replace(findFileName(e,{requireExtension:!0}),"")}export function findFolderName(t){const e=findFilePath(t).split("/");let r="";for(let n=e.length-1;n>=0;n--){const i=e[n];if(i){r=i;break}}return r??a}export function findFileExtension(t){if(t==="..")return"";const e=/.(\.[^./]+|\.)$/.exec(l(t));return e&&e[1]||a}export function hasFileName(t){return!!findFileName(t)}export function hasFilePath(t){return!!findFilePath(t)}export function resolvePath(t,e=p()){const r=l(t).split("/");let n="",i=!1;for(let s=r.length-1;s>=-1&&!i;s--){const o=s>=0?r[s]:e;!o||o.length===0||(n=u(o,n),i=c(o))}return n=g(n,!i),i&&!c(n)?`/${n}`:n.length>0?n:"."}export function resolvePaths(...t){return resolvePath(u(...t.map(e=>l(e))))}export function relativePath(t,e){return f(t.replace(/\/$/,""),e.replace(/\/$/,""))}export function relativeToWorkspaceRoot(t){return relativePath(t,p())}export function parsePath(t){const e=/^[/\\]|^[a-z]:[/\\]/i.exec(t)?.[0]?.replace(/\\/g,"/")||"",r=l(t),n=r.replace(/\/$/,"").split("/").slice(0,-1);n.length===1&&/^[A-Z]:$/i.test(n[0])&&(n[0]+="/");const i=findFolderName(r),s=n.join("/")||(c(t)?"/":"."),o=findFileExtension(t);return{root:e,dir:s,base:i,ext:o,name:i.slice(0,i.length-o.length)}}export function renameFile(t,e){const r=parsePath(t);return u(r.dir,e.includes(".")?e:e+r.ext)}
+import{EMPTY_STRING as a}from"@stryke/types/base";import{relative as f}from"node:path";import{normalizeString as g,normalizeWindowsPath as l}from"./correct-path";import{getWorkspaceRoot as p}from"./get-workspace-root";import{isAbsolutePath as c}from"./is-file";import{joinPaths as u}from"./join-paths";export function findFileName(t,e={}){const{requireExtension:i=!1,withExtension:n=!0}=e,r=l(t)?.split(t?.includes("\\")?"\\":"/")?.pop()??"";return i===!0&&!r.includes(".")?a:n===!1&&r.includes(".")?r.split(".").slice(-1).join(".")||a:r}export function findFilePath(t){const e=l(t);return e.replace(findFileName(e,{requireExtension:!0}),"")}export function findFolderName(t){const e=findFilePath(t).split("/");let i="";for(let n=e.length-1;n>=0;n--){const r=e[n];if(r){i=r;break}}return i??a}export function findFileExtension(t){if(t==="..")return"";const e=/.(\.[^./]+|\.)$/.exec(l(t));return e&&e[1]||a}export function hasFileName(t){return!!findFileName(t)}export function hasFilePath(t){return!!findFilePath(t)}export function resolvePath(t,e=p()){const i=l(t).split("/");let n="",r=!1;for(let s=i.length-1;s>=-1&&!r;s--){const o=s>=0?i[s]:e;!o||o.length===0||(n=u(o,n),r=c(o))}return n=g(n,!r),r&&!c(n)?`/${n}`:n.length>0?n:"."}export function resolvePaths(...t){return resolvePath(u(...t.map(e=>l(e))))}export function relativePath(t,e){return f(t.replace(/\/$/,""),e.replace(/\/$/,""))}export function relativeToWorkspaceRoot(t){return relativePath(t,p())}export function parsePath(t){const e=/^[/\\]|^[a-z]:[/\\]/i.exec(t)?.[0]?.replace(/\\/g,"/")||"",i=l(t),n=i.replace(/\/$/,"").split("/").slice(0,-1);n.length===1&&/^[A-Z]:$/i.test(n[0])&&(n[0]+="/");const r=findFolderName(i),s=n.join("/")||(c(t)?"/":"."),o=findFileExtension(t);return{root:e,dir:s,base:r,ext:o,name:r.slice(0,r.length-o.length)}}export function renameFile(t,e){const i=parsePath(t);return u(i.dir,e.includes(".")?e:e+i.ext)}

package/dist/get-parent-path.cjs

@@ -7,20 +7,24 @@ exports.resolveParentPath = exports.getParentPath = void 0;
 var _filePathFns = require("./file-path-fns.cjs");
 var _isFile = require("./is-file.cjs");
 var _joinPaths = require("./join-paths.cjs");
-const resolveParentPath = r => (0, _filePathFns.resolvePaths)(r, ".."),
-  getParentPath = (r, a, o) => {
-    const p = o?.ignoreCase ?? !0,
-      l = o?.skipCwd ?? !1,
-      e = o?.targetType ?? "both";
-    let t = a;
-    l && (t = resolveParentPath(a));
-    let n = Array.isArray(r) ? r : [r];
-    for (p && (n = n.map(i => i.toLowerCase()));;) {
-      const i = n.find(g => (0, _isFile.isFile)((0, _joinPaths.joinPaths)(t, g)) && (e === "file" || e === "both") || (0, _isFile.isDirectory)((0, _joinPaths.joinPaths)(t, g)) && (e === "directory" || e === "both"));
-      if (i) return (0, _joinPaths.joinPaths)(t, i);
-      const f = resolveParentPath(t);
-      if (f === t) return;
-      t = f;
+const resolveParentPath = (r, i = 1) => {
+    let t = r;
+    for (let o = 0; o < i; o++) t = (0, _filePathFns.resolvePaths)(t, "..");
+    return t;
+  },
+  getParentPath = (r, i, t) => {
+    const o = t?.ignoreCase ?? !0,
+      l = t?.skipCwd ?? !1,
+      n = t?.targetType ?? "both";
+    let e = i;
+    l && (e = resolveParentPath(i));
+    let a = Array.isArray(r) ? r : [r];
+    for (o && (a = a.map(s => s.toLowerCase()));;) {
+      const s = a.find(g => (0, _isFile.isFile)((0, _joinPaths.joinPaths)(e, g)) && (n === "file" || n === "both") || (0, _isFile.isDirectory)((0, _joinPaths.joinPaths)(e, g)) && (n === "directory" || n === "both"));
+      if (s) return (0, _joinPaths.joinPaths)(e, s);
+      const p = resolveParentPath(e);
+      if (p === e) return;
+      e = p;
     }
   };
 exports.getParentPath = getParentPath;

package/dist/get-parent-path.d.ts

@@ -2,9 +2,10 @@
  * Resolve the parent path of the provided path.
  *
  * @param path - The path to resolve.
+ * @param count - The number of parent directories to traverse.
  * @returns The parent path of the provided path.
  */
-export declare const resolveParentPath: (path: string) => string;
+export declare const resolveParentPath: (path: string, count?: number) => string;
 /**
  * Options for the `getParentPath` function.
  */

package/dist/get-parent-path.mjs

@@ -1 +1 @@
-import{resolvePaths as h}from"./file-path-fns";import{isDirectory as P,isFile as c}from"./is-file";import{joinPaths as s}from"./join-paths";export const resolveParentPath=r=>h(r,".."),getParentPath=(r,a,o)=>{const p=o?.ignoreCase??!0,l=o?.skipCwd??!1,e=o?.targetType??"both";let t=a;l&&(t=resolveParentPath(a));let n=Array.isArray(r)?r:[r];for(p&&(n=n.map(i=>i.toLowerCase()));;){const i=n.find(g=>c(s(t,g))&&(e==="file"||e==="both")||P(s(t,g))&&(e==="directory"||e==="both"));if(i)return s(t,i);const f=resolveParentPath(t);if(f===t)return;t=f}};
+import{resolvePaths as h}from"./file-path-fns";import{isDirectory as P,isFile as c}from"./is-file";import{joinPaths as f}from"./join-paths";export const resolveParentPath=(r,i=1)=>{let t=r;for(let o=0;o<i;o++)t=h(t,"..");return t},getParentPath=(r,i,t)=>{const o=t?.ignoreCase??!0,l=t?.skipCwd??!1,n=t?.targetType??"both";let e=i;l&&(e=resolveParentPath(i));let a=Array.isArray(r)?r:[r];for(o&&(a=a.map(s=>s.toLowerCase()));;){const s=a.find(g=>c(f(e,g))&&(n==="file"||n==="both")||P(f(e,g))&&(n==="directory"||n==="both"));if(s)return f(e,s);const p=resolveParentPath(e);if(p===e)return;e=p}};

package/dist/resolve.cjs

@@ -12,6 +12,7 @@ exports.resolveSafeSync = resolveSafeSync;
 exports.resolveSync = resolveSync;
 var _mlly = require("mlly");
 var _correctPath = require("./correct-path.cjs");
+var _filePathFns = require("./file-path-fns.cjs");
 var _getWorkspaceRoot = require("./get-workspace-root.cjs");
 var _joinPaths = require("./join-paths.cjs");
 async function resolve(r, e = {}) {
@@ -50,9 +51,9 @@ async function importModule(r) {
 }
 async function resolvePackage(r, e = {}) {
   let t = await resolveSafe((0, _joinPaths.joinPaths)(r, "package.json"), e);
-  return t || (t = await resolveSafe((0, _joinPaths.joinPaths)(r, "index.js"), e), t || (t = await resolveSafe(r, e))), t;
+  return t || (t = await resolveSafe((0, _joinPaths.joinPaths)(r, "index.js"), e), t || (t = await resolveSafe(r, e))), t ? (0, _filePathFns.findFilePath)(t) : void 0;
 }
 async function resolvePackageSync(r, e = {}) {
   let t = resolveSafeSync((0, _joinPaths.joinPaths)(r, "package.json"), e);
-  return t || (t = resolveSafeSync((0, _joinPaths.joinPaths)(r, "index.js"), e), t || (t = resolveSafeSync(r, e))), t;
+  return t || (t = resolveSafeSync((0, _joinPaths.joinPaths)(r, "index.js"), e), t || (t = resolveSafeSync(r, e))), t ? (0, _filePathFns.findFilePath)(t) : void 0;
 }

package/dist/resolve.d.ts

@@ -12,7 +12,7 @@ export interface PackageResolvingOptions {
 /**
  * Resolve the path to a specified module
  *
- * @param name - The name of the module
+ * @param path - The path to the module
  * @param options - The options to use when resolving the module
  * @returns A promise for the path to the module
  */
@@ -20,7 +20,7 @@ export declare function resolve(path: string, options?: PackageResolvingOptions)
 /**
  * Resolve the path to a specified module
  *
- * @param name - The name of the module
+ * @param path - The path to the module
  * @param options - The options to use when resolving the module
  * @returns The path to the module or undefined
  */
@@ -49,16 +49,23 @@ export declare function resolveSafeSync(name: string, options?: PackageResolving
  */
 export declare function importModule<T = any>(path: string): Promise<T>;
 /**
- * Import a module from a specified path with error handling
+ * Resolve the path to a specified package asynchronously
  *
- * @param path - The path to the module
- * @returns The module or undefined
+ * @remarks
+ * This path points to the root of the package, which is usually the directory containing the `package.json` file. Please note: this path does not include the `package.json` file itself.
+ *
+ * @param name - The name of the module
+ * @returns A promise for the module or undefined
  */
 export declare function resolvePackage(name: string, options?: PackageResolvingOptions): Promise<string | undefined>;
 /**
- * Import a module from a specified path with error handling
+ * Resolve the path to a specified package synchronously
  *
- * @param path - The path to the module
+ * @remarks
+ * This path points to the root of the package, which is usually the directory containing the `package.json` file. Please note: this path does not include the `package.json` file itself.
+ *
+ * @param name - The name of the module
+ * @param options - The options to use when resolving the module
  * @returns The module or undefined
  */
 export declare function resolvePackageSync(name: string, options?: PackageResolvingOptions): Promise<string | undefined>;

package/dist/resolve.mjs

@@ -1 +1 @@
-import{interopDefault as i,resolvePath as c,resolvePathSync as p}from"mlly";import{correctPath as o}from"./correct-path";import{getWorkspaceRoot as a}from"./get-workspace-root";import{joinPaths as s}from"./join-paths";export async function resolve(r,e={}){const t=e.paths??[];t.length===0&&t.push(process.cwd());const n=a();return t.includes(n)||t.push(n),o(await c(r,{url:t}))}export function resolveSync(r,e={}){const t=e.paths??[];t.length===0&&t.push(process.cwd());const n=a();return t.includes(n)||t.push(n),o(p(r,{url:e.paths}))}export async function resolveSafe(r,e={}){try{return await resolve(r,e)}catch{return}}export function resolveSafeSync(r,e={}){try{return resolveSync(r,e)}catch{return}}export async function importModule(r){const e=await import(r);return e&&i(e)}export async function resolvePackage(r,e={}){let t=await resolveSafe(s(r,"package.json"),e);return t||(t=await resolveSafe(s(r,"index.js"),e),t||(t=await resolveSafe(r,e))),t}export async function resolvePackageSync(r,e={}){let t=resolveSafeSync(s(r,"package.json"),e);return t||(t=resolveSafeSync(s(r,"index.js"),e),t||(t=resolveSafeSync(r,e))),t}
+import{interopDefault as c,resolvePath as p,resolvePathSync as f}from"mlly";import{correctPath as s}from"./correct-path";import{findFilePath as i}from"./file-path-fns";import{getWorkspaceRoot as a}from"./get-workspace-root";import{joinPaths as o}from"./join-paths";export async function resolve(r,e={}){const t=e.paths??[];t.length===0&&t.push(process.cwd());const n=a();return t.includes(n)||t.push(n),s(await p(r,{url:t}))}export function resolveSync(r,e={}){const t=e.paths??[];t.length===0&&t.push(process.cwd());const n=a();return t.includes(n)||t.push(n),s(f(r,{url:e.paths}))}export async function resolveSafe(r,e={}){try{return await resolve(r,e)}catch{return}}export function resolveSafeSync(r,e={}){try{return resolveSync(r,e)}catch{return}}export async function importModule(r){const e=await import(r);return e&&c(e)}export async function resolvePackage(r,e={}){let t=await resolveSafe(o(r,"package.json"),e);return t||(t=await resolveSafe(o(r,"index.js"),e),t||(t=await resolveSafe(r,e))),t?i(t):void 0}export async function resolvePackageSync(r,e={}){let t=resolveSafeSync(o(r,"package.json"),e);return t||(t=resolveSafeSync(o(r,"index.js"),e),t||(t=resolveSafeSync(r,e))),t?i(t):void 0}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/path",
-  "version": "0.4.14",
+  "version": "0.5.1",
   "type": "module",
   "description": "A package containing various utilities that expand the functionality of NodeJs's built-in `path` module",
   "repository": {
@@ -10,7 +10,7 @@
   },
   "private": false,
   "dependencies": { "@storm-software/config-tools": "latest", "mlly": "1.7.4" },
-  "devDependencies": { "@stryke/types": "^0.8.3", "@types/node": "^22.13.1" },
+  "devDependencies": { "@stryke/types": "^0.8.3", "@types/node": "^22.14.0" },
   "publishConfig": { "access": "public" },
   "sideEffects": false,
   "files": ["dist/**/*"],