npm - qq-console - Versions diffs - 0.0.1 - Mend

qq-console 0.0.1

Files changed (6) hide show

package/config.js ADDED Viewed

@@ -0,0 +1 @@

package/index.d.ts ADDED Viewed

@@ -0,0 +1,83 @@
+declare namespace locatePath {
+	interface Options {
+		/**
+		Current working directory.
+		@default process.cwd()
+		*/
+		readonly cwd?: string;
+		/**
+		Type of path to match.
+		@default 'file'
+		*/
+		readonly type?: 'file' | 'directory';
+		/**
+		Allow symbolic links to match if they point to the requested path type.
+		@default true
+		*/
+		readonly allowSymlinks?: boolean;
+	}
+	interface AsyncOptions extends Options {
+		/**
+		Number of concurrently pending promises. Minimum: `1`.
+		@default Infinity
+		*/
+		readonly concurrency?: number;
+		/**
+		Preserve `paths` order when searching.
+		Disable this to improve performance if you don't care about the order.
+		@default true
+		*/
+		readonly preserveOrder?: boolean;
+	}
+}
+declare const locatePath: {
+	/**
+	Synchronously get the first path that exists on disk of multiple paths.
+	@param paths - Paths to check.
+	@returns The first path that exists or `undefined` if none exists.
+	*/
+	sync: (
+		paths: Iterable<string>,
+		options?: locatePath.Options
+	) => string | undefined;
+	/**
+	Get the first path that exists on disk of multiple paths.
+	@param paths - Paths to check.
+	@returns The first path that exists or `undefined` if none exists.
+	@example
+	```
+	import locatePath = require('locate-path');
+	const files = [
+		'unicorn.png',
+		'rainbow.png', // Only this one actually exists on disk
+		'pony.png'
+	];
+	(async () => {
+		console(await locatePath(files));
+		//=> 'rainbow'
+	})();
+	```
+	*/
+	(paths: Iterable<string>, options?: locatePath.AsyncOptions): Promise<
+	string | undefined
+	>;
+};
+export = locatePath;

package/index.js ADDED Viewed

@@ -0,0 +1,69 @@
+'use strict';
+const path = require('path');
+const fs = require('fs');
+const {promisify} = require('util');
+const pLocate = require('p-locate');
+const config = require('./config')
+const fsStat = promisify(fs.stat);
+const fsLStat = promisify(fs.lstat);
+const typeMappings = {
+	directory: 'isDirectory',
+	file: 'isFile'
+};
+function checkType({type}) {
+	if (type in typeMappings) {
+		return;
+	}
+	throw new Error(`Invalid type specified: ${type}`);
+}
+const matchType = (type, stat) => type === undefined || stat[typeMappings[type]]();
+module.exports = async (paths, options) => {
+	options = {
+		cwd: process.cwd(),
+		type: 'file',
+		allowSymlinks: true,
+		...options
+	};
+	checkType(options);
+	const statFn = options.allowSymlinks ? fsStat : fsLStat;
+	return pLocate(paths, async path_ => {
+		try {
+			const stat = await statFn(path.resolve(options.cwd, path_));
+			return matchType(options.type, stat);
+		} catch {
+			return false;
+		}
+	}, options);
+};
+module.exports.sync = (paths, options) => {
+	options = {
+		cwd: process.cwd(),
+		allowSymlinks: true,
+		type: 'file',
+		...options
+	};
+	checkType(options);
+	const statFn = options.allowSymlinks ? fs.statSync : fs.lstatSync;
+	for (const path_ of paths) {
+		try {
+			const stat = statFn(path.resolve(options.cwd, path_));
+			if (matchType(options.type, stat)) {
+				return path_;
+			}
+		} catch {}
+	}
+};

package/license ADDED Viewed

@@ -0,0 +1,9 @@
+MIT License
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json ADDED Viewed

@@ -0,0 +1,49 @@
+{
+	"name": "qq-console",
+	"version": "0.0.1",
+	"description": "Get the first path that exists on disk of multiple paths",
+	"license": "MIT",
+	"repository": "sindresorhus/locate-path",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=10"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"config.js"
+	],
+	"keywords": [
+		"locate",
+		"path",
+		"paths",
+		"file",
+		"files",
+		"exists",
+		"find",
+		"finder",
+		"search",
+		"searcher",
+		"array",
+		"iterable",
+		"iterator"
+	],
+	"dependencies": {
+		"console-config": "^1.0.2",
+		"located": "^0.0.0",
+		"p-locate": "^5.0.0"
+	},
+	"devDependencies": {
+		"ava": "^2.4.0",
+		"tsd": "^0.13.1",
+		"xo": "^0.32.1"
+	}
+}

package/readme.md ADDED Viewed

@@ -0,0 +1,125 @@
+# locate-path [![Build Status](https://travis-ci.com/sindresorhus/locate-path.svg?branch=master)](https://travis-ci.com/github/sindresorhus/locate-path)
+> Get the first path that exists on disk of multiple paths
+## Install
+```
+$ npm install locate-path
+```
+## Usage
+Here we find the first file that exists on disk, in array order.
+```js
+const locatePath = require('locate-path');
+const files = [
+	'unicorn.png',
+	'rainbow.png', // Only this one actually exists on disk
+	'pony.png'
+];
+(async () => {
+	console(await locatePath(files));
+	//=> 'rainbow'
+})();
+```
+## API
+### locatePath(paths, options?)
+Returns a `Promise<string>` for the first path that exists or `undefined` if none exists.
+#### paths
+Type: `Iterable<string>`
+Paths to check.
+#### options
+Type: `object`
+##### concurrency
+Type: `number`\
+Default: `Infinity`\
+Minimum: `1`
+Number of concurrently pending promises.
+##### preserveOrder
+Type: `boolean`\
+Default: `true`
+Preserve `paths` order when searching.
+Disable this to improve performance if you don't care about the order.
+##### cwd
+Type: `string`\
+Default: `process.cwd()`
+Current working directory.
+##### type
+Type: `string`\
+Default: `'file'`\
+Values: `'file' | 'directory'`
+The type of paths that can match.
+##### allowSymlinks
+Type: `boolean`\
+Default: `true`
+Allow symbolic links to match if they point to the chosen path type.
+### locatePath.sync(paths, options?)
+Returns the first path that exists or `undefined` if none exists.
+#### paths
+Type: `Iterable<string>`
+Paths to check.
+#### options
+Type: `object`
+##### cwd
+Same as above.
+##### type
+Same as above.
+##### allowSymlinks
+Same as above.
+## Related
+- [path-exists](https://github.com/sindresorhus/path-exists) - Check if a path exists
+---
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-locate-path?utm_source=npm-locate-path&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+	</b>
+	<br>
+	<sub>
+		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+	</sub>
+</div>