Negotiate Pushing Milestone

    snyk-recursive-readdir

    2.0.0 • Public • Published

    recursive-readdir

    Build Status

    A simple Node module for recursively listing all files in a directory, or in any subdirectories.

    It does not list directories themselves.

    Because it uses fs.readdir, which calls readdir under the hood on OS X and Linux, the order of files inside directories is not guaranteed.

    Installation

    npm install recursive-readdir
    

    Usage

    var recursive = require('recursive-readdir');
     
    recursive('some/path', function (err, files) {
      // Files is an array of filename
      console.log(files);
    });

    It can also take a list of files to ignore.

    var recursive = require('recursive-readdir');
     
    // ignore files named 'foo.cs' or files that end in '.html'.
    recursive('some/path', ['foo.cs', '*.html'], function (err, files) {
      // Files is an array of filename
      console.log(files);
    });

    You can also pass functions which are called to determine whether or not to ignore a file:

    var recursive = require('recursive-readdir');
     
    function ignoreFunc(file, stats) {
      // `file` is the absolute path to the file, and `stats` is an `fs.Stats`
      // object returned from `fs.lstat()`.
      return stats.isDirectory() && path.basename(file) == "test";
    }
     
    // Ignore files named 'foo.cs' and descendants of directories named test
    recursive('some/path', ['foo.cs', ignoreFunc], function (err, files) {
      // Files is an array of filename
      console.log(files);
    });

    The ignore strings support Glob syntax via minimatch.

    Install

    npm i snyk-recursive-readdir

    DownloadsWeekly Downloads

    2,233

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • snyk-admin