Skip to content

docs: shorten resolveFromCwd JSDoc #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chrilleweb merged 3 commits into from
Dec 17, 2025
Merged

docs: shorten resolveFromCwd JSDoc #123

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68bc2e4
docs: shorten resolveFromCwd JSDoc
MalathiBalaraman31 Dec 17, 2025
2187ed1
docs: add brief context to resolveFromCwd JSDoc
MalathiBalaraman31 Dec 17, 2025
c7b43a7
Merge branch 'main' into docs/improve-readme
Chrilleweb Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/core/helpers/resolveFromCwd.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +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);
Loading