@open-tech-world/node-glob

Match files & directories using glob patterns.

It uses @open-tech-worl/es-glob for matching paths.

See the list of supported glob patterns here.

Features

✔️ Sync Matching API

🚧 Async Matching API

✔️ Supports Multiple Patterns

Installation

Using npm

npm install @open-tech-world/node-glob

Using Yarn

yarn add @open-tech-world/node-glob

Usage

import { globSync } from '@open-tech-world/node-glob';

globSync(patterns: string | string[], 
         options?: Partial<IOptions>): string[];

Options

| Name | Type | Default | Description | |------|------|---------|------| | cwd | string | process.cwd() | The current working directory in which to search files & folders.| | dot | boolean | false | If true, it matches files & directories that begin with a "."(dot) character.| | absolute | boolean | false | If true, it returns the absolute path.| | dirs | boolean | true | If false, it does not include directories.| | files | boolean | true | If false, it does not include files.|

Examples

my-app/
├─ node_modules/
├─ public/
│  ├─ favicon.ico
│  ├─ index.html
│  ├─ robots.txt
├─ src/
│  ├─ index.css
│  ├─ index.js
├─ .gitignore
├─ package.json
├─ README.md

import { globSync } from '@open-tech-world/node-glob';

globSync(['*']) // ['node_modules', 'public', 'src', 'package.json', 'README.md']

globSync(['*'], { dot: true }) // ['node_modules', 'public', 'src', '.gitignore', 'package.json', 'README.md']

globSync(['*', '!node_modules']) // ['public', 'src', 'package.json', 'README.md']

globSync(['*.json']) // ['package.json']

globSync(['src/index.*']) // ['src/index.css', 'src/index.js']

globSync(['**/index.[a-j]*']) // ['src/index.css', 'src/index.js']

globSync(['public/*.(html|ico)']) // ['public/index.html', 'public/favicon.ico']

License

Copyright (c) 2021, Thanga Ganapathy (MIT License).