@stryke/path 0.9.0 → 0.10.1

package/dist/file-path-fns.cjs

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.findFileExtension = findFileExtension;
+exports.findFileExtensionSafe = findFileExtensionSafe;
 exports.findFileName = findFileName;
 exports.findFilePath = findFilePath;
 exports.findFolderName = findFolderName;
+exports.hasFileExtension = hasFileExtension;
 exports.hasFileName = hasFileName;
 exports.hasFilePath = hasFilePath;
+exports.hasFolderName = hasFolderName;
 exports.parsePath = parsePath;
 exports.relativePath = relativePath;
 exports.relativeToWorkspaceRoot = relativeToWorkspaceRoot;
@@ -21,26 +24,26 @@ 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, e = {}) {
+function findFileName(e, t = {}) {
   const {
       requireExtension: n = !1,
       withExtension: r = !0
-    } = e,
-    i = (0, _correctPath.normalizeWindowsPath)(t)?.split(t?.includes("\\") ? "\\" : "/")?.pop() ?? "";
+    } = t,
+    i = (0, _correctPath.normalizeWindowsPath)(e)?.split(e?.includes("\\") ? "\\" : "/")?.pop() ?? "";
   return n === !0 && !i.includes(".") ? _base.EMPTY_STRING : r === !1 && i.includes(".") ? i.substring(0, i.lastIndexOf(".")) || _base.EMPTY_STRING : i;
 }
-function findFilePath(t) {
-  const e = (0, _correctPath.normalizeWindowsPath)(t),
-    n = e.replace(findFileName(e, {
+function findFilePath(e) {
+  const t = (0, _correctPath.normalizeWindowsPath)(e),
+    n = t.replace(findFileName(t, {
       requireExtension: !0
     }), "");
   return n === "/" ? n : n.replace(/\/$/, "");
 }
-function findFolderName(t) {
-  const e = findFilePath(t).split("/");
+function findFolderName(e) {
+  const t = findFilePath(e).split("/");
   let n = "";
-  for (let r = e.length - 1; r >= 0; r--) {
-    const i = e[r];
+  for (let r = t.length - 1; r >= 0; r--) {
+    const i = t[r];
     if (i) {
       n = i;
       break;
@@ -48,53 +51,62 @@ function findFolderName(t) {
   }
   return n ?? _base.EMPTY_STRING;
 }
-function findFileExtension(t) {
-  if (t === "..") return "";
-  const e = /.(\.[^./]+|\.)$/.exec((0, _correctPath.normalizeWindowsPath)(t));
-  return e && e[1] || _base.EMPTY_STRING;
+function findFileExtension(e) {
+  if (e.endsWith(".") || e.endsWith("/")) return;
+  const t = /.(\.[^./]+|\.)$/.exec((0, _correctPath.normalizeWindowsPath)(e));
+  return t && t[1] || void 0;
 }
-function hasFileName(t) {
-  return !!findFileName(t);
+function findFileExtensionSafe(e) {
+  return findFileExtension(e) ?? _base.EMPTY_STRING;
 }
-function hasFilePath(t) {
-  return !!findFilePath(t);
+function hasFileName(e) {
+  return !!findFileName(e);
 }
-function resolvePath(t, e = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
-  const n = (0, _correctPath.normalizeWindowsPath)(t).split("/");
+function hasFilePath(e) {
+  return !!findFilePath(e);
+}
+function hasFolderName(e) {
+  return !!findFolderName(e);
+}
+function hasFileExtension(e) {
+  return !!findFileExtension(e);
+}
+function resolvePath(e, t = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
+  const n = (0, _correctPath.normalizeWindowsPath)(e).split("/");
   let r = "",
     i = !1;
   for (let s = n.length - 1; s >= -1 && !i; s--) {
-    const o = s >= 0 ? n[s] : e;
+    const o = s >= 0 ? n[s] : t;
     !o || o.length === 0 || (r = (0, _joinPaths.joinPaths)(o, r), i = (0, _isFile.isAbsolutePath)(o));
   }
   return r = (0, _correctPath.normalizeString)(r, !i), i && !(0, _isFile.isAbsolutePath)(r) ? `/${r}` : r.length > 0 ? r : ".";
 }
-function resolvePaths(...t) {
-  return resolvePath((0, _joinPaths.joinPaths)(...t.map(e => (0, _correctPath.normalizeWindowsPath)(e))));
+function resolvePaths(...e) {
+  return resolvePath((0, _joinPaths.joinPaths)(...e.map(t => (0, _correctPath.normalizeWindowsPath)(t))));
 }
-function relativePath(t, e, n = !1) {
-  return (0, _nodePath.relative)(n !== !0 ? t.replace(/\/$/, "") : t, n !== !0 ? e.replace(/\/$/, "") : e);
+function relativePath(e, t, n = !1) {
+  return (0, _nodePath.relative)(n !== !0 ? e.replace(/\/$/, "") : e, n !== !0 ? t.replace(/\/$/, "") : t);
 }
-function relativeToWorkspaceRoot(t) {
-  return relativePath(t, (0, _getWorkspaceRoot.getWorkspaceRoot)());
+function relativeToWorkspaceRoot(e) {
+  return relativePath(e, (0, _getWorkspaceRoot.getWorkspaceRoot)());
 }
-function parsePath(t) {
-  const e = /^[/\\]|^[a-z]:[/\\]/i.exec(t)?.[0]?.replace(/\\/g, "/") || "",
-    n = (0, _correctPath.normalizeWindowsPath)(t),
+function parsePath(e) {
+  const t = /^[/\\]|^[a-z]:[/\\]/i.exec(e)?.[0]?.replace(/\\/g, "/") || "",
+    n = (0, _correctPath.normalizeWindowsPath)(e),
     r = n.replace(/\/$/, "").split("/").slice(0, -1);
   r.length === 1 && /^[A-Z]:$/i.test(r[0]) && (r[0] += "/");
   const i = findFolderName(n),
-    s = r.join("/") || ((0, _isFile.isAbsolutePath)(t) ? "/" : "."),
-    o = findFileExtension(t);
+    s = r.join("/") || ((0, _isFile.isAbsolutePath)(e) ? "/" : "."),
+    o = findFileExtensionSafe(e);
   return {
-    root: e,
+    root: t,
     dir: s,
     base: i,
     ext: o,
     name: i.slice(0, i.length - o.length)
   };
 }
-function renameFile(t, e) {
-  const n = parsePath(t);
-  return (0, _joinPaths.joinPaths)(n.dir, e.includes(".") ? e : e + n.ext);
+function renameFile(e, t) {
+  const n = parsePath(e);
+  return (0, _joinPaths.joinPaths)(n.dir, t.includes(".") ? t : t + n.ext);
 }

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

@@ -58,10 +58,27 @@ export declare function findFolderName(filePath: string): string;
 /**
  * Find the file extension from a file path.
  *
+ * @remarks
+ * 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`.
+ *
+ * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.
+ *
+ * @param filePath - The file path to process
+ * @returns The file extension or undefined if no extension is found
+ */
+export declare function findFileExtension(filePath: string): string | undefined;
+/**
+ * Find the file extension from a file path or an empty string.
+ *
+ *  @remarks
+ * 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`.
+ *
+ * The returned extension **will not** include the dot, for example `txt` or `js` instead of `.txt` or `.js`.
+ *
  * @param filePath - The file path to process
- * @returns The file extension
+ * @returns The file extension or an empty string if no extension is found
  */
-export declare function findFileExtension(filePath: string): string;
+export declare function findFileExtensionSafe(filePath: string): string;
 /**
  * Check if a file path has a file name.
  *
@@ -76,6 +93,20 @@ export declare function hasFileName(filePath: string): boolean;
  * @returns An indicator specifying if the file path has a file path
  */
 export declare function hasFilePath(filePath: string): boolean;
+/**
+ * Check if a file path has a folder name.
+ *
+ * @param filePath - The file path to process
+ * @returns An indicator specifying if the file path has a folder name
+ */
+export declare function hasFolderName(filePath: string): boolean;
+/**
+ * Check if a file path has a file extension.
+ *
+ * @param filePath - The file path to process
+ * @returns An indicator specifying if the file path has a file extension
+ */
+export declare function hasFileExtension(filePath: string): boolean;
 /**
  * Resolve the file path to an absolute 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,e={}){const{requireExtension:n=!1,withExtension:r=!0}=e,i=l(t)?.split(t?.includes("\\")?"\\":"/")?.pop()??"";return n===!0&&!i.includes(".")?a:r===!1&&i.includes(".")?i.substring(0,i.lastIndexOf("."))||a:i}export function findFilePath(t){const e=l(t),n=e.replace(findFileName(e,{requireExtension:!0}),"");return n==="/"?n:n.replace(/\/$/,"")}export function findFolderName(t){const e=findFilePath(t).split("/");let n="";for(let r=e.length-1;r>=0;r--){const i=e[r];if(i){n=i;break}}return n??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 n=l(t).split("/");let r="",i=!1;for(let s=n.length-1;s>=-1&&!i;s--){const o=s>=0?n[s]:e;!o||o.length===0||(r=u(o,r),i=c(o))}return r=g(r,!i),i&&!c(r)?`/${r}`:r.length>0?r:"."}export function resolvePaths(...t){return resolvePath(u(...t.map(e=>l(e))))}export function relativePath(t,e,n=!1){return f(n!==!0?t.replace(/\/$/,""):t,n!==!0?e.replace(/\/$/,""):e)}export function relativeToWorkspaceRoot(t){return relativePath(t,p())}export function parsePath(t){const e=/^[/\\]|^[a-z]:[/\\]/i.exec(t)?.[0]?.replace(/\\/g,"/")||"",n=l(t),r=n.replace(/\/$/,"").split("/").slice(0,-1);r.length===1&&/^[A-Z]:$/i.test(r[0])&&(r[0]+="/");const i=findFolderName(n),s=r.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 n=parsePath(t);return u(n.dir,e.includes(".")?e:e+n.ext)}
+import{EMPTY_STRING as a}from"@stryke/types/base";import{relative as p}from"node:path";import{normalizeString as g,normalizeWindowsPath as l}from"./correct-path";import{getWorkspaceRoot as f}from"./get-workspace-root";import{isAbsolutePath as u}from"./is-file";import{joinPaths as c}from"./join-paths";export function findFileName(e,t={}){const{requireExtension:n=!1,withExtension:r=!0}=t,i=l(e)?.split(e?.includes("\\")?"\\":"/")?.pop()??"";return n===!0&&!i.includes(".")?a:r===!1&&i.includes(".")?i.substring(0,i.lastIndexOf("."))||a:i}export function findFilePath(e){const t=l(e),n=t.replace(findFileName(t,{requireExtension:!0}),"");return n==="/"?n:n.replace(/\/$/,"")}export function findFolderName(e){const t=findFilePath(e).split("/");let n="";for(let r=t.length-1;r>=0;r--){const i=t[r];if(i){n=i;break}}return n??a}export function findFileExtension(e){if(e.endsWith(".")||e.endsWith("/"))return;const t=/.(\.[^./]+|\.)$/.exec(l(e));return t&&t[1]||void 0}export function findFileExtensionSafe(e){return findFileExtension(e)??a}export function hasFileName(e){return!!findFileName(e)}export function hasFilePath(e){return!!findFilePath(e)}export function hasFolderName(e){return!!findFolderName(e)}export function hasFileExtension(e){return!!findFileExtension(e)}export function resolvePath(e,t=f()){const n=l(e).split("/");let r="",i=!1;for(let s=n.length-1;s>=-1&&!i;s--){const o=s>=0?n[s]:t;!o||o.length===0||(r=c(o,r),i=u(o))}return r=g(r,!i),i&&!u(r)?`/${r}`:r.length>0?r:"."}export function resolvePaths(...e){return resolvePath(c(...e.map(t=>l(t))))}export function relativePath(e,t,n=!1){return p(n!==!0?e.replace(/\/$/,""):e,n!==!0?t.replace(/\/$/,""):t)}export function relativeToWorkspaceRoot(e){return relativePath(e,f())}export function parsePath(e){const t=/^[/\\]|^[a-z]:[/\\]/i.exec(e)?.[0]?.replace(/\\/g,"/")||"",n=l(e),r=n.replace(/\/$/,"").split("/").slice(0,-1);r.length===1&&/^[A-Z]:$/i.test(r[0])&&(r[0]+="/");const i=findFolderName(n),s=r.join("/")||(u(e)?"/":"."),o=findFileExtensionSafe(e);return{root:t,dir:s,base:i,ext:o,name:i.slice(0,i.length-o.length)}}export function renameFile(e,t){const n=parsePath(e);return c(n.dir,t.includes(".")?t:t+n.ext)}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/path",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "type": "module",
   "description": "A package containing various utilities that expand the functionality of NodeJs's built-in `path` module",
   "repository": {
@@ -260,5 +260,5 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "4052d0819f6c27c02af4ccd7460b5cd28c36f5c4"
+  "gitHead": "108abe84f9ba3d55f19cc68b8cc5fe52d90b5183"
 }