path-reader

Author: AckerApple

CHANGELOG.json CHANGELOG.mdCHANGELOG.json renamed to CHANGELOG.md

@@ -1,6 +1,10 @@
 # path-reader - Change Log
 All notable changes to this project will be documented here.
 
+## [1.1.0] - 2018-02-14
+- valuetizer option when returns null, item is skipped
+- Happy Valentines Day
+
 ## [1.0.6] - 2017-10-13
 - empty folders containing empty items reads are now empty array instead of undefined
 

README.md

@@ -1,3 +1,6 @@
+[![hire me](https://ackerapple.github.io/resume/assets/images/hire-me-badge.svg)](https://ackerapple.github.io/resume/)
+[![npm downloads](https://img.shields.io/npm/dm/path-reader.svg)](https://npmjs.org/path-reader)
+[![Dependency Status](https://david-dm.org/ackerapple/path-reader.svg)](https://david-dm.org/ackerapple/path-reader)
 [![Build Status](https://secure.travis-ci.org/AckerApple/path-reader.svg)](http://travis-ci.org/AckerApple/path-reader)
 [![Build status](https://ci.appveyor.com/api/projects/status/6sa5pfcsrix5s8va?svg=true)](https://ci.appveyor.com/project/AckerApple/path-reader)
 [![NPM version](https://img.shields.io/npm/v/path-reader.svg?style=flat-square)](https://www.npmjs.com/package/path-reader)
@@ -9,24 +12,28 @@ A lightweight Node.js module with methods for some common directory and file ope
 
 - [installation](#installation)
 - [usage](#usage)
-    - [methods](#methods)
-    - [readFiles](#readfiles)
-    - [readFilesStream](#readfilesstream)
-        - [readFilesStream examples](#readfilesstream-examples)
-    - [files async](#files-async)
-    - [files sync](#files-sync)
-    - [promiseFiles](#promisefiles)
-    - [subdirs](#subdirs)
-    - [paths](#paths)
+  - [methods](#methods)
+  - [readFiles](#readfiles)
+  - [options](#options)
+  - [readFilesStream](#readfilesstream)
+    - [readFilesStream examples](#readfilesstream-examples)
+  - [readFiles valuetizer](#readfiles-valuetizer)
+  - [files async](#files-async)
+  - [files sync](#files-sync)
+  - [promiseFiles](#promisefiles)
+  - [subdirs](#subdirs)
+  - [paths](#paths)
 - [API Docs](#api-docs)
-    - [files](#files-api)
-    - [promiseFiles](#promisefiles-api)
+  - [files](#files-api)
+  - [promiseFiles](#promisefiles-api)
 - [History](#history)
 - [License](#license)
 
 #### installation
 
-    npm install path-reader
+```
+npm install path-reader
+```
 
 ### usage
 
@@ -43,26 +50,45 @@ A variation on the method readFilesStream. See usage for [readFilesStream](#read
 readFiles( dir, [options], fileCallback, [finishedCallback] )
 ```
 
+#### Options
+- **encoding** - file encoding (defaults to 'utf8')
+- **exclude** - a regex pattern or array to specify filenames to ignore
+- **excludeDir** - a regex pattern or array to specify directories to ignore
+- **match** - a regex pattern or array to specify filenames to operate on
+- **matchDir** - a regex pattern or array to specify directories to recurse 
+- **recursive** - whether to recurse subdirectories when reading files (defaults to true)
+- **reverse** - sort files in each directory in descending order
+- **shortName** - whether to aggregate only the base filename rather than the full filepath
+- **sort** - sort files in each directory in ascending order (defaults to true)
+  - A reverse sort can also be achieved by setting the sort option to 'reverse', 'desc', or 'descending' string value.
+- **doneOnErr** - control if done function called on error (defaults to true)
+- **sync** : boolean = false - results are returned inline and no callbacks are used
+- **shortName** : boolean = false||'relative' - instead of fullpath file names, just get the names or relative item names
+- **recursive** : boolean = true - traverse through all children of given path
+- **excludeHidden** : boolean - hidden files will be ignored (files starting with a dot are ignored)
+- **valuetizer** : (stat, fileName, filePath) - A function of (stat, fileName, fileFullPath) . When null returned, item is skipped in end results
+
 #### readFilesStream
 Sequentially read the content of each file in a directory, passing the contents to a callback, optionally calling a finished callback when complete.  The options and finishedCallback arguments are not required.
 
 ```javascript
 readFilesStream( dir, [options], streamCallback, [finishedCallback] )
 ```
 
-Valid options are:
-- encoding: file encoding (defaults to 'utf8')
-- exclude: a regex pattern or array to specify filenames to ignore
-- excludeDir: a regex pattern or array to specify directories to ignore
-- match: a regex pattern or array to specify filenames to operate on
-- matchDir: a regex pattern or array to specify directories to recurse 
-- recursive: whether to recurse subdirectories when reading files (defaults to true)
-- reverse: sort files in each directory in descending order
-- shortName: whether to aggregate only the base filename rather than the full filepath
-- sort: sort files in each directory in ascending order (defaults to true)
-- doneOnErr: control if done function called on error (defaults to true)
-
-A reverse sort can also be achieved by setting the sort option to 'reverse', 'desc', or 'descending' string value.
+#### readFiles valuetizer
+An example of building an array of only items with an mtime
+```javascript
+var options = {
+  valuetizer:function(stat, shortName, longPath){
+    return stat.mtime ? stat : null
+  }
+}
+
+require('path-reader').promiseFiles(tdir, 'file', options)
+.then(function(results){
+  console.log(results)//an array of file stat if the file has a mtime definition
+})
+```
 
 #### readFilesStream examples
 
@@ -256,16 +282,17 @@ files(dir, type, callback, options)
 
 - **dir** - directory path to read
 - **type**='file'
-    - 'file' returns only file listings
-    - 'dir' returns only directory listings
-    - 'all' returns {dirs:[], files:[]}
-    - 'combine' returns []
+  - 'file' returns only file listings
+  - 'dir' returns only directory listings
+  - 'all' returns {dirs:[], files:[]}
+  - 'combine' returns []
 - **callback** - 
 - **options**
-    - **sync**=false - results are returned inline and no callbacks are used
-    - **shortName**=false||'relative' - instead of fullpath file names, just get the names or relative item names
-    - **recursive**=true - traverse through all children of given path
-    - **excludeHidden** - hidden files will be ignored (files starting with a dot are ignored)
+  - **sync**=false - results are returned inline and no callbacks are used
+  - **shortName**=false||'relative' - instead of fullpath file names, just get the names or relative item names
+  - **recursive**=true - traverse through all children of given path
+  - **excludeHidden** - hidden files will be ignored (files starting with a dot are ignored)
+  - **valuetizer** - A function of (stat, fileShortName, fileFullPath) . When null returned, item is skipped in end results
 
 ### promiseFiles API
 
@@ -283,6 +310,7 @@ promiseFiles(dir, type||options, options)
     - **sync**=false - DO NOT USE for promiseFiles, will cause unexpected behavior
     - **shortName**=false||'relative' - instead of fullpath file names, just get the names or relative item names
     - **recursive**=true - traverse through all children of given path
+    - **valuetizer** - A function of (stat, fileShortName, fileFullPath) . When null returned, item is skipped in end results
 
 ## History
 path-reader is a fork of node-dir. The original maintainer of node-dir, @fshost, has not updated nor been heard from in some time. Use path-reader, it is far superior to node-dir.

lib/paths.js

@@ -93,6 +93,13 @@ exports.files = function files(dir, type, callback, options) {
       var isDir = stat && stat.isDirectory() && stat.mode !== 17115
       var pushVal = statHanOptions.valuetizer(stat, name, statPath, isDir)//options.shortName ? name : statPath
 
+      if( pushVal==null ){
+        if (!--pending){
+          done();
+        }
+        return
+      }
+
       if (isDir) {
         if (type !== 'file') {
           results.dirs.push(pushVal);
@@ -161,6 +168,13 @@ exports.files = function files(dir, type, callback, options) {
       return list
     }
 
+    var statHanOptions = {}
+    if( options.valuetizer ){
+      statHanOptions.valuetizer = options.valuetizer
+    }else{
+      statHanOptions.valuetizer = getValuetizerByOptions(options, dir)
+    }
+/*
     var statHanOptions = {}
     if(options.shortName){
       if(options.shortName=='relative'){
@@ -183,7 +197,7 @@ exports.files = function files(dir, type, callback, options) {
         return longPath
       }
     }
-    
+*/
     for (var file, i = 0, l = list.length; i < l; i++) {
       var fname = list[i].toString();
       file = path.join(dir, fname);
@@ -295,4 +309,28 @@ exports.subdirs = function subdirs(dir, callback, type, options) {
 function assign(c0, c1){
   for(var x in c1)c0[x] = c1[x]
   return c0
-}
+}
+
+function getValuetizerByOptions(options, dir){
+  if(options.shortName){
+    if( options.shortName=='relative' ){
+      var dirBase = (options.basePath||dir)
+      var startPos = dirBase.length
+      if(dirBase.substring(dirBase.length-path.sep.length, dirBase.length)!=path.sep){
+        startPos = startPos + path.sep.length
+      }
+
+      return function(stat, shortName, longPath, isDir){
+        return longPath.substring(startPos, longPath.length)
+      }
+    }else{
+      return function(stat, shortName, longPath){
+        return shortName
+      }
+    }
+  }
+
+  return function(stat, shortName, longPath){
+    return longPath
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-reader",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "asynchronous file and directory operations for Node.js",
   "main": "index",
   "homepage": "https://github.com/ackerapple",

test/test.js

@@ -1362,27 +1362,42 @@ describe('paths method', function() {
     });
   });
 
-  describe('when called with combine argument set to true', function() {
-
+  describe('when called with combine argument set to true', function(){
     it('should pass an array of filepaths of all subdirs and files in a directory and its subdirs to a callback', function(done) {
       dir.paths(tdir, true, function(err, paths) {
-        should.not.exist(err);
+        should.not.exist(err)
 
         paths.should.be.a.array;
         var relPaths = paths.map(function(curPath) {
           return path.relative(fixturesDir, curPath);
-        });
+        })
+
         relPaths.sort().should.eql([
           'testdir'+path.sep+'file1.txt',
           'testdir'+path.sep+'file2.text',
           'testdir'+path.sep+'subdir',
           'testdir'+path.sep+'subdir'+path.sep+'file3.txt',
           'testdir'+path.sep+'subdir'+path.sep+'file4.text'
-        ]);
-      });
-      done();
-    });
-
-  });
+        ])
+      })
+      done()
+    })
+  })
+
+  describe('valuetizer',function(){
+    it('files by mtime', function(done) {
+      var foundMtime = false
+      var options = {
+        valuetizer:function(stat, shortName, longPath){
+          return stat.mtime && !foundMtime ? foundMtime=true && stat : null
+        }
+      }
 
+      dir.promiseFiles(tdir, 'file', options)
+      .then(function(results){
+        assert.equal(results.length, 1)
+      })
+      .then(done).catch(done)
+    })
+  })
 });