Awesome
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 toprocess.cwd()
.absolute
: Whether to return absolute paths. Defaults tofalse
.dot
: Whether to allow entries starting with a dot. Defaults tofalse
.deep
: Maximum depth of a directory. Defaults toInfinity
.followSymbolicLinks
: Whether to traverse and include symbolic links. Defaults totrue
.caseSensitiveMatch
: Whether to match in case-sensitive mode. Defaults totrue
.expandDirectories
: Whether to expand directories. Disable to best matchfast-glob
. Defaults totrue
.onlyDirectories
: Enable to only return directories. DisablesonlyFiles
if set. Defaults tofalse
.onlyFiles
: Enable to only return files. Defaults totrue
.
Used by
tinyglobby
is downloaded many times by projects all around the world. Here's a list of notable projects that use it:
vitest
ts-morph
sort-package-json
tsup
cspell
nuxt
vite-plugin-pwa
size-limit
postcss-mixins
unocss
vitepress
pkg.pr.new
- Your own project? Open an issue if you feel like this list is incomplete.