Giter Site home page Giter Site logo

node-dive's Introduction

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.

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:

    {
      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 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:

var dive = require('dive');

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

});

All files and a callback in the end:

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:

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 or send me an email to [email protected]. 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.

node-dive's People

Contributors

jamuhl avatar jimbly avatar mape avatar nojvek avatar pike avatar pvorb avatar tssajo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

node-dive's Issues

Cannot walk file and directory at the same time

Hi Paul,
Thanks for your excellent work and contribution.
I find that when walk file and directory together, the walking file function will not work.
Following is the detail:

when I walk file only by calling

dive(process.cwd() + '/modules/', { all: true }, function(err, file) {
    if (err) throw err;
    debug("file:"+file);
}, function() {
    debug('complete');
});

the result is:

  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/models/RoleModel.js +28ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/routes/Role.js +1ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/views/index.html +0ms 
  lib>util:dev-debug complete +0ms

but when I walk file and directory together by calling

dive(process.cwd() + '/modules/', { all: true }, function(err, file) {
    if (err) throw err;
    debug("file:"+file);
}, function() {
    debug('complete');
});

dive(process.cwd() + '/modules/', { directories: true, files: false }, function(err, dir) {
    if (err) throw err;
    debug("dir:"+dir);
},function() {
    debug('complete');
});

the result is:

  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization +107ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization +0ms
lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/config +2ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/controllers +0ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/models +1ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/routes +0ms
  lib>util:dev-debug file:/Users/tony/Development/wcms/modules/authorization/views +0ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization/config +0ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization/controllers +0ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization/models +0ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization/routes +0ms
  lib>util:dev-debug dir:/Users/tony/Development/wcms/modules/authorization/views +0ms
  lib>util:dev-debug complete +28ms
  lib>util:dev-debug complete +0ms

The files are gone when call walk file and directory together.

complete function never gets called in special case

If the directory parameter passed to dive is not a directory (in my case it comes from user input, so it could be whatever garbage) then the complete function of dive never gets called... :(
Note: I noticed that you call in this case the first callback with an error object, but still, I would expect the complete function to be called when dive is finished.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.