https://github.com/laithshadeed/dir-walk

Directory tree traversal using different async & sync traversal algorithms
https://github.com/laithshadeed/dir-walk

directory fs nodejs traversal

Last synced: about 1 month ago
JSON representation

Directory tree traversal using different async & sync traversal algorithms

• Host: GitHub
• URL: https://github.com/laithshadeed/dir-walk
• Owner: laithshadeed
• License: mit
• Created: 2017-02-07T02:35:04.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-05-21T23:46:59.000Z (over 5 years ago)
• Last Synced: 2024-10-16T03:21:00.979Z (3 months ago)
• Topics: directory, fs, nodejs, traversal
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# dir-walk

[![Linux Build status](https://travis-ci.org/laithshadeed/dir-walk.svg?branch=master)](https://travis-ci.org/laithshadeed/dir-walk)

[![Windows Build status](https://ci.appveyor.com/api/projects/status/3yt6ngq4o9hvkgbo?svg=true)](https://ci.appveyor.com/project/laithshadeed/dir-walk)

[![Test coverage](https://coveralls.io/repos/github/laithshadeed/dir-walk/badge.svg?branch=master)](https://coveralls.io/github/laithshadeed/dir-walk?branch=master)

[![npm version](https://badge.fury.io/js/dir-walk.svg)](https://badge.fury.io/js/dir-walk)

 Walk a directory tree recursively with different implementations:

 - Sync Breadth-First Traversal

 - Sync Depth-First Traversal

 - Async using callbacks (Node v4)

 - Async using generators (Node v5)

 - Async using promises (Node v6)

 - Async using async/await (Node v8)

## Install

```

$ yarn add dir-walk

```

## Tests

```

$ yarn test

```

## Examples

```js

const walk = require('dir-walk');

// contents will like {filenames: [list], dirnames: [list], errors: [list]}

walk('/my-dir', function(contents) {

  console.log(contents);

});

// By default sync use Breadth-first Traversal

let contents = walk.sync('/my-dir');

// To use Sync Depth-first Traversal

let contents = walk.sync('/my-dir', {dfs: true});

```

## TODO

  - Add other implementations

   - Promises (Node v4.7.2)

   - Generators (Node v5.11.0)

   - Async/await (Node v8.0.0)

  - Provide option for recursive & non-recursive version

  - Provide option to follow links

  - Check memory for callback-impl for large nested directories due to

    the merging logic.

  - Put a limit for max recursion to avoid stackoverflow.

  - Ensure the asyncs impls do not exceed max file descriptor limit on

    Linux.

  - Put a max cap on memory because the results stored in objects.

  - Provide option to skip non regular files like socket, device file,

    named pipe

  - Check what invalid inode look like

  - Avoid traversing the full file system, like dir = '/' or C://

  - Check different file systems (HFS+, ReFS, NTFS, etc..) handling for

    - Case senstivity & preservation

    - Unicode preservation

    - Hidden files and directories

  - Check support for external drive, USB or network drive

  - Check support of multiple filesystem mounted in the same working tree

## License

MIT © [Laith Shadeed](https://l3.io)