From 68bc2e40056b5c10ef5b6b5f5e5f9092dc10773b Mon Sep 17 00:00:00 2001 From: Malathi <149077958+MalathiBalaraman31@users.noreply.github.com> Date: Wed, 17 Dec 2025 12:39:23 +0530 Subject: [PATCH 1/2] docs: shorten resolveFromCwd JSDoc --- src/core/helpers/resolveFromCwd.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/core/helpers/resolveFromCwd.ts b/src/core/helpers/resolveFromCwd.ts index a9031eb..4cd990a 100644 --- a/src/core/helpers/resolveFromCwd.ts +++ b/src/core/helpers/resolveFromCwd.ts @@ -8,3 +8,4 @@ import path from 'path'; */ export const resolveFromCwd = (cwd: string, p: string): string => path.isAbsolute(p) ? p : path.resolve(cwd, p); + From 2187ed11242d39f31feeb3679b3c85c2aff1ae68 Mon Sep 17 00:00:00 2001 From: Malathi <149077958+MalathiBalaraman31@users.noreply.github.com> Date: Wed, 17 Dec 2025 14:33:17 +0530 Subject: [PATCH 2/2] docs: add brief context to resolveFromCwd JSDoc --- src/core/helpers/resolveFromCwd.ts | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/core/helpers/resolveFromCwd.ts b/src/core/helpers/resolveFromCwd.ts index 4cd990a..d031ebd 100644 --- a/src/core/helpers/resolveFromCwd.ts +++ b/src/core/helpers/resolveFromCwd.ts @@ -1,11 +1,17 @@ import path from 'path'; /** - * Resolves a path relative to the current working directory. - * @param cwd - Current working directory - * @param p - Path to resolve - * @returns Resolved absolute path + * Resolves a filesystem path relative to a given current working directory (CWD). + * + * This helper is useful when working with user-provided paths that may be + * relative or absolute. + * + * - Absolute paths are returned unchanged. + * - Relative paths are resolved against `cwd` using `path.resolve`. + * + * @param cwd - Base directory used to resolve relative paths + * @param p - A relative or absolute filesystem path + * @returns An absolute filesystem path */ export const resolveFromCwd = (cwd: string, p: string): string => path.isAbsolute(p) ? p : path.resolve(cwd, p); -