@stryke/path 0.10.2 → 0.12.0

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

@@ -29,6 +29,9 @@ export declare function findFileName(filePath: string, options?: FindFileNameOpt
 /**
  * Find the full file path's directories from a file path.
  *
+ * @remarks
+ * The functionality of this method is similar to the {@link path.dirname} function in Node's path module.
+ *
  * @example
  * ```ts
  * const folderPath = findFilePath("C:\\Users\\user\\Documents\\file.txt");
@@ -43,9 +46,8 @@ export declare function findFilePath(filePath: string): string;
  * Find the top most folder containing the file from a file path.
  *
  * @remarks
- * 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.
- *
  * The functionality of this method is similar to the {@link path.basename} function in Node's path module.
+ * 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.
  *
  * @example
  * const folderPath = findFolderName("C:\\Users\\user\\Documents\\file.txt");

package/dist/index.cjs

@@ -91,6 +91,17 @@ Object.keys(_isFile).forEach(function (key) {
     }
   });
 });
+var _isParentPath = require("./is-parent-path.cjs");
+Object.keys(_isParentPath).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _isParentPath[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _isParentPath[key];
+    }
+  });
+});
 var _isRootDir = require("./is-root-dir.cjs");
 Object.keys(_isRootDir).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export * from "./file-path-fns";
 export * from "./get-parent-path";
 export * from "./get-workspace-root";
 export * from "./is-file";
+export * from "./is-parent-path";
 export * from "./is-root-dir";
 export * from "./join-paths";
 export * from "./regex";

package/dist/index.mjs

@@ -1 +1 @@
-export*from"./asset-extensions";export*from"./correct-path";export*from"./delimiter";export*from"./exists";export*from"./file-path-fns";export*from"./get-parent-path";export*from"./get-workspace-root";export*from"./is-file";export*from"./is-root-dir";export*from"./join-paths";export*from"./regex";export*from"./replace";export*from"./resolve";export*from"./slash";
+export*from"./asset-extensions";export*from"./correct-path";export*from"./delimiter";export*from"./exists";export*from"./file-path-fns";export*from"./get-parent-path";export*from"./get-workspace-root";export*from"./is-file";export*from"./is-parent-path";export*from"./is-root-dir";export*from"./join-paths";export*from"./regex";export*from"./replace";export*from"./resolve";export*from"./slash";

package/dist/is-parent-path.cjs

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isParentPath = isParentPath;
+var _slash = require("./slash.cjs");
+function isParentPath(a, n) {
+  const r = (0, _slash.slash)(a.replace(/\\/g, "/").replace(/\/$/, "")),
+    e = (0, _slash.slash)(n.replace(/\\/g, "/").replace(/\/$/, ""));
+  return r !== e && r.startsWith(`${e}/`);
+}

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

@@ -0,0 +1,22 @@
+/**
+ * Check if a given path is a parent of another path.
+ *
+ * @example
+ * ```ts
+ * isParentPath("/home/user/project/src/index.ts", "/home/user/project/src");
+ * // returns true
+ * isParentPath("/home/user/project/src/index.ts", "/home/user/project");
+ * // returns true
+ * isParentPath("/home/user/project/src/index.ts", "/home/user/project/src/other");
+ * // returns false
+ * isParentPath("/home/user/project/src/index.ts", "/home/user/other");
+ * // returns false
+ * isParentPath("/home/user/project/src/index.ts", "/home/user/project/src/index.ts");
+ * // returns false
+ * ```
+ *
+ * @param childPath - The path to check if it is a child of the parent path.
+ * @param parentPath - The path to check if it is a parent of the child path.
+ * @returns `true` if `childPath` is a child of `parentPath`, otherwise `false`.
+ */
+export declare function isParentPath(childPath: string, parentPath: string): boolean;

package/dist/is-parent-path.mjs

@@ -0,0 +1 @@
+import{slash as t}from"./slash";export function isParentPath(a,n){const r=t(a.replace(/\\/g,"/").replace(/\/$/,"")),e=t(n.replace(/\\/g,"/").replace(/\/$/,""));return r!==e&&r.startsWith(`${e}/`)}

package/dist/replace.cjs

@@ -4,7 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.replacePath = replacePath;
+var _isParentPath = require("./is-parent-path.cjs");
 var _slash = require("./slash.cjs");
-function replacePath(e, t = process.cwd()) {
-  return (0, _slash.slash)(e).replace((0, _slash.slash)(t), "").replace(/^\//, "");
+function replacePath(r, e = process.cwd()) {
+  return (0, _isParentPath.isParentPath)(r, e) ? (0, _slash.slash)(r).replace((0, _slash.slash)(e), "").replace(/^\//, "") : r;
 }

package/dist/replace.d.ts

@@ -7,8 +7,8 @@
  * // returns "src/index.ts"
  * ```
  *
- * @param path - The path string to replace a substring from
- * @param base - The base path to remove from the beginning of the {@link path}
- * @returns The {@link path} with the {@link base} path removed
+ * @param childPath - The child path to replace the {@link parentPath} substring from
+ * @param parentPath - The parent path to remove from the {@link childPath} parameter
+ * @returns The {@link childPath} with the {@link parentPath} path removed
  */
-export declare function replacePath(path: string, base?: string): string;
+export declare function replacePath(childPath: string, parentPath?: string): string;

package/dist/replace.mjs

@@ -1 +1 @@
-import{slash as r}from"./slash";export function replacePath(e,t=process.cwd()){return r(e).replace(r(t),"").replace(/^\//,"")}
+import{isParentPath as o}from"./is-parent-path";import{slash as s}from"./slash";export function replacePath(r,e=process.cwd()){return o(r,e)?s(r).replace(s(e),"").replace(/^\//,""):r}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/path",
-  "version": "0.10.2",
+  "version": "0.12.0",
   "type": "module",
   "description": "A package containing various utilities that expand the functionality of NodeJs's built-in `path` module",
   "repository": {
@@ -127,6 +127,20 @@
         "default": "./dist/is-root-dir.mjs"
       }
     },
+    "./is-parent-path": {
+      "import": {
+        "types": "./dist/is-parent-path.d.ts",
+        "default": "./dist/is-parent-path.mjs"
+      },
+      "require": {
+        "types": "./dist/is-parent-path.d.ts",
+        "default": "./dist/is-parent-path.cjs"
+      },
+      "default": {
+        "types": "./dist/is-parent-path.d.ts",
+        "default": "./dist/is-parent-path.mjs"
+      }
+    },
     "./is-file": {
       "import": {
         "types": "./dist/is-file.d.ts",
@@ -260,5 +274,5 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "b72d8a5bebd6ce47e458809cab4392bb000ecd81"
+  "gitHead": "763abdbc096331d500df3ebb7a7e4387335c0d62"
 }