glob-all

Common errors

• TypeError: Cannot read properties of undefined (reading 'sync')

  cause Attempting to use `glob-all`'s `sync` method (or the default `glob` function) with incorrect import syntax, often when mixing CommonJS `require` with ESM `import` expectations, or destructuring incorrectly.
  fix For CommonJS, use `const glob = require('glob-all');` and then `glob.sync(...)` or `glob(...)`. For ESM, use `import glob from 'glob-all';` and then `glob.sync(...)` or `glob(...)`, ensuring your environment supports CJS-to-ESM interop.

• No files found for pattern(s)

  cause Glob patterns are incorrect, paths are relative to an unexpected working directory, or exclusion patterns are too broad and accidentally exclude all intended files.
  fix Verify patterns against your actual file structure. Ensure your current working directory (CWD) is where you expect the patterns to resolve from. Test simpler patterns first to isolate issues, and remember that `glob-all` processes patterns sequentially, meaning exclusions can override previous inclusions.

Warnings

• gotcha Custom Exclude Pattern Behavior: `glob-all`'s `!` prefix on a pattern (e.g., `!files/x/**`) provides pattern-level exclusion, which differs from `node-glob`'s in-pattern `!` negation. Patterns are processed in the order they are provided.
  Fix: Understand that `glob-all`'s `!` prefix on a pattern (e.g., `!files/x/**`) provides pattern-level exclusion, which differs from `node-glob`'s in-pattern `!` negation. Patterns are processed in order, so later patterns can re-include files previously excluded.
• gotcha File Order and Precision: When a file matches multiple patterns, the result from the *more precise* pattern takes precedence. This can affect the final order of files in the output array.
  Fix: Order your patterns carefully if you need specific files to appear at the top of the results. Place more precise patterns earlier in the array if their matches should take precedence.
• gotcha Filtering Directories from Results: By default, `glob-all` returns both files and directories. To exclude directories, you need an extra step.
  Fix: Use the `mark: true` option in glob options to append a `/` to directory paths, then filter results manually: `files.filter(f => !/\/$/.test(f));`

Install

• npm install glob-all npm
• yarn add glob-all yarn
• pnpm add glob-all pnpm

Imports

• glob (async)
  wrong:

  import { glob } from 'glob-all';

  correct:

  const glob = require('glob-all');
  glob(patterns, options, callback);

  The primary asynchronous function, exposed as the module's default export in CommonJS environments.
• glob.sync
  wrong:

  import { sync } from 'glob-all';

  correct:

  const glob = require('glob-all');
  const files = glob.sync(patterns, options);

  The synchronous version of the globbing function, available as a property on the default export.
• default (ESM)
  wrong:

  import * as globAll from 'glob-all';

  correct:

  import glob from 'glob-all';

  While primarily a CommonJS module, this is the correct way to import if your environment supports CJS-to-ESM interop. The default import provides the async `glob` function, with `sync` available as a property.

Quickstart

Demonstrates synchronous file matching with multiple include and exclude patterns, showing how to re-include specific files within an excluded directory.

const glob = require('glob-all');
const fs = require('fs');
const path = require('path');

// Create dummy files for demonstration
fs.mkdirSync('files/x', { recursive: true });
fs.writeFileSync('files/a.txt', 'a');
fs.writeFileSync('files/b.txt', 'b');
fs.writeFileSync('files/c.txt', 'c');
fs.writeFileSync('files/x/y.txt', 'y');
fs.writeFileSync('files/x/z.txt', 'z');

const files = glob.sync([
  'files/**',      // include all files/
  '!files/x/**',   // then, exclude files/x/
  'files/x/z.txt'  // then, reinclude files/x/z.txt
]);

console.log(files);

// Clean up dummy files
fs.rmSync('files', { recursive: true, force: true });