File size: 4,233 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# node-walk-sync
[](https://travis-ci.org/joliss/node-walk-sync)
[](https://ci.appveyor.com/project/joliss/node-walk-sync/branch/master)
Return an array containing all recursive files and directories under a given
directory, similar to Unix `find`. Follows symlinks. Bare-bones, but
very fast.
Similar to [`wrench.readdirSyncRecursive`](https://github.com/ryanmcgrath/wrench-js#synchronous-operations),
but adds trailing slashes to directories.
Not to be confused with [node-walk](https://github.com/coolaj86/node-walk),
which has both an asynchronous and a synchronous API.
## Installation
```bash
yarn add walk-sync
```
## Usage
```js
const walkSync = require('walk-sync');
const paths = walkSync('project')
```
Given `project/one.txt` and `project/subdir/two.txt`, `paths` will be the following
array:
```js
['one.txt', 'subdir/', 'subdir/two.txt']
```
Directories come before their contents, and have a trailing forward-slash (on
all platforms).
Symlinks are followed.
### Entries
Sometimes, it is important to get additional information from a walk of a
directory; for instance if the downstream consumer needs to stat the files we
can leverage the stats from the walk.
To accommodate, `walkSync.entries(path [, options])` is also provided, instead
of returning a list of files and/or directories it returns an array of objects
which correspond to a given file or directory, except with more data.
```
entry.relativePath
entry.mode // => fs.statSync(fullPath).mode
entry.size // => fs.statSync(fullPath).size
entry.mtime // => fs.statSync(fullPath).mtime.getTime()
entry.isDirectory() // => true if directory
```
### Options
* `globs`: An array of globs. Only files and directories that match at least
one of the provided globs will be returned.
```js
const paths = walkSync('project', { globs: ['subdir/**/*.txt'] });
// => ['subdir/two.txt']
```
As an alternative to string globs, you can pass an array of precompiled
[`minimatch.Minimatch`](https://github.com/isaacs/minimatch#minimatch-class)
instances. This is faster and allows to specify your own globbing options.
* `directories` (default: true): Pass `false` to only return files, not
directories:
```js
const paths = walkSync('project', { directories: false })
// => ['one.txt', 'subdir/two.txt']
```
* `ignore`: An array of globs. Files and directories that match at least one
of the provided globs will be pruned while searching.
```js
const paths = walkSync('project', { ignore: ['subdir'] })
// => ['one.txt']
```
As an alternative to string globs, you can pass an array of precompiled
[`minimatch.Minimatch`](https://github.com/isaacs/minimatch#minimatch-class)
instances. This is faster and allows to specify your own globbing options.
* `includeBasePath` (default: false): Pass `true` to include the basePath in the output.
*note: this flag is only for `walkSync(..)` not `walkSync.entries(..)`*
```js
const paths = walkSync('project', { includeBasePath: true });
// => ['project/one.txt', 'project/subdir/two.txt']
```
* `fs`: Allows an alternative implementation of [fs](https://nodejs.org/api/fs.html) to be supplied.
*examples of alternative filesystems include [memfs](https://github.com/streamich/memfs) or [graceful-fs](https://github.com/isaacs/node-graceful-fs#readme)*
```js
import {Volume, createFsFromVolume} from 'memfs'
const fs = createFsFromVolume(Volume.fromJSON({'aDir/aFile': 'some-contents'}))
const paths = walkSync('project', { fs });
// => ['aDir/', 'aDir/aFile']
```
* `globOptions`: Pass any options for [Minimatch](https://www.npmjs.com/package/minimatch) that will be applied to all items in `globs` and `ignore` that are strings.
If items in `globs` or `ignore` are instances of `minimatch.Minimatch`, the `globOptions` will not be applied.
## Background
`walkSync(baseDir)` is a faster substitute for
```js
glob.sync('**', {
cwd: baseDir,
dot: true,
mark: true,
strict: true
})
```
|