@augment-vir/node/dist/augments/path/contains.js

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

import { isAbsolute, normalize, relative, resolve, sep } from 'node:path';
import { isOperatingSystem, OperatingSystem } from '../os/operating-system.js';
/**
 * Checks to see if a potential child path is inside of a potential parent path.
 *
 * @category Path : Node
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export function doesPathContain(potentialParentPath, potentialChildPath, options = {}) {
    if (!potentialParentPath || !potentialChildPath) {
        return false;
    }
    const parent = normalizePath(potentialParentPath);
    const child = normalizePath(potentialChildPath);
    const relativePath = relative(parent, child);
    if (!relativePath) {
        /** Paths are identical. */
        return !!options.allowSelf;
        /* node:coverage ignore next 4: cannot test Windows specific behavior on all systems. */
    }
    else if (isAbsolute(relativePath)) {
        /** On Windows, paths on different drives yield an absolute relative path. */
        return false;
    }
    /** Contained if it does not traverse up out of parent. */
    return relativePath !== '..' && !relativePath.startsWith('..' + sep);
}
function normalizePath(inputPath) {
    const absolutePath = normalize(resolve(inputPath));
    /* node:coverage ignore next 1: cannot test Windows specific behavior on all systems. */
    return isOperatingSystem(OperatingSystem.Windows) ? absolutePath.toLowerCase() : absolutePath;
}