recently-modified-files 0.1.0 → 0.1.2

package/README.md

@@ -5,7 +5,7 @@
 [![Codecov Status][codecov-image]][codecov-url]
 [![Standard][standard-image]][standard-url]
 
-> Gets a list of recently modified files
+> Gets a list of recently modified files in a dir
 
 ## Install
 
@@ -19,25 +19,35 @@ npm install --save recently-modified-files
 import rmf from 'recently-modified-files'
 ```
 
-### `rmf(path, fn)`
+### `rmf(dir, fn)`
 
 **params**
 
-- `path` {string} The path to test for files
+- `dir` {string} The dir to test for files
 - `fn` {Function} Callback, the arguments are
   - `err` {Error} Possible exception or null
   - `files` {Array} An array with the names of the files where the first one is the most recently modified file or an empty array when there are no files
 
-### `const filenames = rmf.sync(path)`
+### `const filenames = rmf.sync(dir)`
 
 **params**
 
-- `path` {string} The path to test for files
+- `dir` {string} The path to test for files
 
 **return**
 
 An array of strings with the filenames on `path` in descending order with respect to the modified time
 
+### `rmf.promise(dir)`
+
+**params**
+
+- `dir` {string} The path to test for files
+
+**return**
+
+A native promise, note that it's required that `global.Promise` is defined
+
 **NOTE: the test to check if a file is a file is by calling `stat.isFile()` which means that folders/symlinks are ignored** 
 
 ## License

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "recently-modified-files",
-  "version": "0.1.0",
-  "description": "Gets the most recent modified file on a given path",
+  "version": "0.1.2",
+  "description": "Gets the most recent modified file on a dir",
   "license": "MIT",
-  "author": {
-    "name": "Mauricio Poppe",
-    "email": "mauricio.poppe@gmail.com",
-    "url": "http://maurizzzio.com"
-  },
+  "author": "Mauricio Poppe (https://mauriciopoppe.com)",
   "main": "dist/index.js",
   "jsnext:main": "src/index.js",
   "keywords": [
@@ -15,14 +11,10 @@
     "file",
     "recently modified"
   ],
-  "repository": "maurizzzio/recently-modified-files",
+  "repository": "mauriciopoppe/recently-modified-files",
   "scripts": {
-    "clean": "rimraf dist/ && mkdirp dist/",
-    "lint": "standard",
-    "prebuild": "npm run clean -s && npm run lint -s",
     "build": "babel src/index.js --out-file dist/index.js",
     "build:watch": "npm run build -- --watch",
-    "preversion": "npm run build",
     "test": "ava",
     "test:watch": "npm test -- --watch",
     "coverage": "nyc npm test && nyc report --reporter=text-lcov > coverage.lcov && codecov"

package/src/index.js

@@ -13,7 +13,7 @@ function fmr (stats, files) {
   return onlyFiles.map(stat => stat.filename)
 }
 
-export default (dir, cb) => {
+export default function asynch (dir, cb) {
   stat(dir, (err, stats, files) => {
     if (err) return cb(err)
     return cb(null, fmr(stats, files))
@@ -25,3 +25,12 @@ export function sync (dir) {
   var stats = files.map(file => fs.statSync(path.join(dir, file)))
   return fmr(stats, files)
 }
+
+export function promise (dir) {
+  return new Promise((resolve, reject) => {
+    asynch(dir, (err, files) => {
+      if (err) reject(err)
+      else resolve(files)
+    })
+  })
+}

package/dist/index.js

@@ -1,50 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.sync = sync;
-
-var _fs = require('fs');
-
-var _fs2 = _interopRequireDefault(_fs);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
-
-var _folderStat = require('folder-stat');
-
-var _folderStat2 = _interopRequireDefault(_folderStat);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function fmr(stats, files) {
-  var onlyFiles = stats.map(function (stat, i) {
-    stat.filename = files[i];
-    return stat;
-  }).filter(function (stat) {
-    return stat.isFile();
-  });
-  onlyFiles.sort(function (a, b) {
-    return b.mtime - a.mtime;
-  });
-  return onlyFiles.map(function (stat) {
-    return stat.filename;
-  });
-}
-
-exports.default = function (dir, cb) {
-  (0, _folderStat2.default)(dir, function (err, stats, files) {
-    if (err) return cb(err);
-    return cb(null, fmr(stats, files));
-  });
-};
-
-function sync(dir) {
-  var files = _fs2.default.readdirSync(dir);
-  var stats = files.map(function (file) {
-    return _fs2.default.statSync(_path2.default.join(dir, file));
-  });
-  return fmr(stats, files);
-}