@settlemint/sdk-utils 2.3.2 → 2.3.3

package/dist/filesystem.d.cts

@@ -1,5 +1,20 @@
-import { PathLike } from 'node:fs';
+import { PathLike } from "node:fs";
 
+//#region src/filesystem/project-root.d.ts
+/**
+* Finds the root directory of the current project by locating the nearest package.json file
+*
+* @param fallbackToCwd - If true, will return the current working directory if no package.json is found
+* @param cwd - The directory to start searching for the package.json file from (defaults to process.cwd())
+* @returns Promise that resolves to the absolute path of the project root directory
+* @throws Will throw an error if no package.json is found in the directory tree
+* @example
+* import { projectRoot } from "@settlemint/sdk-utils/filesystem";
+*
+* // Get project root path
+* const rootDir = await projectRoot();
+* console.log(`Project root is at: ${rootDir}`);
+*/
 /**
  * Finds the root directory of the current project by locating the nearest package.json file
  *
@@ -16,6 +31,8 @@ import { PathLike } from 'node:fs';
  */
 declare function projectRoot(fallbackToCwd?: boolean, cwd?: string): Promise<string>;
 
+//#endregion
+//#region src/filesystem/exists.d.ts
 /**
  * Checks if a file or directory exists at the given path
  *
@@ -31,6 +48,8 @@ declare function projectRoot(fallbackToCwd?: boolean, cwd?: string): Promise<str
  */
 declare function exists(path: PathLike): Promise<boolean>;
 
+//#endregion
+//#region src/filesystem/mono-repo.d.ts
 /**
  * Finds the root directory of a monorepo
  *
@@ -56,4 +75,6 @@ declare function findMonoRepoRoot(startDir: string): Promise<string | null>;
  */
 declare function findMonoRepoPackages(projectDir: string): Promise<string[]>;
 
+//#endregion
 export { exists, findMonoRepoPackages, findMonoRepoRoot, projectRoot };
+//# sourceMappingURL=filesystem.d.cts.map

package/dist/filesystem.d.ts

@@ -1,5 +1,20 @@
-import { PathLike } from 'node:fs';
+import { PathLike } from "node:fs";
 
+//#region src/filesystem/project-root.d.ts
+/**
+* Finds the root directory of the current project by locating the nearest package.json file
+*
+* @param fallbackToCwd - If true, will return the current working directory if no package.json is found
+* @param cwd - The directory to start searching for the package.json file from (defaults to process.cwd())
+* @returns Promise that resolves to the absolute path of the project root directory
+* @throws Will throw an error if no package.json is found in the directory tree
+* @example
+* import { projectRoot } from "@settlemint/sdk-utils/filesystem";
+*
+* // Get project root path
+* const rootDir = await projectRoot();
+* console.log(`Project root is at: ${rootDir}`);
+*/
 /**
  * Finds the root directory of the current project by locating the nearest package.json file
  *
@@ -16,6 +31,8 @@ import { PathLike } from 'node:fs';
  */
 declare function projectRoot(fallbackToCwd?: boolean, cwd?: string): Promise<string>;
 
+//#endregion
+//#region src/filesystem/exists.d.ts
 /**
  * Checks if a file or directory exists at the given path
  *
@@ -31,6 +48,8 @@ declare function projectRoot(fallbackToCwd?: boolean, cwd?: string): Promise<str
  */
 declare function exists(path: PathLike): Promise<boolean>;
 
+//#endregion
+//#region src/filesystem/mono-repo.d.ts
 /**
  * Finds the root directory of a monorepo
  *
@@ -56,4 +75,6 @@ declare function findMonoRepoRoot(startDir: string): Promise<string | null>;
  */
 declare function findMonoRepoPackages(projectDir: string): Promise<string[]>;
 
+//#endregion
 export { exists, findMonoRepoPackages, findMonoRepoRoot, projectRoot };
+//# sourceMappingURL=filesystem.d.ts.map