tinyglobby

tinyglobby is a fast and minimal alternative to globby and fast-glob. It is designed to behave the same way as those libraries but with significantly fewer dependencies (only two subdependencies compared to 23 for globby and 17 for fast-glob).

npm install tinyglobby

You can use tinyglobby via its asynchronous glob function or its synchronous globSync function. The API is designed to be compatible with globby and fast-glob patterns, supporting arrays of patterns, negation (e.g., !**/*.d.ts), and option objects like cwd or ignore.

import { glob, globSync } from 'tinyglobby';

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

// Synchronous usage
globSync('src/**/*.ts', { ignore: '**/*.d.ts' });

The tsdown.config.ts file is used to define the build configuration for the project using defineConfig from tsdown/config.

Key configuration options include:

• format: An array of output formats. Common values are 'esm' (ES Modules) and 'cjs' (CommonJS).
• nodeProtocol: Defines how Node.js module resolution is handled. In this configuration, it is set to 'strip'.

import { defineConfig, type UserConfig } from 'tsdown/config';

export default defineConfig({
  format: ['esm', 'cjs'],
  nodeProtocol: 'strip'
}) as UserConfig;

The GlobInput type defines what you can pass to the tinyglobby entry point. It accepts:

• A single string pattern.
• A readonly string[] of patterns.
• A GlobOptions object for advanced configuration.

type GlobInput = string | readonly string[] | GlobOptions;

You can provide a custom FileSystemAdapter via the fs option in GlobOptions. This allows you to mock or redirect file system operations (like readdir, stat, etc.) during globbing. This is useful for testing or working with virtual file systems.

The adapter must provide implementations for:

• readdir / readdirSync
• realpath / realpathSync
• stat / statSync

import { glob } from 'tinyglobby';

const files = await glob('**/*.txt', {
  fs: {
    // Override specific methods
    readdir: myCustomReaddir,
    stat: myCustomStat
  }
});

Use the globSync function to find files matching glob patterns synchronously. It returns an array of file paths immediately.

Usage:

• Pass a string or an array of strings as the first argument.
• Pass an optional GlobOptions object as the second argument.

Note: Passing an object containing patterns as the first argument is deprecated. Use the patterns argument instead.

import { globSync } from 'tinyglobby';

// Single pattern
const files = globSync('src/**/*.ts');

// Multiple patterns
const files = globSync(['src/**/*.ts', 'test/**/*.ts'], { onlyFiles: true });

The FileSystemAdapter type allows you to provide a partial implementation of FSLike (from the fdir package). This is useful for overriding node:fs functions, such as when performing tests with a mocked file system.

import type { FSLike } from 'fdir';

export type FileSystemAdapter = Partial<FSLike>;

Use the glob function to asynchronously find files that match one or more glob patterns. It returns a Promise that resolves to an array of file paths.

Usage:

• Pass a string or an array of strings as the first argument.
• Pass an optional GlobOptions object as the second argument.

Note: Passing an object containing patterns as the first argument is deprecated. Use the patterns argument instead.

import { glob } from 'tinyglobby';

// Single pattern
const files = await glob('src/**/*.ts');

// Multiple patterns
const files = await glob(['src/**/*.ts', 'test/**/*.ts'], { onlyFiles: true });