Tinyglobby NPM

tinyglobby

A fast and minimal alternative to globby and fast-glob, meant to behave the same way.

Both globby and fast-glob present some behavior no other globbing lib has, which makes it hard to manually replace with something smaller and better.

This library uses only two subdependencies, compared to globby's 23 and fast-glob's 17.

Usage

import { glob, globSync } from 'tinyglobby';

await glob(['files/*.ts', '!**/*.d.ts'], { cwd: 'src' });
globSync(['src/**/*.ts'], { ignore: ['**/*.d.ts'] });

API

glob(patterns: string | string[], options: GlobOptions): Promise<string[]>: Returns a promise with an array of matches.
globSync(patterns: string | string[], options: GlobOptions): string[]: Returns an array of matches.
convertPathToPattern(path: string): string: Converts a path to a pattern depending on the platform.
escapePath(path: string): string: Escapes a path's special characters depending on the platform.
isDynamicPattern(pattern: string, options?: GlobOptions): boolean: Checks if a pattern is dynamic.

Options

patterns: An array of glob patterns to search for. Defaults to ['**/*'].
ignore: An array of glob patterns to ignore.
cwd: The current working directory in which to search. Defaults to process.cwd().
absolute: Whether to return absolute paths. Defaults to false.
dot: Whether to allow entries starting with a dot. Defaults to false.
deep: Maximum depth of a directory. Defaults to Infinity.
followSymbolicLinks: Whether to traverse and include symbolic links. Defaults to true.
caseSensitiveMatch: Whether to match in case-sensitive mode. Defaults to true.
expandDirectories: Whether to expand directories. Disable to best match fast-glob. Defaults to true.
onlyDirectories: Enable to only return directories. Disables onlyFiles if set. Defaults to false.
onlyFiles: Enable to only return files. Defaults to true.