dir-glob

dir-glob

Convert directories to glob compatible strings

Install

$ npm install dir-glob

Usage

const dirGlob = require('dir-glob');

(async () => {
	console.log(await dirGlob(['index.js', 'test.js', 'fixtures']));
	//=> ['index.js', 'test.js', 'fixtures/**']

	console.log(await dirGlob(['index.js', 'inner_folder'], {cwd: 'fixtures'}));
	//=> ['index.js', 'inner_folder/**']

	console.log(await dirGlob(['lib/**', 'fixtures'], {
		files: ['test', 'unicorn']
		extensions: ['js']
	}));
	//=> ['lib/**', 'fixtures/**/test.js', 'fixtures/**/unicorn.js']

	console.log(await dirGlob(['lib/**', 'fixtures'], {
		files: ['test', 'unicorn', '*.jsx'],
		extensions: ['js', 'png']
	}));
	//=> ['lib/**', 'fixtures/**/test.{js,png}', 'fixtures/**/unicorn.{js,png}', 'fixtures/**/*.jsx']
})();

API

dirGlob(input, options?)

Returns a Promise<string[]> with globs.

dirGlob.sync(input, options?)

Returns a string[] with globs.

input

Type: string | string[]

Paths.

options

Type: object

extensions

Type: string[]

Append extensions to the end of your globs.

files

Type: string[]

Only glob for certain files.

cwd

Type: string[]

Test in specific directory.

Similar packages

Other packages similar to dir-glob

glob

The 'glob' package provides pattern matching functionality for file paths. While 'glob' itself focuses on matching patterns against existing file structures, 'dir-glob' specifically converts directory paths into glob patterns. 'glob' can be used in conjunction with 'dir-glob' to first generate glob patterns for directories and then match those patterns against files.

fast-glob

Similar to 'glob', 'fast-glob' is an optimized version that provides a faster and more efficient way to match glob patterns against file systems. It offers a similar functionality to 'dir-glob' in terms of working with glob patterns, but it does not specifically focus on converting directories to globs. Instead, it's more about performing the matching operation itself, potentially using patterns generated by 'dir-glob'.