Function osAgnosticPath

testing/test-utils/src/lib/utils/os-agnostic-paths.ts:43–95

(filePath?: string)

export function osAgnosticPath(filePath: string): string;
export function osAgnosticPath(): undefined;
export function osAgnosticPath(filePath?: string): string | undefined {
  if (filePath == null) {
    return filePath;
  }
  // prepare the path for comparison
  // normalize path separators od cwd: "Users\\repo" => "Users/repo"
  const osAgnosticCwd = process
    .cwd()
    .split(AGNOSTIC_PATH_SEP_REGEX)
    .join(OS_AGNOSTIC_PATH_SEP);
  // normalize path separators  => "..\\folder\\repo.ts" => => "../folder/repo.ts"
  const osAgnosticFilePath = filePath
    .split(AGNOSTIC_PATH_SEP_REGEX)
    .join(OS_AGNOSTIC_PATH_SEP);
  // remove the current working directory for easier comparison
  const osAgnosticPathWithoutCwd = osAgnosticFilePath
    .replace(osAgnosticCwd, '')
    // consider already agnostic paths
    .replace(OS_AGNOSTIC_CWD, '');

  // path is outside cwd (Users/repo/../my-folder/my-file.ts)
  if (
    osAgnosticPathWithoutCwd.startsWith(
      `${OS_AGNOSTIC_PATH_SEP}..${OS_AGNOSTIC_PATH_SEP}`,
    )
  ) {
    return osAgnosticPathWithoutCwd.slice(1); // remove the leading '/'
  }

  // path is at cwd (Users/repo/my-folder/my-file.ts)
  if (
    osAgnosticFilePath.startsWith(osAgnosticCwd) ||
    osAgnosticFilePath.startsWith(OS_AGNOSTIC_CWD)
  ) {
    // Add a substitute for the current working directory
    return `${OS_AGNOSTIC_CWD}${osAgnosticPathWithoutCwd}`;
  }

  // Notice: I kept the following conditions for documentation purposes

  // path is absolute (/my-folder/my-file.ts)
  if (osAgnosticPathWithoutCwd.startsWith(OS_AGNOSTIC_PATH_SEP)) {
    return osAgnosticPathWithoutCwd;
  }

  // path is relative (./my-folder/my-file.ts)
  if (osAgnosticPathWithoutCwd.startsWith(`.${OS_AGNOSTIC_PATH_SEP}`)) {
    return osAgnosticPathWithoutCwd;
  }

  // path is segment (my-folder/my-file.ts or my-folder/sub-folder)
  return osAgnosticPathWithoutCwd;
}