@util.js/node-files 0.41.4 → 0.41.6

package/lib/Files.js

@@ -92,8 +92,22 @@ module.exports = class Files {
     return path().dirname(...arguments);
   }
 
-  exists() {
-    return promises().applyCallback(fs(), fs().exists, arguments);
+  exists(path, callback) {
+    if (callback) {
+      return fs().exists(path, callback);
+    }
+    return new Promise((resolve, reject) => {
+      // From https://nodejs.org/api/fs.html#fsexistspath-callback:
+      // The parameters for this callback are not consistent with other Node.js callbacks.
+      // Normally, the first parameter to a Node.js callback is an err parameter, optionally 
+      // followed by other parameters. The fs.exists() callback has only one boolean 
+      // parameter. 
+      try {
+        fs().exists(path, resolve);
+      } catch (err) {
+        reject(err);
+      }
+    });
   }
 
   existsSync() {
@@ -135,17 +149,17 @@ module.exports = class Files {
     return (async function () {
       if (!objects().isDefined(params))
         throw new TypeError(
-          `We expected params to be defined, but it was ${params}.`
+          `We expected params to be defined, but it was ${params}.`,
         );
       const { dir, ext } = params;
 
       if (!objects().isDefined(dir))
         throw new TypeError(
-          `We expected params.dir to be defined, but it was ${dir}.`
+          `We expected params.dir to be defined, but it was ${dir}.`,
         );
       if (!objects().isDefined(ext))
         throw new TypeError(
-          `We expected params.ext to be defined, but it was ${ext}.`
+          `We expected params.ext to be defined, but it was ${ext}.`,
         );
 
       const files = await thiz.readdir(dir);
@@ -167,18 +181,18 @@ module.exports = class Files {
   filesWithExtensionSync(params) {
     if (!objects().isDefined(params))
       throw new TypeError(
-        `We expected params to be defined, but it was ${params}.`
+        `We expected params to be defined, but it was ${params}.`,
       );
 
     const { dir, ext } = params;
 
     if (!objects().isDefined(dir))
       throw new TypeError(
-        `We expected params.dir to be defined, but it was ${dir}.`
+        `We expected params.dir to be defined, but it was ${dir}.`,
       );
     if (!objects().isDefined(ext))
       throw new TypeError(
-        `We expected params.ext to be defined, but it was ${ext}.`
+        `We expected params.ext to be defined, but it was ${ext}.`,
       );
 
     const files = this.readdirSync(dir);

package/package.json

@@ -1,16 +1,16 @@
 {
   "author": "Chris Topher <c@creemama.com>",
   "dependencies": {
-    "@util.js/objects": "0.41.4",
-    "@util.js/promises": "0.41.4",
-    "@util.js/strings": "0.41.4",
+    "@util.js/objects": "0.41.6",
+    "@util.js/promises": "0.41.6",
+    "@util.js/strings": "0.41.6",
     "graceful-fs": "4.2.11",
-    "mkdirp": "3.0.0",
+    "mkdirp": "3.0.1",
     "ncp": "2.0.0",
-    "read-last-lines": "1.8.0",
-    "rimraf": "5.0.0",
-    "sanitize-filename": "1.6.3",
-    "touch": "3.1.0"
+    "read-last-lines": "1.10.0",
+    "rimraf": "6.1.3",
+    "sanitize-filename": "1.6.4",
+    "touch": "3.1.1"
   },
   "description": "JavaScript Node.js utility methods for files",
   "devDependencies": {
@@ -38,6 +38,5 @@
     "type": "git",
     "url": "https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-files"
   },
-  "version": "0.41.4",
-  "gitHead": "2119863a175cf7095ca3a2417e61af32974add15"
+  "version": "0.41.6"
 }

package/test/FilesTest.js

@@ -45,7 +45,7 @@ describe("Files", function () {
         lines = await files.readLastLines(
           new URL("file://" + __filename),
           3,
-          "utf8"
+          "utf8",
         );
         expect(lines).to.eql("    });\n  });\n});\n");
       }
@@ -53,14 +53,14 @@ describe("Files", function () {
       lines = await files.readLastLines(
         Buffer.from(__filename, "utf8"),
         3,
-        "utf8"
+        "utf8",
       );
       expect(lines).to.eql("    });\n  });\n});\n");
 
       lines = await files.readLastLines(
         Buffer.from(__filename, "utf8"),
         3,
-        Buffer.from("utf8", "utf8")
+        Buffer.from("utf8", "utf8"),
       );
       expect(lines).to.eql("    });\n  });\n});\n");
     });
@@ -159,7 +159,7 @@ describe("Files", function () {
           .readLastLines(new URL("http://www.google.com"), 3)
           .then((lines) => assert.fail())
           .catch((error) =>
-            expect(error.message).to.eql("The URL must be of scheme file")
+            expect(error.message).to.eql("The URL must be of scheme file"),
           );
 
       // The method fails if path is a directory.
@@ -168,8 +168,8 @@ describe("Files", function () {
         .then((lines) => assert.fail())
         .catch((error) =>
           expect(error.message).to.eql(
-            "EISDIR: illegal operation on a directory, read"
-          )
+            "EISDIR: illegal operation on a directory, read",
+          ),
         );
 
       // The method fails if path is one of the primitive types other than string.
@@ -198,7 +198,7 @@ describe("Files", function () {
       files.readLastLines(__dirname, 3, (error, lines) => {
         try {
           expect(error.message).to.eql(
-            "EISDIR: illegal operation on a directory, read"
+            "EISDIR: illegal operation on a directory, read",
           );
           callback();
         } catch (e) {
@@ -212,8 +212,8 @@ describe("Files", function () {
         .then((lines) => assert.fail())
         .catch((error) =>
           expect(error.message).to.eql(
-            "Cannot convert a Symbol value to a number"
-          )
+            "Cannot convert a Symbol value to a number",
+          ),
         );
     });
     it("should fail if the encoding is invalid", async function () {
@@ -221,14 +221,14 @@ describe("Files", function () {
         .readLastLines(__filename, 3, false)
         .then((lines) => assert.fail())
         .catch((error) =>
-          expect(error.message).to.eql("Unknown encoding: false")
+          expect(error.message).to.eql("Unknown encoding: false"),
         );
 
       await files
         .readLastLines(__filename, 3, NaN)
         .then((lines) => assert.fail())
         .catch((error) =>
-          expect(error.message).to.eql("Unknown encoding: NaN")
+          expect(error.message).to.eql("Unknown encoding: NaN"),
         );
 
       await files
@@ -245,7 +245,7 @@ describe("Files", function () {
         .readLastLines(__filename, 3, "frog")
         .then((lines) => assert.fail())
         .catch((error) =>
-          expect(error.message).to.eql("Unknown encoding: frog")
+          expect(error.message).to.eql("Unknown encoding: frog"),
         );
 
       await files
@@ -253,8 +253,8 @@ describe("Files", function () {
         .then((lines) => assert.fail())
         .catch((error) =>
           expect(error.message).to.eql(
-            "Cannot convert a Symbol value to a string"
-          )
+            "Cannot convert a Symbol value to a string",
+          ),
         );
     });
   });
@@ -469,7 +469,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should return [] if dir is empty", (done) => {
@@ -486,7 +486,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should have a forward slash separating directory and filename in returned filenames if dir does not contain a slash at the end", async function () {
@@ -520,7 +520,7 @@ describe("Files", function () {
             } catch (err) {
               done(err);
             }
-          }
+          },
         );
       });
     });
@@ -586,13 +586,13 @@ describe("Files", function () {
     });
     it("should return [] if dir is empty", function () {
       expect(
-        files.filesWithExtensionSync({ dir: emptyDir, ext: "json" })
+        files.filesWithExtensionSync({ dir: emptyDir, ext: "json" }),
       ).to.have.members([]);
     });
     it("should have a forward slash separating directory and filename in returned filenames if dir does not contain a slash at the end", function () {
       return prepareDirWithJsonFiles().then(() => {
         expect(
-          files.filesWithExtensionSync({ dir: jsonDir, ext: "json" })
+          files.filesWithExtensionSync({ dir: jsonDir, ext: "json" }),
         ).to.have.members([
           jsonDir + "/package.json",
           jsonDir + "/server.json",
@@ -603,7 +603,7 @@ describe("Files", function () {
     it("should not have two forward slashes in returned filenames if dir contains a slash at the end", function () {
       return prepareDirWithJsonFiles().then(() => {
         expect(
-          files.filesWithExtensionSync({ dir: jsonDir, ext: "json" })
+          files.filesWithExtensionSync({ dir: jsonDir, ext: "json" }),
         ).to.have.members([
           jsonDir + "/package.json",
           jsonDir + "/server.json",
@@ -614,14 +614,14 @@ describe("Files", function () {
     it("should return [] if there are files in dir matching ext but ext starts with a period", function () {
       return prepareDirWithJsonFiles().then(() => {
         expect(
-          files.filesWithExtensionSync({ dir: jsonDir, ext: ".json" })
+          files.filesWithExtensionSync({ dir: jsonDir, ext: ".json" }),
         ).to.have.members([]);
       });
     });
     it("should return [] if ext is empty", function () {
       return prepareDirWithJsonFiles().then(() => {
         expect(
-          files.filesWithExtensionSync({ dir: jsonDir, ext: "" })
+          files.filesWithExtensionSync({ dir: jsonDir, ext: "" }),
         ).to.have.members([]);
       });
     });
@@ -654,7 +654,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should error for UnlikelyToExist.js", async function () {
@@ -808,7 +808,7 @@ describe("Files", function () {
             cb(null);
           },
         ],
-        done
+        done,
       );
     });
   });
@@ -839,7 +839,7 @@ describe("Files", function () {
             cb();
           },
         ],
-        done
+        done,
       );
     });
   });
@@ -902,7 +902,7 @@ describe("Files", function () {
           },
           files.writeFile,
         ],
-        done
+        done,
       );
     });
 
@@ -921,7 +921,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should successfully read three files when called with option 'utf8'", (done) => {
@@ -936,13 +936,13 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should successfully read three files when called with options", async function () {
       const string = await files.readFiles(
         [targetDir + "/c.txt", targetDir + "/a.txt", targetDir + "/c.txt"],
-        { encoding: "utf8", flag: "r" }
+        { encoding: "utf8", flag: "r" },
       );
       expect(string).to.equal("cac");
     });
@@ -958,7 +958,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
     it("should return a Promise if callback is null", async function () {
@@ -1019,7 +1019,7 @@ describe("Files", function () {
           } catch (err) {
             done(err);
           }
-        }
+        },
       );
     });
   });
@@ -1051,7 +1051,7 @@ describe("Files", function () {
           },
           files.mkdirp,
         ],
-        done
+        done,
       );
     });
 
@@ -1090,7 +1090,7 @@ describe("Files", function () {
           },
           files.isFile.bind(files),
         ],
-        done
+        done,
       );
     });
     it("should throw TypeError when filename is null", async function () {

package/test/Files_exists_Test.js

@@ -0,0 +1,31 @@
+"use strict";
+
+const { expect } = require("chai");
+const files = require("..");
+
+describe("Files#exists", () => {
+  const targetDir = files.join(__dirname, "..", "target");
+  files.mkdirpSync(targetDir);
+
+  it("should return true for an existing file via a callback", (done) => {
+    files.exists(targetDir, (exists) => {
+      expect(exists).to.be.true;
+      done();
+    });
+  });
+
+  it("should return true for an existing file via a Promise", async () => {
+    expect(await files.exists(targetDir)).to.be.true;
+  });
+
+  it("should return false for a nonexistent file via a callback", (done) => {
+    files.exists(targetDir + "-nonexistent", (exists) => {
+      expect(exists).to.be.false;
+      done();
+    });
+  });
+
+  it("should return false for an nonexistent file via a Promise", async () => {
+    expect(await files.exists(targetDir + "-nonexistent")).to.be.false;
+  });
+});

package/test/Files_sanitizeFilename_Test.js

@@ -18,7 +18,7 @@ describe("Files#sanitizeFilename", () => {
   });
   it("should throw an error if the filename is not a string", () => {
     expect(() =>
-      files.sanitizeFilename(["~/.\u0000ssh/authorized_keys"])
+      files.sanitizeFilename(["~/.\u0000ssh/authorized_keys"]),
     ).to.throw(Error);
   });
 });