https://github.com/kevva/dir-glob

Convert directories to glob compatible strings
https://github.com/kevva/dir-glob

directories glob globbing matching nodejs pattern

Last synced: 13 days ago
JSON representation

Convert directories to glob compatible strings

• Host: GitHub
• URL: https://github.com/kevva/dir-glob
• Owner: kevva
• License: mit
• Created: 2016-01-08T10:07:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-09-30T12:07:12.000Z (about 5 years ago)
• Last Synced: 2024-08-21T11:38:12.149Z (3 months ago)
• Topics: directories, glob, globbing, matching, nodejs, pattern
• Language: JavaScript
• Size: 19.5 KB
• Stars: 44
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-javascript - dir-glob
• awesome-javascript - dir-glob

README

        
# dir-glob [![Build Status](https://travis-ci.org/kevva/dir-glob.svg?branch=master)](https://travis-ci.org/kevva/dir-glob)

> Convert directories to glob compatible strings

## Install

```

$ npm install dir-glob

```

## Usage

```js

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` 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.

---



	

		Get professional support for this package with a Tidelift subscription

	

	


	

		Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.