# traverse-fs

> Nodejs npm module to traverse folder using code or cli or use glob patterns traverse-cli or traverse-fs or fssys

Latest version **1.0.0** (published 2025-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install traverse-fs
pnpm add traverse-fs
yarn add traverse-fs
bun add traverse-fs
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2025-11-22 |
| First published | 2022-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 163.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ganesh Bhat |
| Maintainers | ganeshkbhat |
| Keywords | traverse, traverse files, traverse folders, search, search files, search folders, traverse-cli, traverse-fs, fssys, convert, traverse, traverser, manipulate, types, type, is, generate, produce, deep, bean, path, file, system, descend, directory, walk, find, recursive, walk, recursive, map, deep, mapper, walk, walker, preorder, postorder, search, json, nested, flatten, find, search, iterate, all, array, directories, expand, files, filesystem, filter, find, match, folders, fsglob, globbing, globs, gulp, friendlymatch, matcher, minimatch, multi, multiple paths, pattern, patterns, util, utility, wildcard, wildcards, promise, git, ignoregit, fsutil, utility, visit, walk, parents, js, javascript, graph, vertex, walk, walker, recursive, recursion, iterator, iterating, traversal, traversal folder tree, traversalfoldertree |

## Links

- npm: https://www.npmjs.com/package/traverse-fs
- Repository: https://github.com/traverse-fs/glob-traverse-fs
- Homepage: https://github.com/traverse-fs/glob-traverse-fs#readme
- Issues: https://github.com/traverse-fs/glob-traverse-fs/issues
- npm.io page: https://npm.io/package/traverse-fs

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2025-11-22
- 0.0.9 — 2022-10-16
- 0.0.8 — 2022-10-16
- 0.0.7 — 2022-10-15
- 0.0.6 — 2022-09-23
- 0.0.5 — 2022-09-23
- 0.0.4 — 2022-09-21
- 0.0.3 — 2022-09-21
- 0.0.2 — 2022-09-21
- 0.0.1 — 2022-09-19

## README

# traverse-fs

Nodejs npm module to traverse files and folder using code, or cli, or use glob patterns

`npm i traverse-fs --save`

<!-- `npm i traverse-cli -g` -->
<!-- `npm i traverse-cli --save` -->

<!-- `npm i fssys --save` -->

# Usage

The API of traverse-fs can be used to traverse a folder or its subfolders recursively.

All the demos codes are here in the github demos folder: [demos](https://github.com/traverse-fs/glob-traverse-fs/tree/main/demos)

#### Simple - Usage

You can use `traverse.dir` which by default traverses a single specified folder. However, you can change it to traverse recursively for it sub folders as well. You can find a simple usage of the api as below:

```

var traverse = require("traverse-fs);
var path = require("path");

// traverse.dir("./", callback);

// Alternatively, you can specify specific callbacks of your own and go recursive traversing
traverse.dir("./", (dir, file) => { return path.join(dir, file.name) }, shouldRecurse = true).then(console.log);

```

#### Simple - Return Nested Array

You can use the directory/ folder traversing and get a `return of a nested array (array of arrays)` as the result.

```

var traverse = require("traverse-fs);
traverse.traversePath("./", console.log, shouldRecurse = true)
// traverse.dir("./", console.log, shouldRecurse = true)

```

#### Simple - Return Single Level Array

You can use the directory/ folder traversing and get a `return of a single level array` as the result. The result will have the complete path of the file in case the file being in the sub directory.

```

var traversePath = require("traverse-fs").traversePath;
var path = require("path");
const TEMP_DIR = resolve('./temp_traversal_root');
async function main() {
    const generalCallback = async (path, name, isDir) => { console.log }
    try {
        await traversePath(TEMP_DIR, generalCallback);
    } catch (e) {
        console.error("Traversal Test 1 failed:", e.message);
    }
}

```

#### Simple - Return JSON

You can use the directory/ folder traversing and get a `return of a json` as the result. The result will have the complete path of the file in case the file being in the sub directory.

```
const userExampleStructure = {
    "dir": {
        "dir2": {},
        "file1": "",
        "file2": ""
    }
};

const userPaths = flattenStructureToPaths(userExampleStructure);
userPaths.forEach(p => console.log(p));


```

#### Simple - Simple Search usage

```

const fs = require('fs').promises;
const path = require('path');
const { resolve, dirname, join } = path;
const { traversePath, getDirectorySize, traverseFS } = require("../index.js")


const foundFiles = [];
const TEMP_DIR = resolve('./temp_traversal_root');
const searchCallback = async (path, name, isDir) => {
    if (!isDir && (name.endsWith('.jsx') || name.endsWith('.js') )) {
        // Found a match: store it in our results array
        foundFiles.push(path.replace(dirname(TEMP_DIR), '.'));
    }
    // No need for a print statement here, we collect results silently
};

async function main() {
    try {
        // Start search only in the 'src' subdirectory
        await traversePath(TEMP_DIR, searchCallback);

        console.log(`\nSearch Complete. Found ${foundFiles.length} JSX files:`);
        foundFiles.forEach(file => console.log(`\t- \x1b[33m${file}\x1b[0m`)); // Yellow
    } catch (e) {
        console.error("Traversal Test 2 failed:", e.message);
    }

}

main()

```

<!-- 

{
    search: (d: any, r: any, cb: ((d: any, f: any, searchPattern: any, flag?: undefined) => string | false) | undefined, pe: any, pef: any, type?: string, options?: {
        search: string;
        text: never[];
    }) => void;
    filter: (d: any, r: any, cb: ((d: any, f: any, searchPattern: any, flag?: undefined) => string | false) | undefined, pe: any, pef: any, type?: string, options?: {
        search: string;
        text: never[];
    }) => void;
    regex: (d: any, r: any, cb: ((d: any, f: any, searchPattern: any, flag?: undefined) => string | false) | undefined, pe: any, pef: any, type?: string, options?: {
        regex: string;
        pattern: null;
        text: never[];
    }) => void;
    dir: (directory: any, recursive: any, fetchModifierCallback: any, handleProcessExit: any, errorHandler: any, type: any, options?: {
        before: () => void;
        after: () => void;
    }) => any;
    returnNestedArray: (directory: any, recursive: any, fetchModifierCallback: ((directory: any, fileDirent: any) => string) | undefined, handleProcessExit: any, errorHandler: any, type: string | undefined, options: any) => any;
    returnFlatArray: (directory: any, recursive: any, fetchModifierCallback: ((directory: any, fileDirent: any) => string) | undefined, handleProcessExit: any, errorHandler: any, type: string | undefined, options: any) => any;
    returnJSON: (directory: any, recursive: any, fetchModifierCallback: ((directory: any, fileDirent: any) => string) | undefined, handleProcessExit: any, errorHandler: any, type: string | undefined, options: any) => any;
    callbacks: {
        search: (d: any, f: any, searchPattern: any, flag?: undefined) => string | false;
        searchFiles: (d: any, f: any, searchPattern: any, flag?: undefined) => string | false;
        searchFolder: (d: any, f: any, searchPattern: any, flag?: undefined) => string | false;
        defaultFetch: (directory: any, fileDirent: any) => string;
        jsonFetch: (directory: any, fileDirent: any) => string;
        errorHandler: (error: any) => void;
    };
    cliArgs: (argList: any) => any;
} 

-->



<!-- 
#### Simple - Simple Search usage with Return Nested Array

TODO

#### Simple - Simple Search usage with Return Single Level Array

TODO

#### Simple - Simple Search usage with Return JSON

TODO

#### CLI - Simple CLI Get usage

TODO

#### CLI - Simple CLI Search usage

TODO -->

#### API for traverse-fs / fssys

<br/>

- `traverse.dir` Usage and Default implementations:

```
    traverse.dir(
      directory = "./",     // directory to traverse
      callback,             // to run
      recursive = false,    // whether to traverse nested and recursively
      
    )
```

<br/>
<!-- 
<br/>

- `traverse.returnFlatArray` Usage and Default implementations: -->

<!-- 

### Default callback implementation

<br/>

- traverse.callbacks
  Usage for traverse.callbacks Function APIs.

  - `traverse.callbacks.defaultFetch` Default Implementations:

```
  (directory, fileDirent) => path.join(directory, fileDirent.name)
```
<br/>

- `traverse.callbacks.jsonFetch` Default Implementation:

```
  (directory, fileDirent) => {
      if ((os.type() === "Windows_NT") && fileDirent.name.includes("\\")) {
          return path.join(fileDirent.name.split("\\").at(-1));
      }
      return path.join(fileDirent.name.split("/").at(-1))
  }
```

<br/>

- `traverse.callbacks.errorHandler` Default Implementation:

```
  (error) => console.log(error)
```

<br/>

While the structure of the callback's returns have to be the same (the file-folder path join names), you can run your own modifier functions on the files and folders as needed and ensure return of file-folder path join names. This allows for changing the files, or folder contents or run any jobs on them, if needed. You can allow for running your own before and after callbacks inside your custom callback functions as needed. It will depend on how you create your custom callback function.

You can also run your own before and after callbacks before traversing or after traversing the files and folders.

Example:
You can use your own callbacks, modifiers, custom jobs, etc like below:

```

function cb(directory, fileDirent){

  function modifierFunction(d, f) {

    specifyBeforeCallback();
    /* Your own modifiers, Running custom functions on files or folders, etc. code here*/
    specifyAfterCallback();

  }

  modifierFunction(directory, fileDirent);
  return path.join(directory, fileDirent.name);
}

traverse.dir(
      directory = "./",
      recursive = false,
      fetchModifierCallback = cb,
      handleProcessExit = false,
      errorHandler = traverse.defaultErrorHandler,
      type = "nestedarray",
      options = { before: () => { }, after: () => { } }
    )

```


- traverse.search [TODO]

- traverse.filter [TODO]

- traverse.regex [TODO]

- traverse.cliargs [TODO] -->

# Contribution

Please feel to make contributions or raise issues to the repository by creating a pull request or [raising an issue](https://github.com/ganeshkbhat/glob-traverse-fs/issues)

# License

[MIT License](./LICENSE)

---
_Source: https://npm.io/package/traverse-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._