ESLint fixes

Author: JamesMessinger

package-lock.json

@@ -52,7 +52,7 @@
     "node": ">=10"
   },
   "devDependencies": {
-    "@jsdevtools/eslint-config": "^1.0.3",
+    "@jsdevtools/eslint-config": "^1.0.4",
     "@jsdevtools/version-bump-prompt": "^6.0.5",
     "@types/chai": "^4.2.11",
     "@types/mocha": "^8.0.0",

package.json

@@ -1,4 +1,3 @@
-// tslint:disable: promise-function-async
 import * as fs from "fs";
 import { DirectoryReader } from "../directory-reader";
 import { Callback, Options, Stats } from "../types-public";

src/async/index.ts

@@ -4,7 +4,7 @@ import { Callback } from "./types-public";
  * A function that accepts an input value and returns an output value via a callback.
  * @internal
  */
-export type Fn<I, O> = (input: I, callback: Callback<O>) => void;
+export type Fn<TInput, TOutput> = (input: TInput, callback: Callback<TOutput>) => void;
 
 
 /**
@@ -16,15 +16,15 @@ export type Fn<I, O> = (input: I, callback: Callback<O>) => void;
  *
  * @internal
  */
-export function safeCall<I, O>(fn: Fn<I, O>, input: I, callback: Callback<O>): void {
+export function safeCall<TInput, TOutput>(fn: Fn<TInput, TOutput>, input: TInput, callback: Callback<TOutput>): void {
   // Replace the callback function with a wrapper that ensures it will only be called once
   callback = callOnce(callback);
 
   try {
-    fn.call(undefined, input, callback);
+    fn(input, callback);
   }
   catch (err) {
-    callback(err as Error, undefined as unknown as O);
+    callback(err as Error, undefined as unknown as TOutput);
   }
 }
 

src/call.ts

@@ -140,7 +140,7 @@ export class DirectoryReader {
     this.pending === 0 &&             // The stuff we're currently reading
     this.queue.length === 0) {        // The stuff we haven't read yet
       // There's no more stuff!
-      this.stream.push(null);         // tslint:disable-line: no-null-keyword
+      this.stream.push(null);
     }
   }
 
@@ -295,7 +295,7 @@ export class DirectoryReader {
     else if (recurseFn) {
       try {
         // Run the user-specified recursion criteria
-        return !!recurseFn.call(undefined, stats);
+        return !!recurseFn(stats);
       }
       catch (err) {
         // An error occurred in the user's code.
@@ -323,7 +323,7 @@ export class DirectoryReader {
     if (filterFn) {
       try {
         // Run the user-specified filter function
-        return !!filterFn.call(undefined, stats);
+        return !!filterFn(stats);
       }
       catch (err) {
         // An error occurred in the user's code.

src/directory-reader.ts

@@ -1,4 +1,3 @@
-// tslint:disable: no-default-export no-unsafe-any
 import { readdirAsync } from "./async";
 import { readdirIterator } from "./iterator";
 import { readdirStream } from "./stream";
@@ -20,15 +19,16 @@ readdir.async = readdirAsync;
 readdir.stream = readdirStream;
 readdir.iterator = readdirIterator;
 
-export { readdir };
-export default readdir;
-export * from "./types-public";
-export { readdirSync } from "./sync";
 export { readdirAsync } from "./async";
 export { readdirIterator } from "./iterator";
 export { readdirStream } from "./stream";
+export { readdirSync } from "./sync";
+export * from "./types-public";
+export { readdir };
+export default readdir;
 
 // CommonJS default export hack
+/* eslint-env commonjs */
 if (typeof module === "object" && typeof module.exports === "object") {
   module.exports = Object.assign(module.exports.default, module.exports);
 }

src/index.ts

@@ -52,12 +52,11 @@ export function readdirIterator<T>(dir: string, options?: Options): AsyncIterabl
       return this;
     },
 
-    // tslint:disable-next-line: promise-function-async
     next() {
       let pendingRead = pending<IteratorResult<T>>();
       pendingReads.push(pendingRead);
 
-      // tslint:disable-next-line: no-floating-promises
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       Promise.resolve().then(fulfillPendingReads);
 
       return pendingRead.promise;

src/iterator/index.ts

@@ -13,7 +13,7 @@ export function pending<T>(): Pending<T> {
   return {
     promise,
     resolve(result) {
-      // tslint:disable-next-line: no-floating-promises
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       Promise.resolve(result).then(resolve);
     },
     reject(reason: Error) {

src/iterator/pending.ts

@@ -29,7 +29,6 @@ export interface NormalizedOptions {
  *
  * @internal
  */
-// tslint:disable-next-line: cyclomatic-complexity
 export function normalizeOptions(options: Options | undefined, facade: Facade, emit: boolean): NormalizedOptions {
   if (options === null || options === undefined) {
     options = {};

src/normalize-options.ts

@@ -13,7 +13,7 @@ describe("options.basePath", () => {
       it: 'should return relative paths if basePath === "" (empty string)',
       args: ["test/dir", { basePath: "" }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -28,7 +28,7 @@ describe("options.basePath", () => {
       it: 'should return relative paths if basePath === "."',
       args: ["test/dir", { basePath: "." }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         assertPathsMatch(data, dir.shallow.data, ".");
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -43,7 +43,7 @@ describe("options.basePath", () => {
       it: "should return absolute paths if basePath === absolute path",
       args: ["test/dir", { basePath: testDirAbsPath }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         assertPathsMatch(data, dir.shallow.data, testDirAbsPath);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -58,7 +58,7 @@ describe("options.basePath", () => {
       it: "should return relative paths to process.cwd() if basePath === path",
       args: ["test/dir", { basePath: "test/dir" }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         assertPathsMatch(data, dir.shallow.data, "test/dir");
       },
       streamAssert (errors, data, files, dirs, symlinks) {

test/specs/basePath.spec.js

@@ -11,7 +11,7 @@ describe("options.deep", () => {
       it: "should return all deep contents",
       args: ["test/dir", { deep: true }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.deep.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -26,7 +26,7 @@ describe("options.deep", () => {
       it: "should only return top-level contents if deep === false",
       args: ["test/dir", { deep: false }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -41,7 +41,7 @@ describe("options.deep", () => {
       it: "should only return top-level contents if deep === 0",
       args: ["test/dir", { deep: 0 }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -56,7 +56,7 @@ describe("options.deep", () => {
       it: "should return 1-level deep contents",
       args: ["test/dir", { deep: 1 }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.deep.oneLevel.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -71,7 +71,7 @@ describe("options.deep", () => {
       it: "should return all deep contents if deep is a number greater than the number of dirs",
       args: ["test/dir", { deep: 25 }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.deep.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -86,7 +86,7 @@ describe("options.deep", () => {
       it: "should return all deep contents if deep === Infinity",
       args: ["test/dir", { deep: Infinity }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.deep.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -103,7 +103,7 @@ describe("options.deep", () => {
         deep: /^((?!\-symlink).)*$/,
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(this.omitSymlinkDirs(dir.deep.data));
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -127,7 +127,7 @@ describe("options.deep", () => {
         deep: "subdir",
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(this.shallowPlusSubdir("data"));
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -155,7 +155,7 @@ describe("options.deep", () => {
         },
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(this.omitSubdir(dir.deep.data));
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -181,7 +181,7 @@ describe("options.deep", () => {
         },
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(this.omitSubdir(dir.deep.data));
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -207,7 +207,7 @@ describe("options.deep", () => {
         },
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.deep.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -226,7 +226,7 @@ describe("options.deep", () => {
         },
       }],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -251,7 +251,7 @@ describe("options.deep", () => {
         // The sync & async APIs abort after the first error and don't return any data
         expect(error).to.be.an.instanceOf(Error);
         expect(error.message).to.equal("Boooooom!");
-        expect(data).to.be.undefined;
+        expect(data).to.equal(undefined);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
         // The streaming API emits errors and data separately

test/specs/deep.spec.js

@@ -13,15 +13,15 @@ describe("default behavior", () => {
       args: ["test/dir"],
       assert (error, data) {
         let fsResults = fs.readdirSync("test/dir");
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(fsResults);
       },
     },
     {
       it: "should return an empty array for an empty dir",
       args: ["test/dir/empty"],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.be.an("array").with.lengthOf(0);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -36,7 +36,7 @@ describe("default behavior", () => {
       it: "should return all top-level contents",
       args: ["test/dir"],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -51,7 +51,7 @@ describe("default behavior", () => {
       it: "should return the same results if the path is absolute",
       args: [path.resolve("test/dir")],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -66,7 +66,7 @@ describe("default behavior", () => {
       it: "should return all top-level contents of a directory symlink",
       args: ["test/dir/subdir-symlink"],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         expect(data).to.have.same.members(dir.subdir.shallow.data);
       },
       streamAssert (errors, data, files, dirs, symlinks) {
@@ -81,7 +81,7 @@ describe("default behavior", () => {
       it: "should return relative paths",
       args: ["test/dir"],
       assert (error, data) {
-        expect(error).to.be.null;
+        expect(error).to.equal(null);
         for (let item of data) {
           expect(item).not.to.contain("/");
           expect(item).not.to.contain("\\");