All files sync.js

100% Statements 231/231
100% Branches 42/42
100% Functions 5/5
100% Lines 231/231

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 23211x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 4x 4x 4x 4x 4x 4x 4x 4x 4x 12x 15x 15x 3x 3x 3x 15x 9x 9x 9x 1x 4x 11x 11x 11x 11x 11x 11x 11x 11x 11x 4x 4x 4x 4x 4x 4x 4x 4x 4x 12x 16x 16x 4x 4x 16x 12x 3x 3x 9x 9x 9x 1x 4x 11x 11x 11x 11x 11x 11x 11x 11x 11x 5x 5x 5x 5x 5x 5x 5x 5x 5x 24x 38x 38x 7x 7x 38x 24x 3x 3x 21x 21x 21x 21x 2x 5x 11x 11x 11x 11x 11x 11x 11x 11x 11x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 21x 36x 11x 11x 25x 36x 3x 3x 3x 36x 21x 1x 1x 20x 20x 20x 3x 3x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 54x 54x 54x 54x 54x 54x 54x 54x 22x 4x 4x 18x 18x 32x 54x 31x 31x 16x 16x 31x 54x 11x 54x 5x 5x 54x 54x 54x 54x 54x 11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var resolve = require( 'path' ).resolve;
var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
var isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
var cwd = require( '@stdlib/process/cwd' );
var exists = require( '@stdlib/fs/exists' ).sync;
var nulls = require( '@stdlib/array/base/nulls' );
var format = require( '@stdlib/string/format' );
var validate = require( './validate.js' );
 
 
// VARIABLES //
 
var MODES = {
	'first': first,
	'some': some,
	'all': all,
	'each': each
};
 
 
// FUNCTIONS //
 
/**
* Synchronously resolves the first path match from a set of paths by walking parent directories.
*
* @private
* @param {Array<string>} paths - paths to resolve
* @param {string} dir - base directory
* @returns {Array<string>} resolved paths
*/
function first( paths, dir ) {
	var child;
	var spath;
	var out;
	var i;
 
	// Start at a base directory and continue moving up through each parent directory...
	out = [];
	while ( child !== dir ) {
		for ( i = 0; i < paths.length; i++ ) {
			spath = resolve( dir, paths[ i ] );
			if ( exists( spath ) ) {
				out.push( spath );
				return out;
			}
		}
		child = dir;
		dir = resolve( dir, '..' );
	}
	return out;
}
 
/**
* Synchronously resolves one or more paths from a set of paths at a directory level by walking parent directories.
*
* @private
* @param {Array<string>} paths - paths to resolve
* @param {string} dir - base directory
* @returns {Array<string>} resolved paths
*/
function some( paths, dir ) {
	var child;
	var spath;
	var out;
	var i;
 
	// Start at a base directory and continue moving up through each parent directory...
	out = [];
	while ( child !== dir ) {
		for ( i = 0; i < paths.length; i++ ) {
			spath = resolve( dir, paths[ i ] );
			if ( exists( spath ) ) {
				out.push( spath );
			}
		}
		if ( out.length > 0 ) {
			return out;
		}
		child = dir;
		dir = resolve( dir, '..' );
	}
	return out;
}
 
/**
* Synchronously resolves all paths from a set of paths at a directory level by walking parent directories.
*
* @private
* @param {Array<string>} paths - paths to resolve
* @param {string} dir - base directory
* @returns {Array<string>} resolved paths
*/
function all( paths, dir ) {
	var child;
	var spath;
	var out;
	var i;
 
	// Start at a base directory and continue moving up through each parent directory...
	out = [];
	while ( child !== dir ) {
		for ( i = 0; i < paths.length; i++ ) {
			spath = resolve( dir, paths[ i ] );
			if ( exists( spath ) ) {
				out.push( spath );
			}
		}
		if ( out.length === paths.length ) {
			return out;
		}
		out = [];
		child = dir;
		dir = resolve( dir, '..' );
	}
	return out;
}
 
/**
* Synchronously resolves each path from a set of paths by walking parent directories.
*
* @private
* @param {Array<string>} paths - paths to resolve
* @param {string} dir - base directory
* @returns {Array<(string|null)>} resolved paths
*/
function each( paths, dir ) {
	var count;
	var child;
	var spath;
	var out;
	var i;
 
	count = 0;
	out = nulls( paths.length );
 
	// Start at a base directory and continue moving up through each parent directory...
	while ( child !== dir ) {
		for ( i = 0; i < paths.length; i++ ) {
			if ( out[ i ] !== null ) {
				continue;
			}
			spath = resolve( dir, paths[ i ] );
			if ( exists( spath ) ) {
				out[ i ] = spath;
				count += 1;
			}
		}
		if ( count === paths.length ) {
			break;
		}
		child = dir;
		dir = resolve( dir, '..' );
	}
	return out;
}
 
 
// MAIN //
 
/**
* Synchronously resolves paths from a set of paths by walking parent directories.
*
* @param {Array<string>} paths - paths to resolve
* @param {Options} [options] - function options
* @param {string} [options.dir] - base directory
* @param {string} [options.mode='all'] - mode of operation
* @throws {TypeError} first argument must be an array of strings
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {Array<(string|null)>} resolved paths
*
* @example
* var paths = resolveParentPaths( [ 'package.json', 'package-lock.json' ] );
*/
function resolveParentPaths( paths, options ) {
	var opts;
	var mode;
	var dir;
	var fcn;
	var err;
 
	if ( !isStringArray( paths ) ) {
		if ( isArrayLikeObject( paths ) && paths.length === 0 ) {
			return [];
		}
		throw new TypeError( format( 'invalid argument. First argument must be an array of strings. Value: `%s`.', paths ) );
	}
	opts = {};
	if ( arguments.length > 1 ) {
		err = validate( opts, options );
		if ( err ) {
			throw err;
		}
	}
	if ( opts.dir ) {
		dir = resolve( cwd(), opts.dir );
	} else {
		dir = cwd();
	}
	mode = opts.mode || 'all';
 
	fcn = MODES[ mode ];
	return fcn( paths, dir );
}
 
 
// EXPORTS //
 
module.exports = resolveParentPaths;