glob 7.1.7

Glob is a widely-used npm package that matches files using the same patterns as the shell. Regarded as one of the most accurate and efficient glob implementations in JavaScript, Glob helps you match and handle files and directories following specific patterns. Using this package, you can conveniently match, ignore, search, and filter files using patterns like *.js (for matching all JavaScript files), **/*.txt (for matching all text files in all directories), and many more.

Before you can use Glob, you need to install it in your Node.js project using npm. The npm package name is "glob". Install it by running npm i glob in your project directory.

After installation, you can import or require Glob in your JavaScript file. Glob provides several methods that you can use, including glob, globSync, globStream, and globStreamSync. You can also use the Glob class to perform glob pattern traversals multiple times, which can be faster if you need to look in the same folder multiple times.

Here's a code example:

// Import Glob
import { glob, globSync } from 'glob';

// Match all .js files but ignore those in node_modules
const jsfiles = await glob('**/*.js', { ignore: 'node_modules/**' });

// Use globSync for synchronous operation
const imagesAlt = globSync('{css,public}/*.{png,jpeg}');

Note that Glob always uses / as a path separator, regardless of the operating system.

The official Glob documentation is comprehensive and provides detailed usage examples, information about different options you can use with Glob methods, comparisons to other glob implementations, and clarifications on Glob's behavior concerning different filesystem entities. The documentation also includes details about Glob's command-line interface for extra flexibility and convenience. Additionally, you can gain insights into Glob's internals by checking out the source code on its GitHub repository.