smart-glob

KO | EN

gitlite — search

#javascript #react #ai #go #golang #machine-learning #docker #java #windows #cli #vue #awesome-list #security #mcp

(★ 25)

Glob search in constant time thanks to git cache

smart-glob Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# smart-glob

`smart-glob` exports 2 functions

-   `globWithGit` uses the git cache to search for files, the search time should be constant (around 40ms)
-   `glob` does a normal glob search, it also can ignore directories in the `ignore` field

Both functions are tested in unix and windows environments (in windows return paths with `\\` delimiter unless `alwaysReturnUnixPaths` is provided)

In [bump-version](https://github.com/remorses/bump-version) github action i reduced the glob search time form 50 seconds down to 13 seconds using `glob` and to 0.5 seconds using `globWithGit`

```
npm i smart-glob
```

## Usage

```js
import { glob, globWithGit } from 'smart-glob'

const paths = await globWithGit(path.resolve('./tests/**.ts'), {
    cwd: './someFolder',
    // ignore patterns in gitignore
    gitignore: true,
    // output paths are absolute paths
    absolute: true,
    // ignore certain directories
    ignoreGlobs: ['**/dir/**'],
})

const files = await glob('**', {
    gitignore: true, // add the ignore from the .gitignore in current path
    filesOnly: true,
    ignore: ['node_modules'],
})
```

## Cli

```
npm i -g smart-glob
smart-glob './tests/**/*.tsx'
```

## Benchmark

Here is a benchmark with other globs solutions run on this package folder ignoring the `node_modules` directory

You can find this benchmark in the `/tests` folder

```
benchmarks

tiny-glob: 360.615ms
    ✓ tiny-glob (361ms)
fast-glob: 14.863ms
    ✓ fast-glob
globby: 18.128ms
    ✓ globby
glob: 930.975ms
    ✓ glob (931ms)
smart-glob: 6.296ms
    ✓ smart-glob
smart-glob using git: 54.845ms
    ✓ smart-glob using git (55ms)
```

smart-glob

smart-glob Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

smart-glob

smart-glob Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README