@augment-vir/node/src/augments/path/os-path.ts

A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.

import {sep} from 'node:path';

/**
 * Convert a given path to a windows path if the current system doesn't use `/`.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export function replaceWithWindowsPathIfNeeded(input: string): string {
    /** No single system will test all of these lines so we must ignore them all. */
    /* node:coverage ignore next 5 */
    if (sep === '/') {
        return input;
    } else {
        return input.replace(/\//g, sep);
    }
}

/**
 * Convert a Windows path to a posix path.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export function toPosixPath(maybeWindowsPath: string): string {
    return maybeWindowsPath
        .replace(/^(.+?):\\+/, (match, captureGroup) => {
            return `/${captureGroup.toLowerCase()}/`;
        })
        .replace(/\\+/g, '/');
}

/**
 * Use this to interpolate paths into bash commands. If the given path is not a Windows path, the
 * path structure will not be modified.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export function interpolationSafeWindowsPath(input: string): string {
    return input.replace(/\\/g, '\\\\\\\\');
}