file-stat - npm Package Compare versions

Comparing version 0.1.3 to 0.2.0

index.js

@@ -6,4 +6,4 @@ 'use strict';
 module.exports = function fileStats() {
-  return utils.through.obj(function (file, enc, cb) {
-    getStats(file, function (err, res) {
+  return utils.through.obj(function(file, enc, cb) {
+    lstat(file, function(err, res) {
       if (err) {
@@ -18,4 +18,21 @@ cb(err);
 
-function getStats(file, cb) {
-  utils.fs.lstat(file.path, function (err, stat) {
+/**
+ * Asynchronously add a `stat` property from `fs.stat` to the given file object.
+ *
+ * ```js
+ * var File = require('vinyl');
+ * var stats = require('{%= name %}');
+ * stats.stat(new File({path: 'README.md'}), function(err, file) {
+ *   console.log(file.stat.isFile());
+ *   //=> true
+ * });
+ * ```
+ * @name .stat
+ * @param {Object} `file` File object
+ * @param {Function} `cb`
+ * @api public
+ */
+
+function stat(file, cb) {
+  utils.fs.stat(file.path, function(err, stat) {
     if (err) {
@@ -31,5 +48,95 @@ cb(err);
 /**
- * Expose `getStats`
+ * Asynchronously add a `lstat` property from `fs.lstat` to the given file object.
+ *
+ * ```js
+ * var File = require('vinyl');
+ * var stats = require('{%= name %}');
+ * stats.lstat(new File({path: 'README.md'}), function(err, file) {
+ *   console.log(file.lstat.isFile());
+ *   //=> true
+ * });
+ * ```
+ * @name .lstat
+ * @param {Object} `file` File object
+ * @param {Function} `cb`
+ * @api public
  */
 
-module.exports.getStats = getStats;
+function lstat(file, cb) {
+  utils.fs.lstat(file.path, function(err, stat) {
+    if (err) {
+      cb(err);
+      return;
+    }
+    file.stat = stat;
+    cb(null, file);
+  });
+}
+
+/**
+ * Synchronously add a `stat` property from `fs.stat` to the given file object.
+ *
+ * ```js
+ * var File = require('vinyl');
+ * var stats = require('{%= name %}');
+ * var file = new File({path: 'README.md'});
+ * stats.statSync(file);
+ * console.log(file.stat.isFile());
+ * //=> true
+ * ```
+ * @name .statSync
+ * @param {Object} `file` File object
+ * @param {Function} `cb`
+ * @api public
+ */
+
+function statSync(file) {
+  var stat;
+  Object.defineProperty(file, 'stat', {
+    configurable: true,
+    set: function(val) {
+      stat = val;
+    },
+    get: function() {
+      return stat || (stat = utils.fs.statSync(this.path));
+    }
+  });
+}
+
+/**
+ * Synchronously add a `lstat` property from `fs.lstat` to the given file object.
+ *
+ * ```js
+ * var File = require('vinyl');
+ * var stats = require('{%= name %}');
+ * var file = new File({path: 'README.md'});
+ * stats.statSync(file);
+ * console.log(file.lstat.isFile());
+ * //=> true
+ * ```
+ * @name .lstatSync
+ * @param {Object} `file` File object
+ * @param {Function} `cb`
+ * @api public
+ */
+
+function lstatSync(file) {
+  var lstat;
+  Object.defineProperty(file, 'lstat', {
+    configurable: true,
+    set: function(val) {
+      lstat = val;
+    },
+    get: function() {
+      return lstat || (lstat = utils.fs.lstatSync(this.path));
+    }
+  });
+}
+
+/**
+ * Expose `stat`
+ */
+
+module.exports.stat = stat;
+module.exports.lstatSync = lstatSync;
+module.exports.statSync = statSync;

package.json

 {
   "name": "file-stat",
   "description": "Set the `stat` property on a file object. Abstraction from vinyl-fs to support stream or non-stream usage.",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "homepage": "https://github.com/jonschlinkert/file-stat",
@@ -24,13 +24,13 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "dependencies": {
-    "graceful-fs": "^4.1.2",
-    "lazy-cache": "^0.2.3",
-    "through2": "^2.0.0"
+    "graceful-fs": "^4.1.4",
+    "lazy-cache": "^2.0.1",
+    "through2": "^2.0.1"
   },
   "devDependencies": {
-    "gulp": "^3.9.0",
-    "gulp-istanbul": "^0.10.1",
-    "gulp-jshint": "^1.11.2",
-    "gulp-mocha": "^2.1.3",
-    "jshint-stylish": "^2.0.1",
-    "mocha": "*"
+    "gulp": "^3.9.1",
+    "gulp-eslint": "^2.0.0",
+    "gulp-format-md": "^0.1.9",
+    "gulp-istanbul": "^1.0.0",
+    "gulp-mocha": "^2.2.0",
+    "mocha": "^2.5.3"
   },
@@ -58,4 +58,20 @@ "keywords": [
       ]
-    }
+    },
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
+    },
+    "reflinks": [
+      "vinyl-fs",
+      "verb-readme-generator",
+      "verb"
+    ]
   }
 }

utils.js

 'use strict';
 
 var utils = require('lazy-cache')(require);
-
-/**
- * Temporarily re-assign `require` so we can fool browserify
- * into recognizing lazy deps.
- */
-
 var fn = require;
@@ -15,3 +9,2 @@ require = utils;
  * Lazily required module dependencies
- * (here, `require` is actually lazy-cache)
  */
@@ -18,0 +11,0 @@

New alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Lines of code

144

increased by193.88%

Worsened metrics

Total package byte prevSize

5739

decreased by-3.8%

Number of package files

4

decreased by-20%

Number of medium quality alerts

1

increased byInfinity%

Number of lines in readme file

0

decreased by-100%

Dependency changes

• + Addedis-buffer@1.1.6(transitive)

• + Addedkind-of@3.2.2(transitive)

• + Addedlazy-cache@2.0.2(transitive)

• + Addedset-getter@0.1.1(transitive)

• + Addedto-object-path@0.3.0(transitive)

• - Removedlazy-cache@0.2.7(transitive)

• Updatedgraceful-fs@^4.1.4

• Updatedlazy-cache@^2.0.1

• Updatedthrough2@^2.0.1