https://github.com/pvorb/node-dive

walk through directory trees and apply an action to every file
https://github.com/pvorb/node-dive

Last synced: 12 days ago
JSON representation

walk through directory trees and apply an action to every file

• Host: GitHub
• URL: https://github.com/pvorb/node-dive
• Owner: pvorb
• License: mit
• Created: 2011-08-09T21:35:37.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-12-24T01:21:55.000Z (almost 9 years ago)
• Last Synced: 2024-11-01T01:22:59.488Z (19 days ago)
• Language: JavaScript
• Homepage: https://npmjs.org/package/dive
• Size: 31.3 KB
• Stars: 47
• Watchers: 4
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dive

a tiny module for node that is able to recursively walk (_“dive”_) a

directory tree. There’s also an synchronous version of dive called

[diveSync](//github.com/pvorb/node-diveSync).

~~~ javascript

dive(directory[, options], action[, complete]);

~~~

*   `directory` is the pathname of a readable directory.

*   `options` [optional] is an object that defines some of the properties.

    The default options are as follows:

    ~~~ javascript

    {

      recursive: true,    // - If set to false, this will ignore subdirectories.

      all: false,         // - If set to true, this will show "dot files" and

                          //   files in "dot directories", e.g. ".gitignore" or

                          //  ".git/HEAD".

      directories: false  // - If set to true, this will call `action` on

                          //   directories, too.

      files: true         // - If set to false, this won't call `action` on

                          //   files any more.

      ignore: false       // - If set to a string or RegExp, all files and

                          //   directories that match will be ignored.

    }

    ~~~

*   `action` is passed three arguments `(err, file, stat)` where `err` is an

    error or `null`, `file` is the pathname of a file and `stat` is an

    [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats) object.

*   `complete [optional]` may define a second callback, that is called, when all

    files have been processed. It takes no arguments.

## Installation

    npm install dive

## Usage

Default:

~~~ javascript

var dive = require('dive');

dive(process.cwd(), function(err, file) {

});

~~~

All files and a callback in the end:

~~~ javascript

var dive = require('dive');

dive(process.cwd(), { all: true }, function(err, file, stat) {

  if (err) throw err;

  console.log(file);

}, function() {

  console.log('complete');

});

~~~

Directories only:

~~~ javascript

var dive = require('dive');

dive(process.cwd(), { directories: true, files: false }, function(err, dir) {

  if (err) throw err;

  console.log(dir);

});

~~~

## Bugs and Issues

If you encounter any bugs or issues, feel free to

[open an issue at github](//github.com/pvorb/node-dive/issues) or send me an

email to . I also always like to hear from you, if you’re using my

code.

## License

(The MIT License)

Copyright © 2011-2015 Paul Vorbach

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the “Software”), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.